v1

latestOpenAPI 3.1.02026-07-2022194782.1 KB

Recurring

Create a token to store payment details

Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.

post/storedPaymentMethods

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

merchantAccountstring required

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

shopperEmailstring

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.

shopperIPstring

The IP address of a shopper.

shopperReferencestring required

A unique identifier for the shopper (for example, user ID or account ID).

Response

Created - the request has been fulfilled and has resulted in one or more new resources being created.

aliasstring

The alias of the credit card number.

Applies only to recurring contracts storing credit card details

aliasTypestring

The alias type of the credit card number.

Applies only to recurring contracts storing credit card details.

brandstring

The brand of the card.

cardBinstring

The bank identification number (BIN) of the card.

expiryMonthstring

The month the card expires.

expiryYearstring

The year the card expires, for example 2022.

holderNamestring

The unique payment method code.

ibanstring

The IBAN of the bank account.

idstring

A unique identifier of this stored payment method.

lastFourstring

The last four digits of the PAN.

namestring

The display name of the stored payment method.

networkTxReferencestring

Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.

This contains either the Mastercard Trace ID or the Visa Transaction ID.

shopperEmailstring

The shopper’s email address.

shopperReferencestring

Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.

Your reference must not include personally identifiable information (PII) such as name or email address.

supportedShopperInteractionsstring[]

The supported shopper interactions for this stored payment method.

typestring

The type of payment method.