Cash voucher details
Authorizations
Your API key provided during onboarding. Example c2fb5ae6ea99c37d...
Your numeric merchant ID. Example 1
Path Parameters
Response
Cash voucher
Atlas cash voucher ID.
123
Display label for the voucher.
"External gift voucher"
Optional note or campaign description for the voucher.
"Issued by external gift-card platform"
Customer-facing redemption code. Atlas stores codes in uppercase without whitespace.
"EXT-ABC123"
Voucher value in minor currency units (cents). For example, 5000 means $50.00.
5000
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.
"2026-12-31"
Whether the voucher can only be redeemed once. Defaults to true when omitted on create.
true
Outlet IDs where the POS picker shows this voucher. An empty array means all outlets. This setting does not block manual code redemption at other outlets.
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.
active, expired, redeemed "active"
Number of redeemed voucher units, excluding fully refunded cash voucher payments.
0
Unix epoch timestamp in seconds.
1781615664
Unix epoch timestamp in seconds.
1781615664