Get Refund Order Details

Retrieve details of a specific refund using its unique identifier.

🔒

Requires read_finance access scope.

The Get Refund API retrieves the details of a specific refund order using its unique identifier.

This API is especially useful for:

  1. Fetching the details of a specific refund order.
  2. Tracking the refund's status and processing timeline.
  3. Verifying the associated transaction and refund amounts.

Request Parameters

Public Request Parameters

📘

Path Parameters

FieldTypeRequiredExampleDescription
idstringYes123456Unique 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

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!