LivePay API Documentation

Overview

The Check Balance API allows you to check your wallet balance for a specific currency.

Endpoint

https://livepay.me/api/check-balance

Method: GET

Quick Start

Request Example

Terminal

curl "https://livepay.me/api/check-balance?accountNumber=LP2305443309&currency=UGX" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Your API Key>"

Authentication

All API requests require Bearer token authentication using your API key in the Authorization header.

Headers

Authorization

Bearer <Your API Key>

Content-Type

application/json

API Key Format

Your API key is provided in your dashboard. Use it directly in the Authorization header as shown above.

Query Parameters

Parameter	Type	Required	Description
`accountNumber`	String	Yes	Your account number
`currency`	String	Yes	Currency code (e.g., UGX, USD, KES)

Response Format

Success Response (200 OK)

success.json

{
  "success": true,
  "account_number": "LP2305443309",
  "currency": "UGX",
  "balance": 1500000,
  "status": "active"
}

Error Responses

Status Code	Error Message	Description
400	`accountNumber and currency are required`	Missing required query parameters
401	`Authorization required`	Missing Authorization header
401	`Invalid API key`	Invalid API key format or value
403	`Account number does not match API key owner`	Account number mismatch
404	`Invalid business account`	Account not found
429	`Too many requests. Please try again later.`	Rate limit exceeded (50 per 15 minutes)
500	`Internal server error`	Server error