Skip to main content
GET

Overview

Retrieve detailed transaction logs for your vending activities. Filter by status, type, network, date range, and search by phone number or transaction ID.

Request

Parameters

Response

string
Status code indicating success (“00”) or error
string
Human-readable status message
string
Unique reference ID for tracking this request
object
Paginated transaction logs

Data Object Fields

number
Total number of pages available
number
Current page number
number
Total number of records matching the filter
string
URL for next page (empty if no next page)
string
URL for previous page (empty if no previous page)
array
Array of transaction log entries

Transaction Log Entry Fields

number
Unique transaction ID
string
External transaction reference
string
Partner reference number
string
Recipient phone number
string
Transaction amount (e.g., “N200.00”)
number
Actual cost charged
number
Commission earned
string
Transaction type (AIRTIME, DATA, ELECTRICITY, CABLETV)
string
Network provider (MTN, GLOBACOM, etc.)
string
Operator name
string
Geographic region
string
Transaction description
string
Data plan product code (for data transactions)
string
Transaction status (SUCCESS, FAILED)
string
Human-readable transaction time
string
Transaction creation timestamp
string
Last update timestamp

Example Response

Notes

  • Use pagination parameters to navigate through large result sets
  • Date filters are inclusive of both start and end dates
  • Search functionality works with partial phone numbers or transaction IDs
  • All timestamps are in UTC format
  • Commission amounts are in Naira
  • Use this endpoint to track transaction history and troubleshoot issues

Authorizations

Authorization
string
header
required

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

Query Parameters

page
number

Page number for pagination

Example:

0

perPage
number

Number of records per page

Example:

1

startdate
string

Start date for filtering (YYYY-MM-DD)

Example:

"2025-09-17"

enddate
string

End date for filtering (YYYY-MM-DD)

Example:

"2025-09-17"

download
boolean

Whether to include download-ready format

Example:

true

status
enum<string>

Transaction status filter

Available options:
success,
failed,
pending,
all
Example:

"success"

network
enum<string>

Network filter

Available options:
MTN,
GLO,
AIRTEL,
9MOBILE,
all
Example:

"mtn"

Search by phone number or transaction ID

Example:

"08107176819"

type
enum<string>

Transaction type filter

Available options:
airtime,
data,
electricity,
cable,
all
Example:

"electricity"

Response

200 - application/json

Successfully retrieved transaction logs

gatewayStatus
string
Example:

"00"

gatewayMessage
string
Example:

"Sucessfully Processed"

requestReference
string
Example:

"iip9r710KslnmtdAgb1w"

data
object