Sign in
API Reference

Catalog

Browse available gift card products. Branded Cards are fixed-value cards from specific brands. Choice Cards let recipients select their own gift from a curated multi-brand collection. Each card type has its own set of endpoints.

GET /api/v1/catalog/branded-cards

List branded cards

Returns a paginated list of branded gift card products available to your organization.

Required scope

catalog.read

Query parameters

Parameter
Type
Required
Description
search
string
No
Search by product name or brand
category
string
No
Filter by category (e.g. Shopping, Entertainment)
page
integer
No
Page number, default 1
pageSize
integer
No
Results per page, default 20, max 100

Browse all available brands visually in the portal: Brand Catalog

Response fields

Field
Type
Description
productId
string
Pass this value as productId when creating a branded card order
countryCode
string
ISO-3166-1 alpha-3 country code (e.g. USA, GBR); GLOBAL if the card is available in multiple countries; null if not specified
priceType
string
FIXED — select from the prices list; RANGE — any value between prices[0] and prices[1] in priceStep increments
prices
array
For FIXED: the available denominations. For RANGE: [min, max]
priceStep
number
Minimum increment for RANGE products; null for FIXED
GET /api/v1/catalog/branded-cards/{productId}

Get branded card

Retrieves details for a single branded card product.

Required scope

catalog.read

Path parameters

Parameter
Type
Required
Description
productId
string
Yes
The product ID from the list response

Error responses

404
RESOURCE_NOT_FOUND — no branded card found with this ID.
GET /api/v1/catalog/choice-cards

List choice cards

Returns a paginated list of choice card designs available to your organization. Each design includes the balance range that your organization is configured to load onto cards.

Required scope

catalog.read

Query parameters

Parameter
Type
Required
Description
search
string
No
Search by design name
page
integer
No
Page number, default 1
pageSize
integer
No
Results per page, default 20, max 100

Response fields

Field
Type
Description
productId
string
Pass this value as productId when creating a choice card order
priceType
string
Always RANGE for choice cards
prices
array
[min, max] — the allowed balance range per recipient for your organization
priceStep
number
Always 1 — amounts must be whole-dollar increments
GET /api/v1/catalog/choice-cards/{productId}

Get choice card

Retrieves details for a single choice card design including the balance range configured for your organization.

Required scope

catalog.read

Path parameters

Parameter
Type
Required
Description
productId
string
Yes
The product ID from the list response

Error responses

404
RESOURCE_NOT_FOUND — no choice card design found with this ID.