Logo
NexumPay API Documentation

Introduction

Overview of the NexumPay API and its metadata.

v1.0.0
Software
NexumPay - API Documentation
Version
1.0.0

Getting Started

NexumPay provides a secure and seamless API to integrate collections via mobile money into your system. The API is designed for businesses and platforms to initiate collection transactions, check transaction statuses, and manage secure authentication using API tokens.

To use the API, you must first:

  • Download the NexumPay mobile app: http://bit.ly/3IGUPEf
  • Create and activate your Business Wallet inside the app
Live API Base URL: https://nexumpayapi.araknerd.com
This base URL should be prefixed to all endpoints documented below.

Generate Auth Token (Secret)

The Auth Token, also known as the Secret, is generated from the NexumPay mobile app. This token is used once to generate the API key and should be kept secure.

To access it:

  • Open the NexumPay App
  • Go to API Access
  • Tap Generate Secret

Example screenshot:

Screenshot 1
Screenshot 2
Screenshot 3
Screenshot 4

Endpoint: POST /platform/api/generate_auth_token

{
                        "username": "araknerd@example.com",
                        "password": "ab5666",
                        "wallet_address": "B-A2E9-5AA5-4202"
                        }
{
                        "status": "OK",
                        "message": null,
                        "details": {
                            "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
                        }
                        }
API Keys are valid for 120 seconds. You must generate a new key when it expires.

Generate API Key

Endpoint: POST /platform/api/generate_api_key

Headers:

Authorization: Bearer <your_auth_token_from_app>

Request Body:

{
  "wallet_address": "B-A2E9-5AA5-4202"
}

Response Example:

{
  "status": "OK",
  "message": "API Key generated successfully!",
  "details": {
    "api_key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "expiry": "2025-07-22 12:10:19"
  }
}
Important: Use the API Key (not the secret) in the header of every subsequent request like this:
Authorization: Bearer <api_key>

Collection Operations

Instructions to check the transaction status.


Request Payment

Endpoint: POST /platform/api/request_payment

{
  "phone_number": "0771234567",
  "amount": "500",
  "narration": "Test collection",
  "reference": "100000005",
  "call_back_url": "https://webhook.site/10b64683-fed8-4528-a410-a7bc9517c4ac"
}
Parameter Type Required Description Example
phone_number string ✅ Customer phone number 0771234567
amount string ✅ Amount to request "500"
narration string ✅ Transaction purpose "Test collection"
reference string ✅ Unique reference ID "100000005"
call_back_url string ❌ Webhook for status updates https://webhook.site/... 
{
  "status": "OK",
  "message": "Processing request please wait.",
  "details": true
}
Note: The status field will be either "OK" or "Fail". If "Fail", check the message field for the error.

Check Transaction Status

Instructions to check the transaction status.

Endpoint: POST /platform/api/transaction_status

{
  "client_ref": "100000005"
}
{
  "status": "OK",
  "message": "Your transaction status is: SUCCESS",
  "details": {
    "business_name": "My Business Wallet Name",
    "source_mobile": "256704722190",
    "status": "SUCCESS",
    "amount": "550.00",
    "narration": "Test collection",
    "transaction_date": "2025-07-22 07:10:42",
    "internal_ref": "723c56b9-c843-4f90-a6fb-0051f82006c8",
    "client_ref": "100000005",
    "charge": "50.00",
    "trans_type": "COLLECTION"
  }
}
Status values: PENDING, SUCCESS, FAILED

Security Notes

Important security considerations.

  • The Auth Token (Secret) is only used once to get the API Key
  • Keys expire in 120 seconds and must be regenerated
  • Keys expire after 120 seconds
  • All requests are IP and business-validated

Support

If you need help integrating or using the NexumPay API, contact our support team or access resources below.