BigCommerce Docs

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

{
  "data": {
    "id": 12,
    "order_id": 180,
    "user_id": 0,
    "created": "2022-06-16T16:44:15+00:00",
    "reason": "Customer requires a refund.",
    "total_amount": 50,
    "total_tax": 5,
    "uses_merchant_override_values": false,
    "payments": [
      {
        "id": 13,
        "provider_id": "storecredit",
        "amount": 50,
        "offline": true,
        "is_declined": false,
        "declined_message": ""
      }
    ],
    "items": [
      {
        "item_type": "PRODUCT",
        "item_id": 87,
        "quantity": 1,
        "requested_amount": null
      }
    ]
  },
  "meta": {}
}

Returns a refund by refund ID.

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

{
  "data": {
    "id": 12,
    "order_id": 180,
    "user_id": 0,
    "created": "2022-06-16T16:44:15+00:00",
    "reason": "Customer requires a refund.",
    "total_amount": 50,
    "total_tax": 5,
    "uses_merchant_override_values": false,
    "payments": [
      {
        "id": 13,
        "provider_id": "storecredit",
        "amount": 50,
        "offline": true,
        "is_declined": false,
        "declined_message": ""
      }
    ],
    "items": [
      {
        "item_type": "PRODUCT",
        "item_id": 87,
        "quantity": 1,
        "requested_amount": null
      }
    ]
  },
  "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.

Get Refund

Get Refund

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Response

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Response

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

1	{
2	"data": {
3	"id": 12,
4	"order_id": 180,
5	"user_id": 0,
6	"created": "2022-06-16T16:44:15+00:00",
7	"reason": "Customer requires a refund.",
8	"total_amount": 50,
9	"total_tax": 5,
10	"uses_merchant_override_values": false,
11	"payments": [
12	{
13	"id": 13,
14	"provider_id": "storecredit",
15	"amount": 50,
16	"offline": true,
17	"is_declined": false,
18	"declined_message": ""
19	}
20	],
21	"items": [
22	{
23	"item_type": "PRODUCT",
24	"item_id": 87,
25	"quantity": 1,
26	"requested_amount": null
27	}
28	]
29	},
30	"meta": {}
31	}