7. Disabling a recurring contract
You can disable a single recurringDetail or the whole recurring contract for a shopper.
7.1. Disable request
Disabling a recurring contract (detail) can be done by calling the disable action on the Recurring service.
The request has the following fields:
• merchantAccount
Your merchant account.
• shopperReference
The ID that uniquely identifies the shopper. This shopperReference must be the same as the shopperReference used in the
initial payment.
• recurringDetailReference (optional)
The recurringDetailReference of the detail you wish to disable. If you do not supply this field all details for the shopper will be
disabled including the contract. This means that you cannot add new details.
7.2. Disable response
The response will be a result object with a single field response. If a single detail was disabled the value of this field will be [detail-
successfully-disabled] or, if all the details were disabled, the value is [all-details-successfully-disabled].
Please refer to Appendix G for a SOAP example of a disable a recurring contract request and response.
Please refer to Appendix H for a REST example of a disable a recurring contract request and response.
