get https://{subdomain}.myshoplaza.com/openapi/2024-07/shoplazza-payment/refunds/
Requires
read_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 |
|---|---|---|---|
code | string | "Success" | Status code for the request. |
message | string | "Request successful" | Additional message about the response. |
data | object | Contains the refund order details. | |
data.refund_order | object | Refund order details. | |
data.refund_order.id | string | "123456" | Unique identifier for the refund order. |
data.refund_order.store_id | string | "store123" | Store ID associated with the refund. |
data.refund_order.transaction_order_id | string | "trans123" | ID of the transaction order associated with the refund. |
data.refund_order.status | string | "succeeded" | Status of the refund: succeeded: Refund successfully processed. failed: Refund failed. processing: Refund is pending processing. |
data.refund_order.amount | string | "50.00" | Refund amount. |
data.refund_order.balance_currency | string | "USD" | Currency used for the refund balance. |
data.refund_order.original_order_amount | string | "100.00" | Original order amount prior to the refund. |
data.refund_order.created_at | string | "2024-04-28T06:50:19Z" | Refund creation timestamp (ISO-8601 format). |
data.refund_order.completed_at | string | "2024-04-28T06:52:36Z" | Timestamp indicating when the refund was completed (ISO-8601 format). |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Description | Example |
|---|---|---|---|
code | string | The error code indicating the type of issue. | UnknownError |
message | string | A detailed message describing the error. | wrong cursor |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 500 | UnknownError | cursor is not invalid or empty. | Unknown error, please contact shoplazza technical support to resolve the issue. |