BigCommerce · Schema

paymentMethodStoredInstrument

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
brand	string	Brand of this card such as VISA or Mastercard
expiry_month	integer	Expiry month of this card
expiry_year	integer	Expiry year of this card
issuer_identification_number	string	Issuer identification number of this card. This is extracted from the card when the order is paid for.
last_4	string	Last four numbers of this card
token	string	A BigCommerce-generated identifier that represents the stored card.
is_default	boolean	Whether this instrument is a default instrument
type	string	Type to classify this stored card

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/paymentMethodStoredInstrument",
  "title": "paymentMethodStoredInstrument",
  "type": "object",
  "properties": {
    "brand": {
      "description": "Brand of this card such as VISA or Mastercard",
      "type": "string",
      "minLength": 1
    },
    "expiry_month": {
      "description": "Expiry month of this card",
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "format": "int32"
    },
    "expiry_year": {
      "description": "Expiry year of this card",
      "type": "integer",
      "format": "int32"
    },
    "issuer_identification_number": {
      "description": "Issuer identification number of this card. This is extracted from the card when the order is paid for.",
      "type": "string",
      "minLength": 6,
      "maxLength": 6
    },
    "last_4": {
      "description": "Last four numbers of this card",
      "type": "string",
      "minLength": 4,
      "maxLength": 4
    },
    "token": {
      "description": "A BigCommerce-generated identifier that represents the stored card.",
      "type": "string",
      "minLength": 64,
      "maxLength": 64
    },
    "is_default": {
      "description": "Whether this instrument is a default instrument",
      "example": false,
      "type": "boolean",
      "default": false
    },
    "type": {
      "description": "Type to classify this stored card",
      "example": "stored_card",
      "type": "string",
      "default": "stored_card"
    }
  },
  "required": [
    "brand",
    "expiry_month",
    "expiry_year",
    "issuer_identification_number",
    "last_4",
    "token",
    "is_default",
    "type"
  ],
  "x-examples": {
    "example-1": {
      "brand": "string",
      "expiry_month": 1,
      "expiry_year": 0,
      "issuer_identification_number": "string",
      "last_4": "stri",
      "token": "stringstringstringstringstringstringstringstringstringstringstri",
      "is_default": false,
      "type": "stored_card"
    }
  },
  "x-internal": false
}