List Refunds

GET

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

GET

/stores/:store_hash/v3/orders/payment_actions/refunds

curl https://api.bigcommerce.com/stores/store_hash/v3/orders/payment_actions/refunds \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "id": 1,
      "order_id": 1,
      "user_id": 1,
      "created": "2024-01-15T09:30:00Z",
      "reason": "string",
      "total_amount": 1.99,
      "total_tax": 1.1,
      "uses_merchant_override_values": true,
      "items": [
        {
          "item_type": "PRODUCT",
          "item_id": 1,
          "reason": "string",
          "quantity": 1,
          "adjustments": [
            {
              "amount": -10.2,
              "description": "Service fee"
            }
          ],
          "requested_amount": 1.99
        }
      ],
      "payments": [
        {
          "id": 1,
          "provider_id": "storecredit",
          "amount": 1.99,
          "offline": true,
          "is_declined": true,
          "declined_message": "string",
          "transaction_id": "1234"
        }
      ]
    }
  ],
  "meta": {}
}

Returns a list of refunds ordered by refund ID in ascending order.

Requires at least one of the following scopes:

store_v2_transactions_read_only
store_v2_transactions
store_v2_orders_read_only
store_v2_orders

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

order_id:inlist of integersOptional

Pass a comma-separated list of order IDs to filter the included orders. Accepts multiple values.

id:inlist of integersOptional

Pass a comma-separated list of refund IDs to filter the included refunds. Accepts multiple values.

created:mindatetimeOptional

Filter results so they are later than or equal to provided date.

Must be in url-encoded RFC 3339 format. e.g. 2020-01-15T01:02:34-01:00 is RFC 3339 format. Url-encoded this will be 2020-01-15T01%3A02%3A34%2B01%3A00

created:maxdatetimeOptional

Filter results so they are earlier than or equal to provided date.

Must be in url-encoded RFC 3339 format. e.g. 2020-01-15T01:02:34-01:00 is RFC 3339 format. Url-encoded this will be 2020-01-15T01%3A02%3A34%2B01%3A00

transaction_idstringOptional

Filters by refund payment using the BigCommerce transaction_id.

pageintegerOptional

Specifies the page number in a limited (paginated) list of items.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of items.

Response

A list of refunds.

datalist of objectsOptional

Collection of Refunds

metaobjectOptional

Response metadata.