RedeemGiftCard (Global-e to Merchant)

The RedeemGiftCard API sends the amount of the used card balance. This information is saved on your platform.

Add the GiftCardData.RedeemTransactionId for each gift card during this call.

Method/URL

https://www.merchant-site-domain.com/redeem-gift-card-url

Parameters

Request

Name	Type	Description	Mandatory
RedeemGiftCardRequest	Object RedeemGiftCardRequest	Contains information regarding gift card redemption.	Yes

Response

Name	Type	Description	Mandatory
RedeemGiftCardResponse	Object RedeemGiftCardResponse	Provides details about response to API call for gift card redemption.

Objects for RedeemGiftCard API

RefundGiftCardRequest

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects
`ConversionRate`	Decimal	Rate of conversion from gift card currency to customer currency
`MerchantGUID`	String	Merchant unique identifier
`OrderId`	String	Global‑e Order ID
`TotalToRefundInCustomerCurrency`	Decimal	The total value to refund for all gift cards in customer currency
`TotalToRefundInGiftCardCurrency`	Decimal	The total value to refund for all gift cards in gift card currency

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)

RedeemGiftCardResponse

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects data
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message

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)

Examples

Request

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "ShippingCountryCode": "IL",
    "Cards": [{
            "CardId": 2864,
            "BalanceInGiftCardCurrency": 365.930000,
            "BalanceInCustomerCurrency": 1286.210000,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "ILS",
            "BalanceUsedInCardCurrency": 94.910000,
            "BalanceUsedInCustomerCurrency": 333.590000,
            "CardFields": {
                "CardId": "111111"
            }
        }
    ],
    "OrderId": " GE927127",
    "MerchantCartToken": "cf270ce6b2d4ce6d2d882536b8741a01"
}

Response

{
    "Cards": [{
            "CardId": 2864,
            "BalanceInGiftCardCurrency": 365.93,
            "BalanceInCustomerCurrency": 1286.21,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "ILS",
            "BalanceUsedInCardCurrency": 94.91,
            "BalanceUsedInCustomerCurrency": 333.59,
            "RedeemTransactionId": 2,
            "CardFields": {
                "CardId": "111111"
            }
        }
    ],
    "ErrorCode": null,
    "ErrorText": null
}

Documentation Portal

RedeemGiftCard (Global-e to Merchant)

Parameters

Objects for RedeemGiftCard API

RefundGiftCardRequest

GiftCardData

BaseGiftCard

RedeemGiftCardResponse

GiftCardData

BaseGiftCard

Examples

Search results