BigCommerce · Schema

Payment Request

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
provider_id	string	Reference to payment provider.
amount	number	Amount refunded with this provider.
offline	boolean	Whether the payment was marked as offline or performed through an online payment service.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentRequest",
  "title": "Payment Request",
  "type": "object",
  "properties": {
    "provider_id": {
      "type": "string",
      "description": "Reference to payment provider.",
      "example": "checkout_paypalexpress"
    },
    "amount": {
      "type": "number",
      "description": "Amount refunded with this provider.",
      "example": 9.99
    },
    "offline": {
      "type": "boolean",
      "description": "Whether the payment was marked as offline or performed through an online payment service.",
      "example": true
    }
  },
  "x-internal": false
}