Adyen · JSON Structure

Checkout Stored Payment Method Structure

StoredPaymentMethod schema from Adyen API

Type: object Properties: 17
PaymentsFinancial ServicesFintech

StoredPaymentMethod is a JSON Structure definition published by Adyen, describing 17 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

bankAccountNumber bankLocationId brand expiryMonth expiryYear holderName iban id label lastFour name networkTxReference ownerName shopperEmail supportedRecurringProcessingModels supportedShopperInteractions type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-stored-payment-method-structure.json",
  "description": "StoredPaymentMethod schema from Adyen API",
  "type": "object",
  "properties": {
    "bankAccountNumber": {
      "description": "The bank account number (without separators).",
      "type": "string"
    },
    "bankLocationId": {
      "description": "The location id of the bank. The field value is `nil` in most cases.",
      "type": "string"
    },
    "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"
    },
    "holderName": {
      "description": "The unique payment method code.",
      "type": "string"
    },
    "iban": {
      "x-addedInVersion": "67",
      "description": "The IBAN of the bank account.",
      "type": "string"
    },
    "id": {
      "description": "A unique identifier of this stored payment method.",
      "type": "string"
    },
    "label": {
      "x-addedInVersion": "70",
      "description": "The shopper\u2019s issuer account label",
      "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": {
      "x-addedInVersion": "68",
      "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 shopper\u2019s email address.",
      "type": "string"
    },
    "supportedRecurringProcessingModels": {
      "x-addedInVersion": "70",
      "description": "The supported recurring processing models for this stored payment method.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "supportedShopperInteractions": {
      "description": "The supported shopper interactions for this stored payment method.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "description": "The type of payment method.",
      "type": "string"
    }
  },
  "name": "StoredPaymentMethod"
}