EPayment.cancelBillingAgreement

Object: /net/dsb/commons/EPayment
Method: cancelBillingAgreement
Version: 1.0.0

This service cancels a Billing Agreement. At the moment this can only be used with Paypal. A billing agreement must be cancelled when it is timed out or isn't valid any more for any reason.

Parameter

Name	Type / Length	Mandatory / Optional	Description
cancel-billing-agreement	XML	m	XML element with the data

Request

Structure

<message system="AVS/3" version="1.0">
  <header>
    <client>355</client>
    <avs3-service-provider>999</avs3-service-provider>
    <service-object>/net/dsb/commons/EPayment</service-object>
    <service-method>cancelBillingAgreement</service-method>
    <service-version>1.0.0</service-version>
  </header>
  <body>
    <epayment-transaction>
      <cancel-billing-agreement>
        <merchant-id>paypal-id.dsb.net</merchant-id>
        <merchant-transaction-id>myInvoiceID</merchant-transaction-id>
        <billing-agreement-id>BT2x2GU35881XDFR2424T</billing-agreement-id>
      </cancel-billing-agreement>
    </epayment-transaction>
  </body>
</message>

Elementdefinition

Element	Mandatory	Length	Type	Description
epayment-transaction	X	-	XML	XML Element
cancel-billing-agreement	X	-	XML	XML Element
merchant-id	X	-	AN	Id of the merchant
merchant-request-id	X	-	AN	Request ID in the merchant's system
billing-agreement-id	X	64	AN	Billing Agreement ID to cancel

Response

Structure

<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <cancel-billing-agreement-response>
      <status>OK</status>
    </cancel-billing-agreement-response>
  </body>
</message>

Definition

Element	Type	Description
cancel-billing-agreement-response	XML	XML Element
status	AN	Status of the Request. OK, if cancellation succeeded or error message.