LivePay API Documentation

Overview

The Transactions API allows you to retrieve your complete transaction history, including deposits, withdrawals, and their current statuses. This is essential for reconciliation, reporting, and monitoring your payment activities.

What You Get

Complete transaction history with details including amounts, charges, status, timestamps, and reference IDs for easy tracking and reconciliation.

Quick Start

Request Example

Terminal

curl -X GET "https://livepay.me/api/v1/transactions" \
  -H "Authorization: Bearer <--your-secret-key-->" \
  -H "Content-Type: application/json"

Response Example

JSON Response

{
  "status": "success",
  "user": {
    "firstName": "Kayemba",
    "secondName": "Ronald",
    "username": "kayemba-ronald-OQM5SB"
  },
  "count": 24,
  "transactions": [
    {
      "transactionId": "MP3f123d49c70ab593",
      "referenceId": "6d40a8ec-c75e-43c5-b3ac-17356c34be3e",
      "description": "Payment Request.",
      "amount": 0,
      "chargeAmount": 22.5,
      "phone": "256751936911",
      "method": "DEPOSIT",
      "network": "AIRTEL",
      "status": "Failed",
      "time": "2025-11-04 13:38:49",
      "completedAt": "2025-11-04 05:46:06",
      "balanceNow": 0,
      "balanceAfter": 477.5
    },
    {
      "transactionId": "MP73808dc66015214a",
      "referenceId": "be4c936d-d543-4598-94b8-78b4f5e4932b",
      "amount": 477.5,
      "chargeAmount": 22.5,
      "phone": "256751936911",
      "method": "DEPOSIT",
      "network": "AIRTEL",
      "status": "Success",
      "time": "2025-11-03 13:01:11",
      "completedAt": "2025-11-03 05:02:02",
      "balanceNow": 4197.5,
      "balanceAfter": 4675
    }
  ]
}

Authentication

This endpoint requires Bearer token authentication using your Secret Key in the Authorization header.

Authorization

Bearer <--your-secret-key-->

Content-Type

application/json

Response Fields

Field	Type	Description
`status`	String	Request status (success/error)
`user`	Object	User information object
`user.firstName`	String	User's first name
`user.secondName`	String	User's second name
`user.username`	String	User's unique username
`count`	Integer	Total number of transactions returned
`transactions`	Array	Array of transaction objects

Transaction Fields

Field	Type	Description
`transactionId`	String	LivePay transaction ID
`referenceId`	String	Your reference ID for the transaction
`method`	String	Transaction type (DEPOSIT/WITHDRAW)
`network`	String	Mobile network (AIRTEL/MTN)
`amount`	Number	Transaction amount in UGX
`chargeAmount`	Number	Transaction fee charged
`status`	String	Transaction status (Success/Failed/Pending)
`description`	String	Transaction description
`phone`	String	Phone number used for transaction
`time`	String	Transaction timestamp (YYYY-MM-DD HH:MM:SS)
`completedAt`	String	Completion timestamp
`balanceNow`	Number	Balance before transaction
`balanceAfter`	Number	Balance after transaction

Status Codes & Methods

Transaction Methods

DEPOSIT Incoming

WITHDRAW Outgoing

Transaction Statuses

Success Completed

Failed Error

Pending Processing

Use Cases

Reporting & Analytics

Generate financial reports and analyze payment patterns for business insights.

Reconciliation

Match transactions with internal records using reference IDs for accurate reconciliation.

Important Notes

Recent Transactions Only

This API returns your 100 most recent transactions. For complete historical data, consider implementing pagination or exporting your transaction history from the dashboard.

Real-time Data

Transaction data is updated in real-time. New transactions will appear immediately after they are processed by the system.