Basket

Basket information can be passed through in the API call as part of the redeeming process.  

See Redeeming Documentation 

Four scenarios can occur when passing the basket information through to the Redeeming call. 

  1. One gift card covers the total basket amount. – Scenario 1

  1. Multiple gift cards cover the total basket amount. – Scenario 2 

  1. One gift card partially covers the basket amount, with the balance comprising non-gift card payments. – Scenario 3 

  1. Multiple gift cards partially cover the basket amount, with the balance comprising non-gift card payments. – Scenario 4 

While sending basket information with the redemption request, the following is: 

  • Products are added to the products section individually as an array. 

  • Each request requires the ‘basketIdentifier’ and ‘basketTotalAmount’ fields, uniquely identifying the basket and specifying its total amount. 

  • If the gift card amount is less than the basket total amount, complete the other payments section. 

  • The 'other payments' section is specifically for additional payment methods, not for the gift card amount. 

  • If multiple other payments exist, they should be passed into the 'other payments' section as an array. 

  • If the other payments are unknown during gift card redemption, the different payments section should include ‘paymentMethodName’ as "Other" and the ‘payment amount’ as the difference between the total basket amount and the gift card amount. 

  • Multiple gift card redemptions require multiple calls to the redemption API. Repeat the products and other payments for each gift card call. 

For multiple gift card calls, the response from the first submission will be true and false for subsequent submissions with different gift cards for the same basket information.