Skip to main content

Documentation Portal

RefundComponent

Name

Type

Description

Mandatory

Amount

String

The refund amount in customer currency.

Yes

ComponentType

String

One of the following types:

  • Products

  • Shipping, Duties

  • PrepaidReturn

  • ServiceGesture

Yes

IsChargedToMerchant

String

Either True or False.

If this component is charged to the merchant, the flag is TRUE (default). If this component is charged to Global‑e, the flag is FALSE. If the same component is split between charged to the merchant and charged to Global‑e, it should appear twice, each time with a different value in IsChargedToMerchant. The exception is a component PrepaidReturn – it should always be IsChargedToMerchant = TRUE.

Yes

OriginalAmount

String

The refund amount in merchant currency.

Yes

RefundAsGiftCard

Boolean

Identifies if to refund the order as a gift card.

True: The refund is provided as a gift card

False: The refund is not provided as a gift card.

No

TotalGiftCardsRefundAmount

String

The parameter will be the TotalRefundAmount converted by the Daily Spot Rate.

The parameter will be displayed in the API call only when the feature is enabled and will have value, only when the refund includes returns.

No

TotalGiftCardsRefundAmountinMerchantCurrency

Decimal

The total refund amount in merchant currency is used for this order’s payment.

No