BigCommerce Docs

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

{
  "data": [
    {
      "id": 101,
      "order_id": 1,
      "user_id": 5023,
      "created": "2024-04-10T14:22:00Z",
      "reason": "Customer returned damaged item",
      "total_amount": 45.5,
      "total_tax": 3.75,
      "uses_merchant_override_values": false,
      "items": [
        {
          "item_type": "PRODUCT",
          "item_id": 789,
          "reason": "Item defective",
          "quantity": 2,
          "adjustments": [
            {
              "amount": -5,
              "description": "Restocking fee"
            }
          ],
          "requested_amount": 45.5
        }
      ],
      "payments": [
        {
          "id": 301,
          "provider_id": "stripe",
          "amount": 45.5,
          "offline": false,
          "is_declined": false,
          "declined_message": "",
          "transaction_id": "txn_1GqIC8L2eZvKYlo2C0a1bX9Z"
        }
      ]
    }
  ],
  "meta": {}
}

Returns a list of refunds ordered by refund ID in ascending order for the given 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`

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

{
  "data": [
    {
      "id": 101,
      "order_id": 1,
      "user_id": 5023,
      "created": "2024-04-10T14:22:00Z",
      "reason": "Customer returned damaged item",
      "total_amount": 45.5,
      "total_tax": 3.75,
      "uses_merchant_override_values": false,
      "items": [
        {
          "item_type": "PRODUCT",
          "item_id": 789,
          "reason": "Item defective",
          "quantity": 2,
          "adjustments": [
            {
              "amount": -5,
              "description": "Restocking fee"
            }
          ],
          "requested_amount": 45.5
        }
      ],
      "payments": [
        {
          "id": 301,
          "provider_id": "stripe",
          "amount": 45.5,
          "offline": false,
          "is_declined": false,
          "declined_message": "",
          "transaction_id": "txn_1GqIC8L2eZvKYlo2C0a1bX9Z"
        }
      ]
    }
  ],
  "meta": {}
}

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

Header

Argument

Description

X-Auth-Token

access_token

For more about API accounts that generate access_tokens, see our Guide to API Accounts.

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.

List Refunds for Order

List Refunds for Order

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

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

1	{
2	"data": [
3	{
4	"id": 101,
5	"order_id": 1,
6	"user_id": 5023,
7	"created": "2024-04-10T14:22:00Z",
8	"reason": "Customer returned damaged item",
9	"total_amount": 45.5,
10	"total_tax": 3.75,
11	"uses_merchant_override_values": false,
12	"items": [
13	{
14	"item_type": "PRODUCT",
15	"item_id": 789,
16	"reason": "Item defective",
17	"quantity": 2,
18	"adjustments": [
19	{
20	"amount": -5,
21	"description": "Restocking fee"
22	}
23	],
24	"requested_amount": 45.5
25	}
26	],
27	"payments": [
28	{
29	"id": 301,
30	"provider_id": "stripe",
31	"amount": 45.5,
32	"offline": false,
33	"is_declined": false,
34	"declined_message": "",
35	"transaction_id": "txn_1GqIC8L2eZvKYlo2C0a1bX9Z"
36	}
37	]
38	}
39	],
40	"meta": {}
41	}