Create Refund Quote

POST

https://api.bigcommerce.com/stores/:store_hash/v3/orders/:order_id/payment_actions/refund_quotes

POST

/stores/:store_hash/v3/orders/:order_id/payment_actions/refund_quotes

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/orders/1/payment_actions/refund_quotes \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "tax_adjustment_amount": 1.99
}'

{
  "data": {
    "order_id": 1,
    "total_refund_amount": 1.99,
    "total_refund_tax_amount": 1.95,
    "order_level_refund_amount": 1.99,
    "rounding": 1.1,
    "adjustment": -10.2,
    "tax_inclusive": true,
    "refund_methods": [
      [
        {
          "provider_id": "checkout_paypalexpress",
          "provider_description": "Paypal Express",
          "amount": 9.99,
          "offline": true,
          "offline_provider": true,
          "offline_reason": "Multiple online refunds are not available"
        }
      ]
    ]
  },
  "meta": {}
}

Calculate the tax amount, total refund amount and get available payment options for an order refund by providing items and costs or quantities to refund.

Requires at least one of the following scopes:

store_v2_orders
store_v2_transactions

Notes:

Create a refund quote before performing a refund request to best avoid a 422 error. Check the refund quote’s response body for the refund_methods array. The amount given in the array must match the amount used in the refund request body.
Order refunds should be processed sequentially. Processing multiple concurrent refunds on the same order is not yet supported.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Transactions	read and modify `transactions` and `payment_methods`	`store_v2_transactions`
Order Transactions	read `transactions` and `payment_methods`	`store_v2_transactions_read_only`
Orders	read and modify `payment_methods`	`store_v2_orders`
Orders	read `payment_methods`	`store_v2_orders_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

order_idintegerRequired

The ID of the Order to which the transactions belong.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

Items RefundobjectRequired

Tax Adjustment RefundobjectRequired

Response

The requested refund quote.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error