POST /scheduleAccountUpdater

When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:

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
shopperReference String No

The reference of the shopper that owns the recurring contract.

Optional if card is provided.

card Object No

Credit card data.

Optional if shopperReference and selectedRecurringDetailReference are provided.

card.issueNumber String No

The issue number of the card (for some UK debit cards only).

card.startYear String No

The year component of the start date (for some UK debit cards only).

card.cvc String No

The card verification code (1-20 characters). Depending on the card brand, it is known also as:

  • CVV2/CVC2 – length: 3 digits
  • CID – length: 4 digits

If you are using Client-Side Encryption, the CVC code is present in the encrypted data. You must never post the card details to the server. This field must be always present in a one-click payment request. When this value is returned in a response, it is always empty because it is not stored.

card.number String No

The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.

card.expiryMonth String No

The card expiry month. Format: 2 digits, zero-padded for single digits. For example:

  • 03 = March
  • 11 = November
card.startMonth String No

The month component of the start date (for some UK debit cards only).

card.holderName String No

The name of the cardholder, as printed on the card.

card.expiryYear String No

The card expiry year. Format: 4 digits. For example: 2020

merchantAccount String Yes

Account of the merchant.

reference String Yes

A reference that merchants can apply for the call.

additionalData Object No

This field contains additional data, which may be required for a particular request.

selectedRecurringDetailReference String No

The selected detail recurring reference.

Optional if card is provided.

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.