Skip to main content

​
API Introduction

The iQpay Order API enables sponsors and organizations to programmatically create orders and send digital benefit cards to their members.

​
Overview

Once integrated, your organization can:
  • Create orders and deliver digital cards to members via SMS, email, or webhook
  • Authenticate securely using JWT tokens
  • Track transactions with external IDs for reconciliation

​
Base URL

The iQpay API is available in the following environments for integration and testing. Production URL will be shared by the iQpay team during onboarding.

​
Authentication

All API requests (except sign-in) require a valid JWT Bearer token in the Authorization header.
1

Get your credentials

iQpay provides your organization with a username and password during onboarding.
2

Request a token

Call the Sign In endpoint with your credentials to receive a JWT access token.
3

Include the token

Pass the token in the Authorization header of every subsequent request:

​
Integration Flow

1

Program setup

iQpay sets up your program with product codes, program codes, and card configurations.
2

Authenticate

Your system authenticates via the Sign In endpoint to obtain a JWT token.
3

Create orders

Call the Create Order endpoint for each member who should receive a digital card.
4

Card delivery

Cards are delivered to members via SMS/email (by iQpay) or via webhook (by your system).

​
Webhooks

If your program is configured for webhook-based delivery, iQpay sends a payload to your configured endpoint containing the card activation URL and member details. Your webhook must return a 200 status on success. See the Webhooks page for payload details.

​
Error Handling

All error responses follow a consistent format:
Include the traceId when contacting iQpay support to help diagnose issues quickly.