Skip to main content
POST
Notify the merchant of a Global-e initiated refund
Part of the Refunds Notifications (from Global-e) integration guide — see it for when and how to use this endpoint.

Body

application/json

Contains information about order refunds.

OrderId
string
required

Global-e order unique identifier.

OriginalTotalRefundAmount
string
required

The refund amount in the original Merchant currency including the local Merchant's VAT (currency is specified in CurrencyCode property of the respective Merchant.Order).

TotalRefundAmount
string
required

The total refund amount in the end customer's currency used for this order's payment (currency is specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order).

Components
Merchant.RefundComponent · object[]

The list of RefundComponent objects for this order refund.

MerchantGUID
string

Unique identifier of the Merchant on Global-e.

MerchantOrderId
string

Order unique identifier on the Merchant's site returned from a previous call to the SendOrderToMerchant method for this order.

MerchantRMANumber
string

The Merchant's Returned Merchandize Authorization Number

Products
Merchant.RefundProduct · object[]

List of RefundProduct objects for this order refund.

RefundComments
string

Comments for the order refund

RefundReason
Merchant.OrderRefundReason · object

Reason for the order refund

RMANumber
string

The RMA number taken from the related Return.

ServiceGestureAmount
string

The "Service gesture" amount in the customer's currency is included in the TotalRefundAmount. "Service gesture" denotes any additional refund granted to the user, on top of the refund related to other components.

WebStoreCode
string | null

Code used on the Merchant's side to identify the web store, as specified in the WebStoreCode argument for the SendCart method for the cart converted to this order on Global-e.

RefundId
string
CurrencyCode
string
OriginalCurrencyCode
string

Response

200 - application/json

The merchant returns a Merchant.ResponseInfo object. Some response values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Provides response data regarding the API call.

Description
string

Optional response description. In case of an error, this property indicates the error message description.

ErrorCode
string

Error code to be returned when an error occurs.

InternalOrderId
string

Order unique identifier on the Merchant's site

Message
string

Optional response message. In case of an error, this property indicates the error message text.

OrderId
string

Order identifier on the Merchant's site used for display and reporting purposes only. Unlike the InternalOrderId, this identifier is not necessarily unique over time, as the Merchant's site may potentially reuse it (for example after deleting the old order having the same OrderId).

PaymentAmount
string

The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).

PaymentCurrencyCode
string

3-char ISO currency code for the order (if payment was processed in the respective API method call).

StatusCode
string

Code denoting the order status on the Merchant's site (to be mapped on the Global-e side).

Success
boolean

Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.