Gift Cards

Getgiftcards

get/v2/giftcards/programs/cards

Request

Query parameters

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

Gift card status enumeration.

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

Headers

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

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 7 revisions of this API.