Skip to main content

Documentation Portal

GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory
`BalanceInCustomerCurrency`	Decimal	Total available amount in customer currency
`BalanceInGiftCardCurrency`	Decimal	Total available amount in gift card currency
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`BalanceUsedInCustomerCurrency`	Decimal	Amount to redeem in gift user currency
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`CardId`	Decimal	id of the card in the DB table on the Global‑e side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of the error	No
`ErrorText`	String	Error message	No
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	The refund status. TRUE - Refund was successfully applied to the gift card FALSE - Refund failed or there is no refund on the card
`RedeemTransactionId`	String	The value that is set as a result of card redemption (should be provided by the platform)
`RefundedBalanceInCustomerCurrency`	Decimal	The amount of refunded money in customer currency
`RefundedBalanceInGiftCardCurrency`	Decimal	The amount of refunded money in gift card currency

BaseGiftCard

The CardData model is used for most calls where multiple cards are passed.

Parameter Name	Type	Description
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`CardFields`	Dictionary<String,String>	The Value of each field is defined in the configuration. Key – defined field name Value – user input data
`CardHash`	String	Unique hash generated for each card
`CardId`	Long	ID of card in DB table on Global-e CORE side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of error which should be set during Redeem and Refund calls
`ErrorText`	String	Text of error message
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	True if the refund is successful False if the refund fails If there is no refund on the card it should be NULL
`RedeemTransactionId`	String	Value which is set as a result of card redemption
`RefundedBalanceInCustomerCurrency`	Decimal	Amount of refunded money in customer currency (should be set in refund API call)
`RefundedBalanceInGiftCardCurrency`	Decimal	Amount of refunded money in gift card currency (should be set in refund API call)

Would you like to provide feedback? Just click here to suggest edits.