LivePay API Documentation

Overview

The Transaction Status API allows you to check the status of a specific transaction using your unique reference ID.

Endpoint

https://livepay.me/api/transaction-status

Method: GET

Quick Start

Request Example

Terminal

curl "https://livepay.me/api/transaction-status?accountNumber=LP2305443309&currency=UGX&reference=WITHDRAW123456789" \
  -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)
`reference`	String	Yes	Your unique reference ID

Response Format

Success Response (200 OK)

success.json

{
  "success": true,
  "status": "Pending",
  "message": "N/A",
  "customer_reference": "WITHDRAW123456789",
  "internal_reference": "550e8400-e29b-41d4-a716-446655440000",
  "msisdn": "+256777123456",
  "amount": 50000,
  "currency": "UGX",
  "provider": "MTN",
  "charge": 2000,
  "remote_ip": "192.168.1.100",
  "provider_transaction_id": "N/A",
  "created_at": "2024-01-15 10:30:00",
  "completed_at": "N/A"
}

Error Responses

Status Code	Error Message	Description
400	`accountNumber, currency and reference 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	`Transaction not found`	Transaction with given reference not found
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