API Workflows

Send Rewards via API

Programmatically send gift card rewards in real time or in bulk from any connected system.

Overview

Common use cases include:

  • Event-triggered rewards
  • Automated incentive distribution
  • Real-time reward delivery
  • System-driven reward fulfillment
  • Integration with apps, platforms, or backend systems

This is the foundational use case that powers all other reward programs.

How the API is Used

  • Trigger rewards programmatically from any system
  • Send rewards instantly or in batches
  • Choose delivery types such as email, SMS, links, or physical shipment
  • Track fulfillment and delivery status

Example Workflow

  • A triggering event occurs such as a user action, system event, or milestone
  • Your system calls the API
  • The reward is processed and fulfilled
  • The gift card is delivered to the recipient

API Integration Flow

API Integration Flow

1
Authenticate
POST /v1/Tokens
2
Retrieve products
GET /v1/Products
3
Send reward
POST /v1/Orders
4
Track status
GET /v1/Orders/{id}or webhook

Example Request

JSON
{
  "Type": "DigitalDelivery",
  "LineItems": [
    {
      "ProductId": "CVS",
      "Value": 20,
      "Quantity": 1,
      "DigitalDeliveryAddress": {
        "Email": "recipient@email.com"
      },
      "Personalization": {
        "To": "Recipient",
        "FromName": "Platform",
        "Message": "You've earned a reward!"
      }
    }
  ],
  "PONumber": "API-11001"
}

Delivery Options

  • DigitalDelivery - Send gift cards via email or SMS
  • Links - Generate claim links for flexible distribution
  • PhysicalShipment - Ship physical gift cards

Benefits

  • Enables real-time reward delivery
  • Integrates with any system or platform
  • Automates fulfillment workflows
  • Supports both individual and bulk rewards

Compliance Considerations

  • Ensure rewards align with program policies
  • Maintain tracking for audit and reporting
  • Validate recipient data before sending rewards

Common Program Types

  • Event-triggered rewards
  • Platform-driven incentives
  • Automated engagement programs
  • System-integrated reward flows

Related Use Cases