Retrieve details of a specific refund using its unique identifier.
Requiresread_financeaccess scope.
The Get Refund API retrieves the details of a specific refund order using its unique identifier.
This API is especially useful for:
- Fetching the details of a specific refund order.
- Tracking the refund's status and processing timeline.
- Verifying the associated transaction and refund amounts.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
id | string | Yes | 123456 | Unique identifier of the refund order. |
Response Explanation
Public Response Parameters
Successful Response
Field | Type | Example | Description |
|---|---|---|---|
| string |
| Status code for the request. |
| string |
| Additional message about the response. |
| object | Contains the refund order details. | |
| object | Refund order details. | |
| string |
| Unique identifier for the refund order. |
| string |
| Store ID associated with the refund. |
| string |
| ID of the transaction order associated with the refund. |
| string |
| Status of the refund: |
| string |
| Refund amount. |
| string |
| Currency used for the refund balance. |
| string |
| Original order amount prior to the refund. |
| string |
| Refund creation timestamp (ISO-8601 format). |
| string |
| Timestamp indicating when the refund was completed (ISO-8601 format). |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |
