---
title: "Retrieves stored payment details for a shopper."
method: POST
path: "/listRecurringDetails"
---

# Retrieves stored payment details for a shopper.

`POST /listRecurringDetails`

Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.

For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).

## Request body

- RecurringDetailsRequest
  - `merchantAccount` string, required — The merchant account identifier you want to process the (transaction) request with.
  - `recurring` Recurring
    - `contract` 'ONECLICK' | 'RECURRING' | 'PAYOUT' — The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).
    - `recurringDetailName` string — A descriptive name for this detail.
    - `tokenService` 'VISATOKENSERVICE' | 'MCTOKENSERVICE' — The name of the token service.
  - `shopperReference` string, required — The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

## Response `200`

OK - the request has succeeded.

- RecurringDetailsResult
  - `creationDate` string, date-time — The date when the recurring details were created.
  - `details` RecurringDetail[] — Payment details stored for recurring payments.
    - `additionalData` object — This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.
    - `alias` string — The alias of the credit card number. Applies only to recurring contracts storing credit card details
    - `aliasType` string — The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
    - `bank` BankAccount
      - `bankAccountNumber` string — The bank account number (without separators).
      - `bankCity` string — The bank city.
      - `bankLocationId` string — The location id of the bank. The field value is `nil` in most cases.
      - `bankName` string — The name of the bank.
      - `bic` string — The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.
      - `countryCode` string — Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL').
      - `iban` string — The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).
      - `ownerName` string — The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.
      - `taxId` string — The bank account holder's tax ID.
    - `billingAddress` Address
      - `city` string, required — The name of the city. Maximum length: 3000 characters.
      - `country` string, required — The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
      - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
      - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
      - `stateOrProvince` string — State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
      - `street` string, required — 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`.
    - `card` Card
      - `cvc` string — The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored.
      - `expiryMonth` string, required — The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November
      - `expiryYear` string, required — The card expiry year. Format: 4 digits. For example: 2020
      - `holderName` string, required — The name of the cardholder, as printed on the card.
      - `issueNumber` string — The issue number of the card (for some UK debit cards only).
      - `number` string, required — The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.
      - `startMonth` string — The month component of the start date (for some UK debit cards only).
      - `startYear` string — The year component of the start date (for some UK debit cards only).
    - `contractTypes` string[] — Types of recurring contracts.
    - `creationDate` string, date-time — The date when the recurring details were created.
    - `firstPspReference` string — The `pspReference` of the first recurring payment that created the recurring detail.
    - `name` string — An optional descriptive name for this recurring detail.
    - `paymentMethodVariant` string — The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
    - `recurringDetailReference` string, required — The reference that uniquely identifies the recurring detail.
    - `shopperName` Name
      - `firstName` string, required — The first name.
      - `lastName` string, required — The last name.
    - `socialSecurityNumber` string — A shopper's social security number (only in countries where it is legal to collect).
    - `variant` string, required — The payment method, such as “mc", "visa", "ideal", "paypal".
  - `lastKnownShopperEmail` string — The most recent email for this shopper (if available).
  - `shopperReference` string — The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2021-07-07** (v25) `760cb55f2ef9` — 1 warning
  - removed the optional property `details/items/shopperName/infix` from the response with the `200` status
- **2021-04-10** (v25) `a71fe366dba0` — 5 info
  - added the optional property `status` to the response with the `400` status
  - added the optional property `status` to the response with the `401` status
  - added the optional property `status` to the response with the `403` status
  - added the optional property `status` to the response with the `422` status
  - …1 more
- **2021-03-05** (v25) `9aa7722f8142` — 1 breaking, 5 info
  - removed the required property `details/items/shopperName/gender` from the response with the `200` status
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `401`
  - added the media type `application/json` for the response with the status `403`
  - …2 more
- **2020-08-05** (v25) `aaba80d479bb` — 1 info
  - api operation id `post-listRecurringDetails` was added
- **2020-03-04** (v25) `016d859e847f` — 12 breaking, 1 warning, 19 info
  - the request's body type changed from `object` to no type
  - removed the enum value `AMEXTOKENSERVICE` of the request property `recurring/tokenService`
  - removed the enum value `EXTERNAL` of the request property `recurring/contract`
  - removed the enum value `ONECLICK,RECURRING` of the request property `recurring/contract`
  - …28 more

[Change history](https://skmtc.dev/adyen/apis/recurringservice/changes/listRecurringDetails/post.md)

---

[API](https://skmtc.dev/adyen/apis/recurringservice.md) · [All operations](https://skmtc.dev/adyen/apis/recurringservice/llms.txt) · [OpenAPI document](https://skmtc.dev/adyen/apis/recurringservice/revisions/760cb55f2ef9?raw)