Skip to main content
GET
Look Up Gift Card Balance

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

authorization
string | null

Path Parameters

programId
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

number
string
required

Printed card number. Exact match.

Required string length: 1 - 20

Response

Successful Response

Printed-number lookup. Balance and status only.

balance
string
required

Decimal string with two places, for example 25.50.

Example:

"25.50"

status
enum<string>
required

Gift card status enumeration.

Available options:
pending,
active,
suspended,
expired,
voided,
depleted