Adyen · Schema

StoredPaymentMethodResource

PaymentsFinancial ServicesFintech

Properties

Name Type Description
brand string The brand of the card.
expiryMonth string The month the card expires.
expiryYear string The last two digits of the year the card expires. For example, **22** for the year 2022.
externalResponseCode string The response code returned by an external system (for example after a provisioning operation).
externalTokenReference string The token reference of a linked token in an external system (for example a network token reference).
holderName string The unique payment method code.
iban string The IBAN of the bank account.
id string A unique identifier of this stored payment method.
issuerName string The name of the issuer of token or card.
lastFour string The last four digits of the PAN.
name string The display name of the stored payment method.
networkTxReference string 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
ownerName string The name of the bank account holder.
shopperEmail string The shoppers email address.
shopperReference string 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 exam
supportedRecurringProcessingModels array 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, c
type string The type of payment method.
View JSON Schema on GitHub

JSON Schema

adyen-storedpaymentmethodresource-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StoredPaymentMethodResource",
  "title": "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.\n\nThis 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 shoppers email address.",
      "type": "string"
    },
    "shopperReference": {
      "description": "Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> 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.\nAllowed values:\n* `Subscription`  A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `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.\n* `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"
}