Stack Developers

Appearance

Return to top
On this page

Giftcard Rewards

This service allows you to generate any of the Giftcard Rewards available in our catalog, through our API, inside of your application or, send a Giftcard Reward to a recepient, through our API.

There are two steps to generating a Giftcard Reward:

  • Getting a list of rewards in the catalog.
  • Confirming the reward and amount.

There are two methods of delivery for Giftcard Rewards:

  • Via Email
  • Via API response

Via Email

When this option is selected, we will send an email to the email address that you have provided in the request, with instructions on how to redeem the reward.

Via API response

This option is important if you plan to add Giftcard Rewards as a part of your application and want to build out a custom redemption flow. The details of the Giftcard Reward will be returned via API response.

WARNING

We may enable / disable different redemption options based on the usecase mentioned during your program creation.

GET Catalog

This lets you get a list of Giftcard Rewards that are available in a specific country. The default country is US ( for any other country, please contact support)

Endpoint

{BASE_URL}/rewards/catalog

Method: GET.

Sample Request 

curl --location --request GET 'https://api.stack-ft.com/rewards/catalog' \
--header 'Authorization: API_KEY' \
--header 'Content-Type: application/json' \

Sample Successful Response

json
{
    "status": "success",
    "request_id": "d90ddcef-bec0-485d-9add-4c34017e8103",
    "catalog": [
        {
            "rewards_id": 27234,
            "rewards_name": "Lowes eGift Voucher",
            "description": "Lowe's is one of the nation's leading home improvement retailers, has more than 1,725 stores nationwide. Lowe's offers everything from power tools and appliances to lighting and home decor. The Lowe's Gift Card can help start any home project large or small. The Lowe's Gift Card can be used at any Lowe's location or online at lowes.com for any merchandise or service that Lowe's sells. The Lowe's Gift Card has no expiration and no fees; and there's no limit on the number of cards you can use online or in the store",
            "terms": "This is a Lowe’s Gift Card and is valid in US only. This is not a credit/debit card and has no implied warranties. This card is not redeemable for cash unless required by law and cannot be used to make payments on any charge account or used to purchase any other retailer or third party gift card. Lowe’s reserves the right to deactivate or reject any Gift Card issued or procured through fraudulent activity. Lost or stolen Gift Cards can only be replaced upon presentation of original sales receipt for any remaining balance. It will be void if altered or defaced. To check your Lowe’s Gift Card balance: visit Lowes.com/GiftCards; call 1-800-560-7172 or see Customer Service Desk at any Lowe’s store. ©2019 Lowe’s. LOWE’S and Gable Mansard Design are registered trademarks of LF, LLC. ",
            "expiration": "24 Months",
            "instructions": "Online: At checkout, provide gift card number and PIN to apply gift card balance to purchase total.In Store: Provide gift card barcode and PIN to cashier at time of purchase to redeem your Lowe's Gift Card",
            "category": "Home & Living,Remote Work",
            "image": "https://res.cloudinary.com/dyyjph6kx/image/upload/gift_vouchers/fGH_ikkpnf.jpg",
            "currency": "USD",
            "value_type": "open_value",
            "max_value": 2000,
            "min_value": 5,
            "delivery_type": "realtime",
            "denominations": "10,25,50"
        }
    ]
}

Order ( confirm ) a reward

This is the final step in the rewards aquisition process. Here, you will specify what reward option you are requesting for, the amount, and the delivery method.

Endpoint

{BASE_URL}/rewards/order

Method: POST.

ParameterDescriptionRequiredType
reward_idThe id of the reward option you'll like to orderTrueInteger
amountThe specified amount for the reward option you'll like to order ( 1 = $1)TrueInteger
delivery_methodHow you want the reward to be delivered. 1 = via api, 2 = via email . The API defaults to 2 if nothing is specifiedFalseInteger
delivery_emailEmail address of the recipient of the reward. Only required if the delivery_method is set to 2FalseString

Sample Request 

curl --location --request POST 'https://api.stack-ft.com/rewards/order' \
--header 'Authorization: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reward_id": 27222,
    "amount": 1
}'

Sample Successful Response ( Api delivery )

Assuming you do everything right, the order has been accepted and fulfilled, you should get a similar response:

json
{
    "status": "success",
    "request_id": "507f6644-80a8-43a4-b6e1-44d03657c7d",
    "order_status": "complete",
    "reward:" {
        "reward_id": 27222,
        "reward_code": "ASFD-WERF-URHD-LKUH",
        "reward_pin": "1234",
        "reward_amount": "1",
        "valid_till": "2023-10-02",
        "currency": "USD",
        "reward_type": "codePin"
        }
}