Get Order Refund

GET

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

GET

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

curl https://api.bigcommerce.com/stores/store_hash/v3/orders/1/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 single refund for the given order by refund ID. The response has the same shape as the Get Refund endpoint.

Requires at least one of the following scopes:

store_v2_transactions_read_only
store_v2_transactions

Note: Use a refund ID that belongs to the order in the path. The refund ID is unique across the store, so a refund ID that belongs to a different order still resolves to that refund.

Returns a single refund for the given order by refund ID. The response has the same shape as the [Get Refund](/developer/api-reference/rest/admin/management/order-operations/payment-actions/get-order-refund) endpoint. Requires at least one of the following scopes: * `store_v2_transactions_read_only` * `store_v2_transactions` **Note:** Use a refund ID that belongs to the order in the path. The refund ID is unique across the store, so a refund ID that belongs to a different order still resolves to that refund.

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

order_idintegerRequired

The ID of the Order to which the transactions belong.

refund_idintegerRequired

Refund ID.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

The ID of the created refund.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Response

Errors

OAuth scopes

Authentication header

Further reading