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.
Headers
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request body
The merchant account identifier, with which you want to process the transaction.
Defines a recurring payment type. Required when creating a token to store payment details. Allowed values:
- Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
- CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
- UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
The IP address of a shopper.
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.
The alias of the credit card number.
Applies only to recurring contracts storing credit card details
The alias type of the credit card number.
Applies only to recurring contracts storing credit card details.
The brand of the card.
The bank identification number (BIN) of the card.
The month the card expires.
The last two digits of the year the card expires. For example, 22 for the year 2022.
The response code returned by an external system (for example after a provisioning operation).
The token reference of a linked token in an external system (for example a network token reference).
The unique payment method code.
The IBAN of the bank account.
A unique identifier of this stored payment method.
The name of the issuer of token or card.
The last four digits of the PAN.
The display name of the stored payment method.
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.
The name of the bank account holder.
The shopper’s email address.
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.
Defines a recurring payment type. Allowed values:
- Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
- CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
- UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
The type of payment method.