Pick the Get tokens for stored payment details action (under Recurring).
Fill in the fields below, then reference the result from later steps as {{getTokensForStoredPaymentDetails.response.data}}.
Request
Query parameters
shopperReferencestring
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.
merchantAccountstring
Your merchant account.
Response
Returns 200 with an object. Read it in later steps with {{getTokensForStoredPaymentDetails.response.data.<field>}}.
merchantAccountstring
Your merchant account.
shopperReferencestring
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.
storedPaymentMethodsarray<object>
List of all stored payment methods.
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.
billingAddressobject6 fields
brandstring
The brand of the card.
cardBinstring
The bank identification number (BIN) of the card.
createdAtstring (date-time)
The date when the recurring details were created.
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).
firstPspReferencestring
The PSP reference of the first payment that created this recurring detail.
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.
mandateobject20 fields
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.
opiobject2 fields
ownerNamestring
The name of the bank account holder.
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.
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.