BigCommerce · Schema

RefundQuote_Full

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
order_id integer ID of the order to be refunded.
total_refund_amount object
total_refund_tax_amount number
rounding number Indicates rounding value to bring `refund_total` to an amount refundable with payment providers (in this case to 2 decimal places).
adjustment object
tax_inclusive boolean Indicate if `total_refund_amount` includes tax amount.
refund_methods array An array of available refund methods. Note that `refund_methods` is an array of refund methods, with each refund method being an array of payment options. For example, if the order was placed by a com
View JSON Schema on GitHub

JSON Schema

bigcommerce-refundquote-full-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RefundQuote_Full",
  "title": "RefundQuote_Full",
  "type": "object",
  "x-internal": false,
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "ID of the order to be refunded."
    },
    "total_refund_amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "total_refund_tax_amount": {
      "type": "number",
      "example": 1.95
    },
    "rounding": {
      "type": "number",
      "description": "Indicates rounding value to bring `refund_total` to an amount refundable with payment providers (in this case to 2 decimal places)."
    },
    "adjustment": {
      "$ref": "#/components/schemas/AdjustmentAmount"
    },
    "tax_inclusive": {
      "type": "boolean",
      "description": "Indicate if `total_refund_amount` includes tax amount."
    },
    "refund_methods": {
      "type": "array",
      "description": "An array of available refund methods.\n\nNote that `refund_methods` is an array of refund methods, with each refund method being an array of payment options.\n\nFor example, if the order was placed by a combination of store credit and bank deposit the refund methods would be:\n\n```json\n{\n  \"refund_methods\": [\n    [\n      {\n        \"provider_id\": \"storecredit\",\n        \"provider_description\": \"Store Credit\",\n        \"amount\": 119.35,\n        \"offline\": false,\n        \"offline_provider\": false,\n        \"offline_reason\": \"\"\n      }\n    ],\n    [\n      {\n        \"provider_id\": \"custom\",\n        \"provider_description\": \"Custom\",\n        \"amount\": 119.35,\n        \"offline\": true,\n        \"offline_provider\": true,\n        \"offline_reason\": \"This is an offline payment provider.\"\n      }\n    ],\n    [\n      {\n        \"provider_id\": \"bankdeposit\",\n        \"provider_description\": \"Bank Deposit\",\n        \"amount\": 80.35,\n        \"offline\": true,\n        \"offline_provider\": true,\n        \"offline_reason\": \"This is an offline payment provider.\"\n      },\n      {\n        \"provider_id\": \"storecredit\",\n        \"provider_description\": \"Store Credit\",\n        \"amount\": 39,\n        \"offline\": false,\n        \"offline_provider\": false,\n        \"offline_reason\": \"\"\n      }\n    ]\n  ]\n}\n```\n\nIn this case there are three refund methods available to the merchant:\n1. Refund up to the entire order amount to store credit.\n2. Mark an amount up to the full order amount as refunded externally, through a provider or means not represented directly in BC (\"custom\").\n3. Refund the amount paid by store credit to store credit, and the amount paid by bank deposit with a manual refund, which will be recorded as being refunded against the bank deposit.\n",
      "items": {
        "$ref": "#/components/schemas/RefundMethod"
      }
    }
  }
}