POST /listRecurringDetails

Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.

For more information, refer to Retrieve 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
shopperReference String Yes

The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

recurring Object No

A container for the type of a recurring contract to be retrieved.

The contract value needs to match the contract value submitted in the payment transaction used to create a recurring contract. However, if ONECLICK,RECURRING is the original contract definition in the initial payment, then contract should take either ONECLICK or RECURRING, depending on whether or not you want the shopper to enter their card's security code when they finalize their purchase.

recurring.contract String No

The type of recurring contract to be used. Possible values:

  • ONECLICK – Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC/CVV).
  • RECURRING – Payment details can be used without the card security code to initiate card-not-present transactions.
  • ONECLICK,RECURRING – Payment details can be used regardless of whether the shopper is on your site or not.
  • PAYOUT – Payment details can be used to make a payout.

Possible values:

  • "ONECLICK"
  • "PAYOUT"
  • "RECURRING"
recurring.recurringExpiry String No

Date after which no further authorisations shall be performed. Only for 3D Secure 2.

recurring.recurringFrequency String No

Minimum number of days between authorisations. Only for 3D Secure 2.

recurring.tokenService String No

The name of the token service.

Possible values:

  • "MCTOKENSERVICE"
  • "AMEXTOKENSERVICE"
  • "VISATOKENSERVICE"
  • "TOKEN_SHARING"
recurring.recurringDetailName String No

A descriptive name for this detail.

merchantAccount String Yes

The merchant account identifier you want to process the (transaction) request with.

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.