Articles in this section

Gift Card Bonus Programs (Postman Call)

Overview

The Gift Card Bonus Program allows businesses to set up automatic rewards when customers purchase or add value to gift cards over a specified amount. This feature supports tiered rewards (e.g., "buy a card over $50 and get an extra $10 OR buy a card over $100 and get an extra $25"). These programs are popular during the holiday season but can run at any time.

Important Notes

  • A bonus cannot be based on an exact purchase amount (e.g., exactly $50).

  • Bonus value is added to the purchased gift card and cannot be sent as a separate card.

  • Bonuses apply in real-time and cannot be delayed.

  • Only one program can run at a time per client; you must delete an existing program before setting up a new one.

  • The system does not automatically notify customers about the promotion—external communication is required.

Reporting

  • Bonus values appear in the pool report under a designated "Gift Bonus" location.

  • The original purchase record will show in either the Digital Pool or the Physical Pool location report.

How to Set Up a Gift Card Bonus Program

Requesting Setup via Support

Gift Card Bonus Programs must be set up by the Incentivio Support team. To request setup, email support@incentivio.com at least one week in advance with:

  • Start and end dates.

  • Eligible transaction types.

  • Bonus value and tiers.

  • Any additional details to avoid delays.

How to Set Up a Gift Card Bonus Program

  1. Open Postman and log in using integrations@incentivio.com
  2. Check to make sure a program doesn't already exist for this client already (instructions here)
  3. Go to the "Team Workspace" and scroll down to "Real-Time Gift Card Bonus Program"
  4. Select (double click) the "Create Gift Card Bonus Program" POST request
  5. Select "Body," and you should see the fields below that allow you to configure the Bonus Program
  6. Name the program in the "programName" field. For example, "Bonus Program - Pure Burger 2022 Holidays" 
  7. Find the client ID for the client you are setting this program up for through Salesforce, a query, or by looking in any other trustworthy internal doc that contains it. Then copy and paste it between the quotes after "clientID"
  8. Find and paste your Admin ID for that client (can be found by finding your account in the "Users" section of the portal), edit your account, and check the end of the URL
  9. Enter the start and end date in "YYYY-MM-DDT00:00:00" format (e.g. The beginning of the day of November 30, 2022 would read as "2022-11-30T00:00:00". 
    • Please note - The start date can not be a date in the past. 
  10. Select the time zone of the client (see Appendix A at the bottom of the page for commonly used time zones for our clients)
  11. Make sure "Qualifying Transaction Types" only includes transaction types that you want to be eligible for the bonuses. In the example below, if we only want this program to be for buying new gift cards, we delete the line with "ADD_VALUE" and leave the rest. Please make sure that there is a comma between each qualifying transaction type but no comma after the last qualifying transaction type listed
    • PURCHASE_ECARD - new digital gift purchase for self
    • PURCHASE_EMAIL_ECARD - new digital gift purchase and send to a friend 
    • ACTIVATE_CARD - in store gift purchase
    • ADD_VALUE - in store and digital gift add value
  12. Set the tiers of your program. You can set an unlimited amount of tiers, which determine how much extra money gets loaded on the card after the customer spends over $XX.XX. In the example below, we are going to have $10 added if the customer buys a card for over $50, $25 added if the customer buys a card for over $100, and $55 added if the customer buys a card over $200. Make sure there are curly brackets around each tier, with a comma at the end of each set aside from the last set (see example below for context)
  13. The "enabled" field will determine whether this program will automatically start running on its set start date. Type "true" if you want it to start running on the specified start date and "false" if you don't
  14. Make sure you are connected to VPN and click "Send" to set up the program

Untitled_design__7_.gif

 

How to Find Details of a Gift Card Bonus Program

  1. In Postman, under "Real-Time Gift Card Bonus Programs," click the "Get Gift Card Bonus Program by Client" request
  2. Replace the end of the URL with the client ID that you want to find bonus program details. 
  3. Make sure you are connected to VPN and hit "Send" 
  4. View the details of any bonus programs that have already been configured for that client below in the body of the response section.

Untitled_design__8_.gif

 

How to Update a Gift Card Bonus Program

  1. Use the "Get Gift Card Bonus Program by Client" request to find the details of the current bonus program you are trying to update. 
  2. Copy everything in the response aside from the first and last brackets " [ ] " 
  3. In the left side menu, click "Update Gift Card Bonus Program"
  4. Highlight everything in the body (you can click into the body and click Command+A) and paste the details that you copied in the last step
  5. Copy the "Program ID" and paste it at the end of the URL in the Postman request
  6. Change the details you would like to update. Please note- You can't update the program ID, client ID, or start date. 
  7. Make sure you are connected to VPN and click "Send" 

Untitled_design__9_.gif

 

Deleting a Gift Card Bonus Program

  1. Select "Delete Gift Card Bonus Program" and replace the client ID at the end of the URL with the client ID of the client whose program you would like to delete
  2. Make sure you are connected to VPN and click "Send" 

FAQ

Can you have more than one program running at a time?
No. Only one program can run per client at a time. You must delete an active program before creating a new one.

How will customers know about this offer?
The system does not send a message or communication to customers about this promotion. You will need to set up separate messaging or external communication to notify customers.

Does the gift card bonus stack?
No. Bonuses apply per transaction but not cumulatively on a single card. Example:

  • Buy one $50 card → Get $5 bonus (total $55)

  • Buy two $25 cards → Each receives $5 bonus (total $60)

I tried setting up a program but I'm getting a "400 Bad Request" error.

  • Ensure your start date is today or in the future.

  • Double-check your body formatting (e.g., proper commas, brackets, etc.).

  • Make sure the Admin ID matches the Client ID entered.

Can we set expiration dates for the bonus?
No, bonus values do not expire. Consider alternative promotions if expiration is required.

Can we send the bonus to another recipient?
No, bonuses are applied directly to the purchased gift card. If rewarding the purchaser, set up a separate offer requiring account sign-in.

Can we set the bonus card to be distributed later (e.g., 4 hours after purchase)?
No, bonuses apply instantly and cannot be delayed.

Appendix A: Time Zones

Time Zone Value in Request Body
(UTC-4) Atlantic Standard Time America/Halifax
(UTC-5) Eastern Standard Time America/New_York
(UTC-6) Central Standard Time America/Chicago
(UTC-7) Mountain Standard Time America/Phoenix, America/Denver
(UTC-8) Pacific Standard Time America/Los_Angeles
(UTC-10) Hawaii Standard Time Pacific/Honolulu

This guide consolidates all details for setting up and managing a Gift Card Bonus Program efficiently.

Was this article helpful?
0 out of 0 found this helpful