BigCommerce · Schema

Refund Payment

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	Reference to refund payment ID.
provider_id	string	Reference to payment provider.
amount	object
offline	boolean	Indicate whether payment was offline.
is_declined	boolean	Indicate if this payment has been declined by payment provider.
declined_message	string	Message indicate why payment was declined.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RefundPayment",
  "title": "Refund Payment",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Reference to refund payment ID.",
      "readOnly": true
    },
    "provider_id": {
      "type": "string",
      "description": "Reference to payment provider.",
      "example": "storecredit"
    },
    "amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "offline": {
      "type": "boolean",
      "description": "Indicate whether payment was offline."
    },
    "is_declined": {
      "type": "boolean",
      "description": "Indicate if this payment has been declined by payment provider."
    },
    "declined_message": {
      "type": "string",
      "description": "Message indicate why payment was declined."
    }
  },
  "x-internal": false
}