Wildfire APIs
Gift Card

28min
There are two different payment methods for the customers to redeem the Cash Back in their account.
PayPal (multiple currencies supported)
Gift Card (USD only at this time)
Gift Card is a payment method where the user who has a redeemable amount greater than 5 USD can receive a gift card of a supported merchant of their choice. Wildfire currently only supports redeeming the full amount available in the user's account. There are three API endpoints:
Get Redeemable Amount
Redeem (create a gift card redemption link)
Get Redemption History
Get Redeemable Amount
The get redeemable amount call will return the balance of a user's account. This is useful for determining if a user is eligible for a Gift Card based on the minimum 5 USD threshold required to redeem.
Endpoint : https://api.wfi.re/v2/giftcard/:device_id/redeemable 
Method : GET
Parameters
device_id (Required): The device id of the user.  Note: If a user has multiple devices, any device ID associated with the user will return the same redeemable amount.
Sample response 
JSON
|
{
  {
    "Amount": "15.00",
    "Currency": "USD"
  }
}
{
  {
    "Amount": "15.00",
    "Currency": "USD"
  }
}
﻿
Amount: Amount available to redeem for the particular user.
Errors
If a request is sent for a device id that isn't associated with the application, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No device found for ID= '76'"
}
{
    "ErrorMessage": "No device found for ID= '76'"
}
﻿
If there is no rewards associated with the sender id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No rewards found for sender ID='123'"
}
{
    "ErrorMessage": "No rewards found for sender ID='123'"
}
﻿
Note that "sender" is a reference to your user ID.  This response denotes that any of the associated devices can be passed into this API but the response is not specific to that device.
If there is no sender id associated with the device id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "no sender associated with device 76"
}
{
    "ErrorMessage": "no sender associated with device 76"
}
﻿
Redeem
This POST call will give all the details of a user along with the URL to redeem the Gift Card and amount available to redeem.
Endpoint: https://api.wfi.re/v2/giftcard
Method: POST
Request Body: 
JSON
|
{
	"deviceID": 9318216
}
{
	"deviceID": 9318216
}
﻿
deviceID (Required): The device ID of a user which may or may not be the same as the one in the previous Get Redeemable Call (a user can have multiple device IDs)
Sample response
JSON
|
{
  {
    "senderID": 278000,
    "url": "https://www.rewardlink.io/r/1/uxmJQsWqZxxLDFGkVci2QGa068MX3x0yQ",
    "amount": "15",
    "currency": "USD",
    "createdDate": "2023-01-10T22:39:50.42Z"
  }
}
{
  {
    "senderID": 278000,
    "url": "https://www.rewardlink.io/r/1/uxmJQsWqZxxLDFGkVci2QGa068MX3x0yQ",
    "amount": "15",
    "currency": "USD",
    "createdDate": "2023-01-10T22:39:50.42Z"
  }
}
﻿
senderID: The ID of the user. Unlike device ID, sender ID is unique to a logged-in user.
url:  Unique URL generated by Wildfire which is a direct link to redeem the newly-generated Gift Card on Reward Link website. This URL should not be shared with anyone. Since there is no additional security around using this URL to redeem, it should be considered the same as cash.
To test the URL one can copy and paste it into any browser to be redirected to the Reward Link redemption website. 
Errors
If a request is made without a device id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "Missing device_id"
}
{
    "ErrorMessage": "Missing device_id"
}
﻿
User account balance should be greater than 5 USD for the user to redeem the gift card. If the user account balance is less than 5 USD the API will respond with the following.
JSON
|
{
    "ErrorMessage": "Redeemable balance is less than $5"
}
{
    "ErrorMessage": "Redeemable balance is less than $5"
}
﻿
If a request is sent for a device id that isn't associated with the application, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No device found for ID= '76'"
}
{
    "ErrorMessage": "No device found for ID= '76'"
}
﻿
If there is no rewards associated with the sender id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No rewards found for sender ID='123'"
}
{
    "ErrorMessage": "No rewards found for sender ID='123'"
}
﻿
If there is no sender id associated with the device id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "no sender associated with device 76"
}
{
    "ErrorMessage": "no sender associated with device 76"
}
﻿
Get Redemption History
The Get Redemption History call returns all the previous redemptions for a given user based on any of their device IDs.
Endpoint: https://api.wfi.re/v2/giftcard?device_id=9318216
Parameters
device_id (Required): Any device ID associated with the user.
Sample response
JSON
|
{
    "Links": [
        {
            "senderID": 274000,
            "url": "https://www.rewardlink.io/r/1/MXVFTvPLbdWccO8-Xzw5PFXemBHVxJBb0gJTPb1006A",
            "amount": "15",
            "currency": "USD",
            "createdDate": "2023-01-10T19:45:36.346516Z"
        },
        {
            "senderID": 274000,
            "url": "https://www.rewardlink.io/r/1/uxmJQsWqZxxLDFGkVci2QGa06YfCvo6f7FQ8MX3x0yQ",
            "amount": "35",
            "currency": "USD",
            "createdDate": "2023-01-10T22:39:50.798193Z"
        }
    ]
}
{
    "Links": [
        {
            "senderID": 274000,
            "url": "https://www.rewardlink.io/r/1/MXVFTvPLbdWccO8-Xzw5PFXemBHVxJBb0gJTPb1006A",
            "amount": "15",
            "currency": "USD",
            "createdDate": "2023-01-10T19:45:36.346516Z"
        },
        {
            "senderID": 274000,
            "url": "https://www.rewardlink.io/r/1/uxmJQsWqZxxLDFGkVci2QGa06YfCvo6f7FQ8MX3x0yQ",
            "amount": "35",
            "currency": "USD",
            "createdDate": "2023-01-10T22:39:50.798193Z"
        }
    ]
}
﻿
senderID: The ID of the user. Unlike device ID, sender ID is unique to a logged-in user.
amount:  Amount redeemed by the user (which is the same as the entire redeemable amount at the time of request for a Gift Card).
url:  Unique URL generated by Wildfire which is direct link to redeem the Gift Card in the Reward Link website.
createdDate: The date which the user requested the Gift Card.
Errors
If a request is made without a device id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "Missing device_id"
}
{
    "ErrorMessage": "Missing device_id"
}
﻿
If the user sends a wrong device id, user will receive below error message
JSON
|
{
    "ErrorMessage": "invalid device id"
}
{
    "ErrorMessage": "invalid device id"
}
﻿
If a request is made with the wrong device id (i.e. a device ID not associated with the application), the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No device found for ID='76'"
}
{
    "ErrorMessage": "No device found for ID='76'"
}
﻿
If there is no redeemable links associated with the sender id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "No links found for sender ID='76'"
}
{
    "ErrorMessage": "No links found for sender ID='76'"
}
﻿
 If there is no sender id associated with the device id, the API will respond with the following.
JSON
|
{
    "ErrorMessage": "no sender associated with device [device app ID]"
}
{
    "ErrorMessage": "no sender associated with device [device app ID]"
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Creating links
Merchants and Domains
Docs powered by
Archbee
TABLE OF CONTENTS
Get Redeemable Amount
Errors
Redeem
Errors
Get Redemption History
Errors