Sign in
Find anything...Airtime API
Gift Cards API
Utility Payments API
Gift-cards
Test mode
Test Mode On
Download Open API documentation
Check out our no-code plugin
Gift cards are an awesome way to send and receive value in a digital economy that is fast becoming the future. Reloadly's Gift Card API connects you to over 200 gift card brands and 13000 gift card products that can be used both locally and internationally across 140+ countries.
This enables you to purchase gift cards for both commercial and personal reasons. Some of the data you will need are your access token and the brand details of the gift card.
BASE URL
https://giftcards.reloadly.com
BASE URL SANDBOX
https://giftcards-sandbox.reloadly.com
Reloadly uses access tokens ( or bearer tokens ) to authenticate requests and grant access to our APIs. Access tokens differ across our various products. This means that you can only use an access token generated for the Gift Card service on the Gift Card API, the same goes for other products.
Also, Reloadly has two operating environments - Production which allows you work with live credentials while building real world applications and Sandbox which helps you access our APIs in test mode and simulate real-like scenarios.
Reloadly employs the OAuth 2.0 standard.Note that all API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
To get an access token, first obtain your client id and client secret from the Reloadly dashboard. Remember to toggle between LIVE mode and TEST mode on the dashboard sidebar to select the appropriate client id and client secret.
After selecting the appropriate client credentials for the environment you want to work with, make a POST request with the payload format provided in the code sample section.
Request 
REQUEST BODY SCHEMA: application/json
PAYLOAD DESCRIPTION
audience
string
The product which the access token is to be used for.
Example: https://giftcards.reloadly.com
client_id
string
Your account's client identification number.
Example: qwcLzXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
client_secret
string
Your account's client secret.
Example: 7kscVxQZ32-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
grant_type
string
The access type being specified.
Example: client_credentials
Response
200
401
POST /oauth/token
https://auth.reloadly.com/oauth/token
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
{
"access_token": "eyJraWQiOiJjNGE1ZWU1Zi0xYmE2LTQ1N2UtOTI3Yi1lYzdiODliNzcxZTIiLCJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NzkzIiwiaXNzIjoiaHR0cHM6Ly9yZWxvYWRseS1zYW5kYm94LmF1dGgwLmNvbS8iLCJodHRwczovL3JlbG9hZGx5LmNvbS9zYW5kYm94Ijp0cnVlLCJodHRwczovL3JlbG9hZGx5LmNvbS9wcmVwYWlkVXNlcklkIjoiNjc5MyIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImF1ZCI6Imh0dHBzOi8vZ2lmdGNhcmRzLXNhbmRib3gucmVsb2FkbHkuY29tIiwibmJmIjoxNjU4MDY2NDkxLCJhenAiOiI2NzkzIiwic2NvcGUiOiJkZXZlbG9wZXIiLCJleHAiOjE2NTgxNTI4OTEsImh0dHBzOi8vcmVsb2FkbHkuY29tL2p0aSI6ImIyMmY3MDRmLTJkMWEtNDZjMC1hYjUxLWZkMzAwNWQxNWM0MiIsImlhdCI6MTY1ODA2NjQdjwfbianRpIjoiMWM1ZmY5YTItNzJhMC00ZDg2LWFjZmYtZmU1NDMxNGU0OGQ4In0.P3f-eNbrjFuGHuDKNGjskzifPARaJPRMVS4gGisp0ZA",
"scope": "developer",
"expires_in": 5184000,
"token_type": "Bearer"
}
The Balance feature lets you view the details of your account balance in real time while using the gift card product. Informaton provided by the Balance feature includes an account's balance, the currency name and denomination fo the account, and the last time funds were used from the account.
Retrieve the details of your account's balance.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/accounts/balance
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
{
"balance": 6000,
"currencyCode": "USD",
"currencyName": "US Dollar",
"updatedAt": "2022-02-04 17:45:51"
}
The Categories feature lets you get details on the different groups gift cards are divided into.
Data included in the details are the category id and name. The category's id serves as a personal identifier for each category with which the gift card products can be filtered by.
Retrieve the details of every gift card category.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/product-categories
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"id": 1,
"name": "Finance"
},
{
"id": 2,
"name": "Software"
},
{},
{}
]
The GiftCards Countries feature lets you get details on countries where gift card orders can be made to.
Data included in the details are the country's name, currency code, currency name, currency symbol, country's flag, and calling code. The country's ISO code which is a two-letter country code that serves as a personal identifier for each country is also included.
Retrieve the details of every country where a gift card order can be made.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/countries
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"isoName": "AF",
"name": "Afghanistan",
"continent": "Asia",
"currencyCode": "AFN",
"currencyName": "Afghan Afghani",
"currencySymbol": "؋",
"flag": "https://s3.amazonaws.com/rld-flags/af.svg",
"callingCodes": [
"+93"
]
},
{},
{}
]
Retrieve the details of a country by making a request with its ISO code.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
countrycode
requiredString
The country's ISO Code.
Example: US
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/countries/{countrycode}
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"isoName": "AG",
"name": "Antigua and Barbuda",
"continent": "North America",
"currencyCode": "XCD",
"currencyName": "East Caribbean Dollar",
"currencySymbol": "XCD",
"flag": "https://s3.amazonaws.com/rld-flags/ag.svg",
"callingCodes": [
"+1268"
]
}
]
The data on Products provides useful insight into the gift card products that can be purchased via Reloadly's platform. Using the Products feature, you can access details of over 200 gift card products and make purchases as well.
Some of the information included in the product's details are the product's name, denomination type, discount rate, fixed amounts where applicable, country's details, and brand details attached to the product. The FX rate the gift card is purchased at is calculated against the currency of the account making the purchase.
Retrieve the details of every gift card product that can be purchased on Reloadly. Note that a gift card product may have one or more brands attached to it. For example, an Amazon gift card product may have Amazon UK and Amazon US as two brands attached to the Amazon product.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
QUERY PARAMETERS
size
Integer
This indicates the number of gift card products to be retrieved on a page.
Example: 10
page
Integer
This indicates the page of the product list being retrieved.
Example: 1
productName
String
Indicates the name of the gift card product.
Example: Amazon
countryCode
String
Indicates the ISO code of the country whose gift card products are to be retrieved.
Example: US
productCategoryId
String
Indicates the unique identifier of the category.
Example: 2
includeRange
Boolean
Indicates the list of gift card products with the denominationType property specified as RANGE are to be retrieved.
Example: true
includeFixed
Boolean
Indicates the list of gift card products with the denominationType property specified as FIXED are to be retrieved.
Example: true
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/products
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"productId": 1,
"productName": "1-800-PetSupplies",
"global": false,
"supportsPreOrder": false,
"status": "ACTIVE",
"senderFee": 205.29,
"senderFeePercentage": 1,
"discountPercentage": 7.5,
"denominationType": "FIXED",
"recipientCurrencyCode": "USD",
"minRecipientDenomination": null,
"maxrecipientDenomination": null,
"senderCurrencyCode": "NGN",
"minSenderDenomination": null,
"maxSenderDenomination": null,
"fixedRecipientDenominations": [
25,
50
],
"fixedSenderDenominations": [
10264.5,
20529
],
"fixedRecipientToSenderDenominationsMap": [
{
"25.00": 10264.5
},
{
"50.00": 20529
}
],
"logoUrls": [
"https://cdn.reloadly.com/giftcards/5daa2b8b-b1ad-4ca6-a34d-a7ce3c14dfaf.jpg"
],
"brand": {
"brandId": 1,
"brandName": "1-800-PetSupplies"
},
"category": {
"id": 5,
"name": "Fashion and Retails"
},
"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."
},
"additionalRequirements": {
"userIdRequired": false
}
},
{},
{}
]
Retrieve the details of a giftcard product by making a request with the gift card product's identification number.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
productid
requiredInteger
The product's identification number.
Example: 5
Response
200
400
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/products/{productid}
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
400
401
404
{
"productId": 1,
"productName": "1-800-PetSupplies",
"global": false,
"senderFee": 205.29,
"senderFeePercentage": 1,
"status": "ACTIVE",
"discountPercentage": 7.5,
"denominationType": "FIXED",
"recipientCurrencyCode": "USD",
"minRecipientDenomination": null,
"maxrecipientDenomination": null,
"senderCurrencyCode": "NGN",
"minSenderDenomination": null,
"maxSenderDenomination": null,
"fixedRecipientDenominations": [
25,
50
],
"fixedSenderDenominations": [
10264.5,
20529
],
"fixedRecipientToSenderDenominationsMap": [
{
"25.00": 10264.5
},
{
"50.00": 20529
}
],
"logoUrls": [
"https://cdn.reloadly.com/giftcards/5daa2b8b-b1ad-4ca6-a34d-a7ce3c14dfaf.jpg"
],
"brand": {
"brandId": 1,
"brandName": "1-800-PetSupplies"
},
"category": {
"id": 5,
"name": "Fashion and Retails"
},
"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."
},
"additionalRequirements": {
"userIdRequired": false
}
}
Retrieve the details of every giftcard product available to a country by making a request with the country's ISO code.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
countrycode
requiredString
The ISO code of the country you want to display available gift cards for.
Example: US
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/countries/{countrycode}/products
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
{
"productId": 1,
"productName": "1-800-PetSupplies",
"global": false,
"senderFee": 205.29,
"senderFeePercentage": 1,
"status": "ACTIVE",
"discountPercentage": 7.5,
"denominationType": "FIXED",
"recipientCurrencyCode": "USD",
"minRecipientDenomination": null,
"maxrecipientDenomination": null,
"senderCurrencyCode": "NGN",
"minSenderDenomination": null,
"maxSenderDenomination": null,
"fixedRecipientDenominations": [
25,
50
],
"fixedSenderDenominations": [
10264.5,
20529
],
"fixedRecipientToSenderDenominationsMap": [
{
"25.00": 10264.5
},
{
"50.00": 20529
}
],
"logoUrls": [
"https://cdn.reloadly.com/giftcards/5daa2b8b-b1ad-4ca6-a34d-a7ce3c14dfaf.jpg"
],
"brand": {
"brandId": 1,
"brandName": "1-800-PetSupplies"
},
"category": {
"id": 5,
"name": "Fashion and Retails"
},
"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."
},
"additionalRequirements": {
"userIdRequired": false
}
}
The Redeem Instructions feature works with data such as the gift card's brand ID to make instructions on how to redeem a gift card available to end users. With the details of a gift card's redeem instructions, it can be used upon purchase.
Information you can have access to includes summmarised and detailed instructions on how to redeem a purchased gift card.
Retrieve the redeem instruction details of every gift card product that can be purchased via Reloadly.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/redeem-instructions
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"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."
},
{},
{}
]
Retrieve the redeem instruction details of a gift card product by making a request with its product ID.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
productId
requiredInteger
The gift card product's ID.
Example: 4
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/products/{productId}/redeem-instructions
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
{
"productId": 3245,
"productName": "Free Fire 210 + 21 Diamond IN",
"concise": "Redeem the Free Fire code online at https://shop.garena.sg/app",
"verbose": "Only Player ID & Nickname is needed for Garena Free Fire Diamonds top-up. You may stay logged in throughout the transaction, once the top-up is completed, you will receive the Diamonds in your Garena Free Fire account. Please enter your Player ID & Nickname correctly to avoid delay on Diamonds top-up. Follow these simple steps to get your diamonds by redeeming the Free Fire code online: https://shop.garena.sg/app -Select Free Fire -Log into your account either through linked social media or by entering your Player ID. -Select Garena Voucher -Enter the code you received from us. -The diamonds will then be visible in your Free Fire account."
}
Gift Cards FX Rates provide details on the exchange rate of a product at which an order purchase will be made. This is helpful for the following use cases
denominationType is RANGE.Retrieve the foreign exchange rate details of a product by making a request with its product ID.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
QUERY PARAMETERS
currencyCode
String
This indicates the code of the currency for which the fx-rate will be fetched.
Example: USD
amount
String
Indicates the amount to convert using the fx-rate.
Example: 94.99
Response
200
400
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/fx-rate
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
400
401
404
{
"senderCurrency": "EUR",
"senderAmount": 88.50978,
"recipientCurrency": "USD",
"recipientAmount": 94.99
}
Information on gift card discounts can be handy when trying to figure out the best deals before purchasing a gift card. The GiftCard Discounts feature gives you access to every gift card offering a discount at the point of purchase.
Important data in the details of each discount include the discount percentage and details of the gift card product that's offering the discount.
Retrieve the details of all available discounts on gift card products that can be purchased on Reloadly.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
QUERY PARAMETERS
size
Integer
Indicates the number of gift card products offering discounts to be retrieved on a page.
Example: 50
page
Integer
Indicates the page of the list of gift card products offering discounts.
Example: 2
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/discounts
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"product": {
"productId": 28,
"productName": "Apple Music 12 month Canada",
"countryCode": "CA",
"global": false
},
"discountPercentage": 2
},
{},
{}
]
Retrieve the discount details of a giftcard product by making a request with the product's identification number.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
productId
requiredInteger
The product's identification number.
Example: 5
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/products/{productId}/discounts
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
{
"product": {
"productId": 28,
"productName": "Apple Music 12 month Canada",
"countryCode": "CA",
"global": false
},
"discountPercentage": 2
}
The GiftCard Transactions feature is a ledger that enables you to access information on every gift card purchased by an account. Every gift card is assigned a unique transaction ID upon purchase and can have one of the following statuses
| Status | Summary |
|---|---|
| SUCCESSFUL | The gift card was successfully purchased. |
| PENDING | An order was placed for the gift card but it is queued up and yet to be processed. |
| PROCESSING | An order for the gift card was placed but it is still processing. |
| REFUNDED | An attempt to purchase the gift card wasn't successful and the customer's funds were instantly reversed. |
| FAILED | The gift card could not be purchased at the time the transaction was attempted and the customer's funds are yet to be reversed. |
Retrieve information on all gift card transactions made on an account.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
QUERY PARAMETERS
size
Integer
This indicates the number of transactions to be retrieved on a page.
Example: 10
page
Integer
This indicates the page of the transactions list being retrieved.
Example: 1
customIdentifier
String
This is the unique reference assigned to the gift card order before it was purchased.
Example: obucks10
startDate
String
Indicates the start date for the range of transactions to be retrieved.
Example: 2021-06-01 10:00:00
endDate
String
Indicates the end date for the range of transactions to be retrieved.
Example: 2021-07-20 19:17:02
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/reports/transactions
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"transactionId": 1,
"amount": 60553.3575,
"discount": 0,
"currencyCode": "NGN",
"fee": 1880,
"customIdentifier": "obucks3",
"status": "SUCCESSFUL",
"product": {
"productId": 4,
"productName": "Amazon Spain",
"countryCode": "ES",
"quantity": 5,
"unitPrice": 25,
"totalPrice": 125,
"currencyCode": "EUR",
"brand": {
"brandId": 2,
"brandName": "Amazon"
}
},
"smsFee": 185.76,
"totalFee": 2065.76,
"receipientPhone": 34012345678,
"recipientEmail": "johndoe@gmail.com",
"transactionCreatedTime": "2022-02-28 13:46:00",
"preOrdered": false,
"balanceInfo": {
"oldBalance": 60582.23641,
"newBalance": 28.86891,
"cost": 60553.3575,
"currencyCode": "NGN",
"currencyName": "Nigerian Naira",
"updatedAt": "2022-02-28 13:46:00"
}
},
{},
{}
]
Retrieve information on a gift card transaction by making a request with its transaction identification number.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
transactionId
requiredString
Indicates the identification number of the transaction to be retrieved.
Example: 2
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/reports/transactions/{transactionId}
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
[
{
"transactionId": 1,
"amount": 60553.3575,
"discount": 0,
"currencyCode": "NGN",
"fee": 1880,
"customIdentifier": "obucks3",
"status": "SUCCESSFUL",
"product": {
"productId": 4,
"productName": "Amazon Spain",
"countryCode": "ES",
"quantity": 5,
"unitPrice": 25,
"totalPrice": 125,
"currencyCode": "EUR",
"brand": {
"brandId": 2,
"brandName": "Amazon"
}
},
"smsFee": 185.76,
"totalFee": 2065.76,
"receipientPhone": 34012345678,
"recipientEmail": "johndoe@gmail.com",
"transactionCreatedTime": "2022-02-28 13:46:00",
"preOrdered": false,
"balanceInfo": {
"oldBalance": 60582.23641,
"newBalance": 28.86891,
"cost": 60553.3575,
"currencyCode": "NGN",
"currencyName": "Nigerian Naira",
"updatedAt": "2022-02-28 13:46:00"
}
}
]
The Orders feature works with other features to purchase a gift card. With this, you can place orders for both local and international (global) gift cards.
Some of the information you can view includes the transaction ID, the custom identifier for each gift card purchase, the discount offered on each gift card, each top-up, and the brand details of the gift card.
Order a gift card product by making a request with its details.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
REQUEST BODY SCHEMA: application/json
PAYLOAD DESCRIPTION
customIdentifier
string
This is a unique reference assigned to a gift card order before it is purchased.
Ensure you change the sample custom identifier in the payload before making a request so as to avoid any errors.
Example: obucks10
preOrder
boolean
Set it to true if your users want to pre-order the gift card. If you omit this parameter, it will default to false
Example: false
productAdditionalRequirements
object
This optional object allows the passage of additional information that may be required for some products.
userId
string
The unique identifier for the user purchasing the giftcard. Only applicable to certain products.
Example: 12
productId
requiredinteger
This indicates the product identification number of the gift card to be purchased/ordered.
Example: 10
quantity
requiredinteger
This indicates the number of gift cards to be ordered.
Example: 2
recipientEmail
string
This indicates the recipient's email for the gift card purchase. If absent, no email will be sent from Reloadly's end.
Example: anyone@email.com
recipientPhoneDetails
object
This is an object that contains details of the recipient's mobile number. It can be used as a second layer of authentication for recipients of gift card purchases.
countryCode
string
This indicates the ISO code of the country where the recipient's mobile number is registered.
Example: ES
phoneNumber
string
This indicates the mobile number of the recipient.Note that the mobile number format must adhere to the standard E.164 numbering plan.
Example: 012345678
senderName
requiredstring
This indicates the name on the gift card receipt upon purchase.
Example: John Doe
unitPrice
requirednumber
This indicates the price of the gift card to be purchased.
Note that this must be specified using a price listed in any of the following sections
1. The fixedRecipientDenominations section of the gift card product's details — for gift cards where denominationType equals FIXED
2. The minRecipientDenominations or maxRecipientDenominations section of the gift card product's details — for gift cards where denominationType equals RANGE.
Example: 5
Response
200
400
401
404
Production URL
Sandbox URL
POST https://giftcards.reloadly.com/orders
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
400
401
404
{
"transactionId": 1,
"amount": 34536.21,
"discount": 1709.72,
"currencyCode": "NGN",
"fee": 1880,
"recipientEmail": "anyone@email.com",
"customIdentifier": "obucks1dime0",
"status": "SUCCESSFUL",
"product": {
"productId": 1,
"productName": "1-800-PetSupplies",
"countryCode": "PS",
"quantity": 1,
"unitPrice": 59.99,
"totalPrice": 59.99,
"currencyCode": "USD",
"brand": {
"brandId": 6,
"brandName": "1-800-PetSupplies"
}
},
"smsFee": 185.76,
"totalFee": 2065.76,
"receipientPhone": 34012345678,
"transactionCreatedTime": "2022-02-28 13:46:00",
"preOrdered": false,
"balanceInfo": {
"oldBalance": 60582.23641,
"newBalance": 28.86891,
"cost": 60553.3575,
"currencyCode": "NGN",
"currencyName": "Nigerian Naira",
"updatedAt": "2022-02-28 13:46:00"
}
}
Retrieve details of a gift card's redeem code after a successful transaction by making a request with the gift card's transaction identification number.
Security BearerToken
HTTP: BearerToken
HTTP Authorization Scheme: bearer
Request
PATH PARAMETERS
transactionId
requiredInteger
Indicates the transaction identification number of the gift card's redeem code to be retrieved.
Example: 2
Response
200
401
404
Production URL
Sandbox URL
GET https://giftcards.reloadly.com/orders/transactions/{transactionId}/cards
REQUEST SAMPLES
cURL
Node
Python
C#
JAVA
Go
PHP
R
Ruby
Swift
RESPONSE SAMPLES
200
401
404
{
"cardNumber": 6120200345149064,
"pinCode": 5821
}