Create a token to store payment details

post/storedPaymentMethods

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

Endpoint destination URL

https://checkout-test.adyen.com/v71/storedPaymentMethods

Header Parameters

Required

Optional

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

Request Parameters

Required

Optional

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

Contains the information required to store a payment method.

Show children

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 parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

201 - Created
The request has been fulfilled and has resulted in one or more new resources being created.
Show moreShow less
brandstring
The brand of the card.
expiryMonthstring
The month the card expires.
expiryYearstring
The last two digits of the year the card expires. For example, 22 for the year 2022.
externalResponseCodestring
The response code returned by an external system (for example after a provisioning operation).
externalTokenReferencestring
The token reference of a linked token in an external system (for example a network token reference).
holderNamestring
The unique payment method code.
ibanstring
The IBAN of the bank account.
idstring
A unique identifier of this stored payment method.
issuerNamestring
The name of the issuer of token or card.
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.
ownerNamestring
The name of the bank account holder.
shopperEmailstring
The shopper’s email address.
shopperReferencestring
Min length: 3Max length: 256
Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

Your reference must not include personally identifiable information (PII), for example name or email address.

supportedRecurringProcessingModelsarray[string]
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.

typestring
The type of payment method.

Create a token to store payment details

Header Parameters

Request Parameters

Response parameters

HTTP Responses

201 - Created