Skip to main content
GET
Getnetworkoverview

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

X-Eposn-Customer-Token
string | null
X-Eposn-Merchant-Token
string | null

Query Parameters

programId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

cardId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Response

Successful Response

totalMerchants
integer
required
totalCards
integer
required
totalTransactionVolume
string
required
activeCards
integer
required
totalTransactions
integer
required
merchantBreakdowns
MerchantCardStats · object[]
required
salesGrowth
string | null
salesGrowthType
string | null
merchantGrowth
string | null
merchantGrowthType
string | null
cardGrowth
string | null
cardGrowthType
string | null
txGrowth
string | null
txGrowthType
string | null
adoptionData
AdoptionDataPoint · object[]
revenueData
RevenueDataPoint · object[]
breakage
BreakageData · object | null
txFeeRevenue
string | null
ltvUplift
string | null
healthTxSuccessRate
number | null
healthFraudAlerts
integer | null
healthSupportTickets
integer | null