Get tokens for stored payment details

get/storedPaymentMethods

Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included.

Endpoint destination URL

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

Query Parameters

Required

Optional

Your merchant account.

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.

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

200 - OK
The request has succeeded.
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.
billingAddressobject
The billing address associated with the stored payment method.
citystring
Max length: 3000
The name of the city. Maximum length: 3000 characters.
countrystring
The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

houseNumberOrNamestring
Max length: 3000
The number or name of the house. Maximum length: 3000 characters.
postalCodestring
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
stateOrProvincestring
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

streetstring
Max length: 3000
The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

brandstring
The brand of the card.
cardBinstring
The bank identification number (BIN) of the card.
createdAtstring
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.
mandateobject
Mandate details for the stored payment method.
accountIdTypestring
The type of account identifier for the masked account number.
amountstring
The billing amount (in minor units) of the recurring transactions.
amountRulestring
The limitation rule of the billing amount.

Possible values:

max: The transaction amount can not exceed the amount.

exact: The transaction amount should be the same as the amount.

billingAttemptsRulestring
The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.

Possible values:

on: On a specific date.

before: Before and on a specific date.

after: On and after a specific date.

billingDaystring
The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.

Possible values: 1-31 based on the frequency.
countstring
The number of transactions that can be performed within the given frequency.
currencystring
The three-character ISO currency code.
endsAtstring
End date of the billing plan, in YYYY-MM-DD format.
frequencystring
The frequency with which a shopper should be charged.

Possible values: adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly.
mandateIdstring
The unique identifier of the mandate.
maskedAccountIdstring
The masked account number associated with the mandate.
minAmountstring
For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.
providerIdstring
The provider-specific identifier for this mandate.
recurringAmountstring
For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment.
recurringStatementstring
Max length: 35
The text that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
remarksstring
Additional remarks or notes about the mandate.
retryPolicystring
When set to true, you can retry for failed recurring payments. The default value is true.
startsAtstring
Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
statusstring
The status of the mandate. Examples : active, revoked, completed, expired
txVariantstring
The transaction variant used for this mandate.
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. 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.

typestring
The type of payment method.

Get tokens for stored payment details

HTTP Responses

200 - OK