Documentation Portal

CustomerAmountPrepaidRefund

Decimal

The return shipping cost. Populated by the Merchant.

CustomerPrepaidRefundAmount

Decimal

Represents a prepaid fee that the customer is required to pay in case of refunds. This fee is deducted from the total refund amount due to the customer. The value of this field is specified in the currency of the customer.

No

DutiesAmount

Decimal

The “Duties” amount in the customer's currency included in the TotalRefundAmount. “Duties” denotes the funds that should be refunded due to Duties, Taxes and CCF costs.

No

FullRefund

Boolean

The flag indicates that the full refund of the order should be performed.

TRUE provide full refund

FALSE do not provide full refund

No

InitiatedBy

String

Identifies who initiated the refund process.

No

OrderId

String

Global‑e order unique identifier (previously submitted to the Merchant’s SendOrderToMerchant method when the order had been created with Global‑e checkout) or Order unique identifier on the Merchant’s site.

OriginalAmountPrepaidRefund

Decimal

The return shipping cost in the customer’s currency.

OriginalCustomerPrepaidRefundAmount

Decimal

Represents a prepaid fee that the customer is required to pay in case of refunds. This field is populated in the original currency of the Merchant. The prepaid fee is converted to the currency of the customer and then deducted from the total refund amount due to the customer. Currency conversion rates are calculated based on the Spot rate on the day of the order creation. Use this field only when CustomerPrepaidRefundAmount is not provided. Make sure that only one of these fields is populated at a time to avoid double deductions.

No

OriginalTotalRefundAmount

Decimal

The refund amount in the original Merchant currency including the local Merchant VAT.

No

ProductsDutiesRefund

Boolean

The flag indicates that the refund for the products should also include the associated duties and taxes. If ProductsDutiesRefund is specified, all refund totals will be auto-calculated, and therefore specifying DutiesAmount, TotalRefundAmount or OriginalTotalRefundAmount will return an error in this case.

TRUE - Refund includes taxes.

FALSE - Refund will not include taxes.

No

RefundComments

String

Merchant's comments for the order refund

No

RefundReason

Object OrderRefundReason

Reason for the order refund

No

ServiceGestureAmount

Decimal

“Service gesture” amount in the customer’s currency included in TotalRefundAmount. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.

No

ShippingAmount

Decimal

The “Shipping” amount in the customer’s currency included in TotalRefundAmount. “Shipping” denotes the funds that should be refunded due to shipping costs.

No

ShippingRefund

Boolean

The flag indicates that the full shipping cost should be refunded. Either the ShippingRefund flag or ShippingAmount can be provided at the same time If a part of the shipping cost was already refunded – only the remaining available part will be refunded.

TRUE - Shipping cost is refunded.

FALSE - Shipping cost is not refunded.

No

TotalRefundAmount

Decimal

The total refund amount in the end customer’s currency and used for this order’s payment. If this attribute is not specified, OriginalTotalRefundAmount along with the sum of OriginalRefundAmount values in the refundProductsList specified in the respective CreateOrderRefund, will be used to calculate the TotalRefundAmount.

No