POST /disable

Disables stored payment details to stop charging a shopper with this particular recurring detail ID.

For more information, refer to Disable stored details.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
contract String No

Specify the contract if you only want to disable a specific use.

This field can be set to one of the following values, or to their combination (comma-separated):

  • ONECLICK
  • RECURRING
  • PAYOUT
shopperReference String Yes

The ID that uniquely identifies the shopper.

This shopperReference must be the same as the shopperReference used in the initial payment.

recurringDetailReference String No

The ID that uniquely identifies the recurring detail reference.

If it is not provided, the whole recurring contract of the shopperReference will be disabled, which includes all recurring details.

merchantAccount String Yes

The merchant account identifier with which you want to process the transaction.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.