PDF Export

EPayment.performCancel

  • Object: /net/dsb/commons/EPayment
  • Method: performCancel
  • Version: 1.0.0

This service cancels a transaction.

Parameter

Name Type / Length Mandatory / Optional Description
cancel-requestXML m XML element with the data.
Request
Structure
<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
    <service-object>/net/dsb/commons/EPayment</service-object>
    <service-method>performCancel</service-method>
    <service-version>1.0.0</service-version>
  </header>
  <body>
    <epayment-transaction>
      <cancel-request>
        <payment-provider>PAYPAL</payment-provider>
        <merchant-id></merchant-id>
        <merchant-transaction-id>myInvoiceID</merchant-transaction-id>
        <external-transaction-id></external-transaction-id>
        <merchant-request-id>lalala</merchant-request-id>
      </cancel-request>
    </epayment-transaction>
  </body>
</message>
Elements
Name MandatoryLengthTypeDescription
epayment-transaction X - XMLXML Element
cancel-request X - XML
payment-provider X 6 AN List of Payment Provider
merchant-id 13 AN merchant ID (mandatory, if there are multiple merchant ids with this client)
merchant-transaction-id 19 AN TransactionID of canceled transaction in the system of the merchant.
external-transaction-id 19 AN TransactionID of canceled transaction in the system of the payment provider.
merchant-request-id 128 AN request ID of the merchant (max. 30 chars if PayPal)
Response
Structure
<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <cancel-response>
      <payment-result></payment-result>
      <transaction-id >asdfasdfasdf</transaction-id>
      <payment-date></payment-date>
      <error>
        <error-code></error-code>
        <error-message></error-message>
      </error>
    </cancel-response>
  </body>
</message>
Elements
Name LengthTypeDescription
cancel-response - XMLXML Element
payment-result AN result text
transaction-id 19 AN id of the refund
payment-date D
error XMLin case of an error
error-code N Error code
error-message N Error message
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information