BigCommerce · Schema

Card Instrument

Details about a stored card instrument which includes details around billing, last 4 digits, issuer, etc.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
type string Type of instrument.
token string An identifier representing this stored instrument.
is_default boolean Identifies whether this stored instrument is default for the customer.
brand string Card brand.
expiry_month integer Expiry month for this card.
expiry_year integer Expiry year for this card.
issuer_identification_number string Issuer identification number for this card.
last_4 string Last four digits of this card.
billing_address object
View JSON Schema on GitHub

JSON Schema

bigcommerce-cardinstrument-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CardInstrument",
  "title": "Card Instrument",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of instrument.",
      "enum": [
        "stored_card"
      ]
    },
    "token": {
      "type": "string",
      "description": "An identifier representing this stored instrument.",
      "example": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c"
    },
    "is_default": {
      "type": "boolean",
      "description": "Identifies whether this stored instrument is default for the customer."
    },
    "brand": {
      "type": "string",
      "description": "Card brand.",
      "example": "VISA"
    },
    "expiry_month": {
      "maximum": 12,
      "minimum": 1,
      "type": "integer",
      "description": "Expiry month for this card."
    },
    "expiry_year": {
      "type": "integer",
      "description": "Expiry year for this card."
    },
    "issuer_identification_number": {
      "type": "string",
      "description": "Issuer identification number for this card.",
      "example": "411111"
    },
    "last_4": {
      "type": "string",
      "description": "Last four digits of this card.",
      "example": "1111"
    },
    "billing_address": {
      "$ref": "#/components/schemas/BillingAddress"
    }
  },
  "description": "Details about a stored card instrument which includes details around billing, last 4 digits, issuer, etc.",
  "x-internal": false
}