BigCommerce · Schema

payment_Base

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
code	string	Unique platform-wide code identifying the payment method.
name	string	Descriptive name of the payment method.
test_mode	boolean	Determines whether the payment gateway is in test mode. Always false for offline payment methods.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_Base",
  "title": "payment_Base",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Unique platform-wide code identifying the payment method.",
      "example": "squarev2"
    },
    "name": {
      "type": "string",
      "description": "Descriptive name of the payment method.",
      "example": "Square"
    },
    "test_mode": {
      "type": "boolean",
      "description": "Determines whether the payment gateway is in test mode. Always false for offline payment methods.",
      "example": false
    }
  },
  "example": {
    "code": "squarev2",
    "name": "Square",
    "test_mode": false
  },
  "x-internal": false
}