Select the option add Gift Card on the basket checkout from the online ordering store.
Enter the Gift Card details and click on "apply gift card"; a call will be triggered to the configured GET Balance webhook URL.
The body of the request will contain the following information matching the data introduced
Gift Card code =
giftCardNumberPIN=
giftCardVerificationCode
Get Balance
{
"giftCardNumber": "61234567",
"giftCardVerificationCode": "123"
}The expected response should contain the giftCardNumber and the amount. The balance amount paid should be sent as an integer with 2 decimal digits, for example, 1 euro would be sent as 100.
Gift Card provider response
{
"giftCardNumber": "61234567",
"amount": 1000
}⚠️
The amount entered manually during online ordering must not exceed the available balance returned in the response
Redeem the gift card value
After the order is checked out, the configured Redeem value webhook URL will be called.
The payload includes the gift card details entered by the user when they applied the gift card.
Redeem value
{
"giftCardNumber": "12547634**06",
"giftCardVerificationCode": "12**",
"amount": 100
}Reverse the gift card redemption
The Reverse redeem webhook URL will be triggered to reverse a gift card redemption when an order that includes a gift card payment is cancelled.