When working with gift card codes, one very important thing to know is how to use / redeem the gift card. With Reloadly’s Gift Card API, you can access instructions on how to use a gift card. In this guide, you will learn how to view redeem instructions for any gift card you are interested in purchasing. Steps to be taken in this guide are
- Getting your access token
- Viewing the gift card products eligible for use in your country
- Viewing the redeem instructions for the gift card product you want to buy
Viewing the gift card products eligible for use in your country
Let’s say you want to purchase a 1800PetSupplies gift card that can be used in the United States, your first step would be to view a list of gift cards that can be used in the United States. To achieve this, you can make a request to Reloady’s GiftCard API with the United States’ two letter ISO code. The cURL code sample below shows how this is done:
curl -i -X GET \
https://giftcards-sandbox.reloadly.com/countries/US/products \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
When successful, you should have a response similar to the one below
[
{
"productId": 1,
"productName": "1-800-PetSupplies",
"global": false,
"senderFee": 14250,
"discountPercentage": 7.5,
"denominationType": "FIXED",
"recipientCurrencyCode": "USD",
"minRecipientDenomination": null,
"maxRecipientDenomination": null,
"senderCurrencyCode": "NGN",
"minSenderDenomination": null,
"maxSenderDenomination": null,
"fixedRecipientDenominations": [
25,
50
],
"fixedSenderDenominations": [
14250,
28500
],
"fixedRecipientToSenderDenominationsMap": {
"25.00": 14250,
"50.00": 28500
},
"logoUrls": [
"https://cdn.reloadly.com/giftcards/5daa2b8b-b1ad-4ca6-a34d-a7ce3c14dfaf.jpg"
],
"brand": {
"brandId": 1,
"brandName": "1-800-PetSupplies"
},
"country": {
"isoName": "US",
"name": "United States",
"flagUrl": "https://s3.amazonaws.com/rld-flags/us.svg"
},
"redeemInstruction": {
"concise": "This card is redeemable for merchandise on www.1-800-petsupplies.com",
"verbose": "Your acceptance of this eCertificate constitutes your agreement to these terms and conditions. This card is redeemable in U.S. only for merchandise on www.1-800-petsupplies.com . Only two eCertificates are redeemable per order. eCertificates cannot be redeemed for cash, except as required by law. Void if altered or reproduced. This gift card is issued in U.S. funds by Tabcom, LLC. When Redeeming online please be sure to enter the entire gift card number including preceding zeros. The maximum number of eCertificates that can be used for phone is nine. By accepting these Terms and Conditions through your use of this Site, you certify that you reside in the United States and are 18 years of age or older. If you are under the age of 18 but at least 14 years of age you may use this Site only under the supervision of a parent or legal guardian who agrees to be bound by these Terms and Conditions."
}
},
{
"productId": 5,
"productName": "Amazon US",
"global": false,
"senderFee": 285,
"discountPercentage": 0.9,
"denominationType": "FIXED",
"recipientCurrencyCode": "USD",
"minRecipientDenomination": null,
"maxRecipientDenomination": null,
"senderCurrencyCode": "NGN",
"minSenderDenomination": null,
"maxSenderDenomination": null,
"fixedRecipientDenominations": [
5,
10,
15,
20,
25,
50,
100
],
"fixedSenderDenominations": [
2850,
5700,
8550,
11400,
14250,
28500,
57000
],
"fixedRecipientToSenderDenominationsMap": {
"5.00": 2850,
"10.00": 5700,
"15.00": 8550,
"20.00": 11400,
"25.00": 14250,
"50.00": 28500,
"100.00": 57000
},
"logoUrls": [
"https://cdn.reloadly.com/giftcards/3a70931f-2823-4b2c-ab84-8e075134096d.jpg"
],
"brand": {
"brandId": 2,
"brandName": "Amazon"
},
"country": {
"isoName": "US",
"name": "United States",
"flagUrl": "https://s3.amazonaws.com/rld-flags/us.svg"
},
"redeemInstruction": {
"concise": "Visit www.amazon.com/redeem and enter the Claim Code when prompted.",
"verbose": "Amazon.com Gift Cards never expire and can be redeemed towards millions of items at www.amazon.com
To redeem your gift card, follow these steps:
1. Visit www.amazon.com/redeem
2. Enter the Claim Code when prompted.
3. Gift card funds will be applied automatically to eligible orders during the checkout process.
4. You must pay for any remaining balance on your order with another payment method.
Your gift card claim code may also be entered when prompted during checkout. To redeem your gift card using the Amazon.com service, first add the gift card funds to Your Account. If you have questions about redeeming your gift card, please visit www.amazon.com/gc-redeem"
}
}
]
Viewing the redeem instructions for the gift card product you want to buy
The response obtained in the previous section contains details of a 1800PetSupplies gift card that can be used in the United States. For each object in the gift card, a brand property exists that contains the brand identification number of 1800PetSupplies which is established as 1.
A redeemInstruction property also exists that contains redeem instructions for activating a gift card.
To view this redeemInstruction property exclusively, you can make a request to Reloadly’s GiftCard API with the brand ID of the 1800PetSupplies gift card. The cURL code sample below shows how to achieve this:
curl -i -X GET \
https://giftcards-sandbox.reloadly.com/redeem-instructions/1 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
If successful, your response will contain details of how to redeem and utilize the 1800PetSupplies gift card
{
"brandId": 1,
"brandName": "1-800-PetSupplies",
"concise": "This card is redeemable for merchandise on www.1-800-petsupplies.com",
"verbose": "Your acceptance of this eCertificate constitutes your agreement to these terms and conditions. This card is redeemable in U.S. only for merchandise on www.1-800-petsupplies.com . Only two eCertificates are redeemable per order. eCertificates cannot be redeemed for cash, except as required by law. Void if altered or reproduced. This gift card is issued in U.S. funds by Tabcom, LLC. When Redeeming online please be sure to enter the entire gift card number including preceding zeros. The maximum number of eCertificates that can be used for phone is nine. By accepting these Terms and Conditions through your use of this Site, you certify that you reside in the United States and are 18 years of age or older. If you are under the age of 18 but at least 14 years of age you may use this Site only under the supervision of a parent or legal guardian who agrees to be bound by these Terms and Conditions."
}
