Skip to main content
GET
Cash voucher details

Authorizations

X-Api-Key
string
header
required

Your API key provided during onboarding. Example c2fb5ae6ea99c37d...

X-Merchant-Id
string
header
required

Your numeric merchant ID. Example 1

Path Parameters

id
integer
required

Response

Cash voucher

id
integer

Atlas cash voucher ID.

Example:

123

label
string

Display label for the voucher.

Example:

"External gift voucher"

description
string | null

Optional note or campaign description for the voucher.

Example:

"Issued by external gift-card platform"

code
string

Customer-facing redemption code. Atlas stores codes in uppercase without whitespace.

Example:

"EXT-ABC123"

value
integer

Voucher value in minor currency units (cents). For example, 5000 means $50.00.

Example:

5000

expires_after
string<date>

Last valid service date for redemption, in ISO 8601 date format. A voucher with expires_after: 2026-12-31 is redeemable on 2026-12-31 and expires on 2027-01-01.

Example:

"2026-12-31"

unique
boolean

Whether the voucher can only be redeemed once. Defaults to true when omitted on create.

Example:

true

status
enum<string>

Computed voucher state. expired wins when expires_after is in the past; redeemed applies to non-expired unique vouchers with a captured redemption; otherwise the voucher is active.

Available options:
active,
expired,
redeemed
Example:

"active"

redemptions_count
integer

Number of redeemed voucher units, excluding fully refunded cash voucher payments.

Example:

0

created_at
integer

Unix epoch timestamp in seconds.

Example:

1781615664

updated_at
integer

Unix epoch timestamp in seconds.

Example:

1781615664