BigCommerce · Schema

Bank Account Instrument

A stored bank account instrument.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
type	string	Instrument type.
token	string	An identifier representing this stored instrument.
is_default	boolean	Identifies whether this stored instrument is default for the customer.
masked_account_number	string	A masked bank account number.
issuer	string	Issuer identifier for the account.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BankAccountInstrument",
  "title": "Bank Account Instrument",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Instrument type.",
      "enum": [
        "stored_bank_account"
      ]
    },
    "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."
    },
    "masked_account_number": {
      "type": "string",
      "description": "A masked bank account number.",
      "example": "12XXX56"
    },
    "issuer": {
      "type": "string",
      "description": "Issuer identifier for the account.",
      "example": "DE001"
    }
  },
  "description": "A stored bank account instrument.",
  "x-internal": false
}