Adyen storedPaymentMethods API

openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute storedPaymentMethods API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: storedPaymentMethods
paths:
  /storedPaymentMethods:
    get:
      tags:
      - storedPaymentMethods
      summary: Adyen Get Tokens for Stored Payment Details
      description: '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.


        '
      x-addedInVersion: '70'
      operationId: get-storedPaymentMethods
      x-sortIndex: 2
      x-methodName: getTokensForStoredPaymentDetails
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: '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.'
        name: shopperReference
        in: query
        required: false
        schema:
          type: string
      - description: Your merchant account.
        name: merchantAccount
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-storedPaymentMethods-success-200'
              schema:
                $ref: '#/components/schemas/ListStoredPaymentMethodsResponse'
          description: OK - the request has succeeded.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /storedPaymentMethods/{storedPaymentMethodId}:
    delete:
      tags:
      - storedPaymentMethods
      summary: Adyen Delete a Token for Stored Payment Details
      description: Deletes the token identified in the path. The token can no longer be used with payment requests.
      x-addedInVersion: '70'
      operationId: delete-storedPaymentMethods-storedPaymentMethodId
      x-sortIndex: 4
      x-methodName: deleteTokenForStoredPaymentDetails
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the token.
        name: storedPaymentMethodId
        in: path
        required: true
        schema:
          type: string
      - description: '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.'
        name: shopperReference
        in: query
        required: true
        schema:
          type: string
      - description: Your merchant account.
        name: merchantAccount
        in: query
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'No Content - look at the actual response code for the status of the request. '
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ListStoredPaymentMethodsResponse:
      properties:
        merchantAccount:
          description: Your merchant account.
          type: string
        shopperReference:
          description: '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.'
          type: string
        storedPaymentMethods:
          description: List of all stored payment methods.
          items:
            $ref: '#/components/schemas/StoredPaymentMethodResource'
          type: array
      type: object
    StoredPaymentMethodResource:
      properties:
        brand:
          description: The brand of the card.
          type: string
        expiryMonth:
          description: The month the card expires.
          type: string
        expiryYear:
          description: The last two digits of the year the card expires. For example, **22** for the year 2022.
          type: string
        externalResponseCode:
          x-addedInVersion: '68'
          description: The response code returned by an external system (for example after a provisioning operation).
          type: string
        externalTokenReference:
          x-addedInVersion: '68'
          description: The token reference of a linked token in an external system (for example a network token reference).
          type: string
        holderName:
          description: The unique payment method code.
          type: string
        iban:
          description: The IBAN of the bank account.
          type: string
        id:
          description: A unique identifier of this stored payment method.
          type: string
        issuerName:
          x-addedInVersion: '68'
          description: The name of the issuer of token or card.
          type: string
        lastFour:
          description: The last four digits of the PAN.
          type: string
        name:
          description: The display name of the stored payment method.
          type: string
        networkTxReference:
          description: '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.'
          type: string
        ownerName:
          x-addedInVersion: '67'
          description: The name of the bank account holder.
          type: string
        shopperEmail:
          description: The shopper’s email address.
          type: string
        shopperReference:
          description: '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.'
          maxLength: 256
          minLength: 3
          type: string
        supportedRecurringProcessingModels:
          x-addedInVersion: '70'
          description: '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.'
          items:
            type: string
          type: array
        type:
          description: The type of payment method.
          type: string
      type: object
  examples:
    get-storedPaymentMethods-success-200:
      summary: List of stored payment methods for specified shopper
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        shopperReference: YOUR_SHOPPER_REFERENCE
        storedPaymentMethods:
        - brand: visa
          expiryMonth: '10'
          expiryYear: '30'
          holderName: John Smith
          id: '7219687191761347'
          issuerName: ISSUER_NAME
          lastFour: '1111'
          name: VISA
          shopperEmail: john.smith@example.com
          shopperReference: YOUR_SHOPPER_REFERENCE
          supportedRecurringProcessingModels:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: scheme
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification