Get tokens for stored payment details

get/storedPaymentMethods

API Version

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/v71/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.
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. 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