v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Getcustomerconsolidatablemerchants

Get list of merchants and their number of active, positive-balance cards for a customer.

get/v2/giftcards/customer/consolidatable-merchants

Query parameters

programIdstring
Example:5eb7cf5a86d9755df3a6c593
cardIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

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

Response

Successful Response

merchantIdstring required
merchantNamestring required
cardCountinteger required
totalBalancestring required

Example response

[
  {
    "merchantId": "5eb7cf5a86d9755df3a6c593"
  }
]