Get Order Refund by ID
2min
GET
AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
order_id
integer
*refund_id
integer
*HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
RESPONSES
200
successful operation
Refund
Order Refund
id
integer<int64>
order_id
integer<int64>
*ID of the Order being refunded
bag_id
integer<int64>
ID of the Bag being refunded
merchant_id
integer<int32>
*ID of the merchant making the refund
app_id
integer<int32>
*ID of the App that created the Order
transaction_id
integer<int64>
*ID of the Transaction being refunded
gateway_transaction_id
string
*ID of the Transaction in the Payment Gateway
amount
integer<int32>
*Amount being refunded
merchant_transfer_reversal_amount_usd
integer<int32>
Amount being taken back from the associated transfer to the merchant
developer_transfer_reversal_amount_usd
integer<int32>
Amount being taken back from the associated transfer to the developer
reason
string
Reason for refund
refund_currency
string
Currency set for this refund by the external ecom platform
status
string<PROCESSING | COMPLETED | CANCELED | PARTIALLY_COMPLETED | FAILED | EXTERNAL>
Status of the Refund
skus
RefundOrderSku[]
SKUs the refund applies to
date_created
string<date-time>
Date of creation
date_last_modified
string<date-time>
Date of last update
external_id
string
ID of the refund on the external commerce platform.
errors
Refund Errors[]
List of errors associated to this refund during processing.
Updated 16 May 2023
Did this page help you?
Yes
No