Skip to main content
GET
View Statistics

Overview

Retrieve a summary of your vending activity for the past 7 days, alongside the current account balance and week-over-week comparisons.

Response Fields

object
Current balance of the vending account.
object
Date range covered by the current and previous weeks.
object
Transaction metrics for the current 7-day window.
Each metric object contains:
number or string
The metric value. total_amount.value is a formatted string (₦...); others are numbers.
string
Percentage change vs the previous week (e.g. 12.5%). Present on total_transactions and total_amount.
string
Percentage figure for success or failure rate. Present on successful and failed.
boolean
true when the change or rate represents an improvement (higher volume, higher success rate). Always false for failed.

Example Response

Notes

  • Statistics cover a rolling 7-day window ending today.
  • Monetary amounts are formatted with the Naira symbol ().
  • Trends compare the current 7-day window to the previous 7-day window.
  • Account balance reflects the most recent wallet state.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successfully retrieved statistics

gatewayStatus
string
Example:

"00"

gatewayMessage
string
Example:

"Successfully Processed"

requestReference
string
Example:

"ESzHw13F3Xa93uizdop6"

data
object