Version: 202607
Get refund order
GET/openapi/2026-07/shoplazza-payment/refunds/:id
Returns the details of a single refund order identified by its unique ID.
Request
Path Parameters
id stringrequired
Refund order ID
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
succeeded: Refund successfully processedfailed: Refund failedprocessing: Refund is pending processing
codestring
error code
messagestring
error message
data object
refund_order object
Detailed information of the refund order
idstring
Refund ID
store_idstring
Store ID associated with the refund
balance_currencystring
Currency used for the balance
transaction_order_idstring
ID of the transaction order associated with the refund
statusstring
Refund status:
amountstring
Refund amount
currencystring
Currency code of the refund (e.g., USD)
original_order_amountstring
Original order amount prior to the refund
created_atstring
Refund creation timestamp (ISO-8601 format)
completed_atstring
Timestamp indicating when the refund was completed (ISO-8601 format)
{
"code": "string",
"message": "string",
"data": {
"refund_order": {
"id": "string",
"store_id": "string",
"balance_currency": "string",
"transaction_order_id": "string",
"status": "string",
"amount": "string",
"currency": "string",
"original_order_amount": "string",
"created_at": "string",
"completed_at": "string"
}
}
}