Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Getbusinessreports

get/v2/giftcards/programs/{programId}/reports/business

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

cardIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

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

Response

Successful Response

totalCardsinteger required
activeCardsinteger required
pendingCardsinteger required
depletedCardsinteger required
expiredCardsinteger required
voidedCardsinteger required
totalSoldstring required
totalRedeemedstring required
totalBalancestring required
cardsSoldThisMonthinteger required
salesThisMonthstring required