v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB

Gift Cards

Getnetworkoverview

Returns aggregate statistics across the entire gift card network (all programs and merchants). Intended for network-admin and reporting dashboards.

Groups card counts and transaction volumes by merchant, and returns overall totals.

Status Codes:

get/v2/giftcards/network/overview

programIdstring

Example:5eb7cf5a86d9755df3a6c593

cardIdstring

Example:5eb7cf5a86d9755df3a6c593

X-Eposn-Customer-Tokenstring nullable

X-Eposn-Merchant-Tokenstring nullable

Successful Response

totalMerchantsinteger required

totalCardsinteger required

totalTransactionVolumestring required

activeCardsinteger required

totalTransactionsinteger required

salesGrowthstring nullable

salesGrowthTypestring nullable

merchantGrowthstring nullable

merchantGrowthTypestring nullable

cardGrowthstring nullable

cardGrowthTypestring nullable

txGrowthstring nullable

txGrowthTypestring nullable

txFeeRevenuestring nullable

ltvUpliftstring nullable

healthTxSuccessRatenumber nullable

healthFraudAlertsinteger nullable

healthSupportTicketsinteger nullable

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