v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Getgiftcards

get/v2/giftcards/programs/{programId}/cards

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

merchant_idstring
Example:5eb7cf5a86d9755df3a6c593
status'pending' | 'active' | 'suspended' | 'expired' | 'voided' | 'depleted'

Gift card status enumeration.

positive_balanceboolean
cardIdstring
Example:5eb7cf5a86d9755df3a6c593
qstring nullable
pageinteger
limitinteger
offsetinteger nullable

Headers

X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/giftcards/programs/{programId}/cards:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}