Connect API Documentation

Introduction

The Connect API brings together two production-ready feature sets so partners (agents, platforms, and merchants) can securely move money and reconcile results with minimal integration effort:

Quick integration overview

1. Register — request integration from our onboarding team.

2. Receive credentials — we issue Basic Auth credentials (username + password) for sandbox and production.

3. Implement endpoints — call lookup and transaction endpoints from your backend and expose a Status Check / callback endpoint to receive transaction confirmations.

4. Test — validate flows (lookup, transaction, status) and handle error/edge cases (idempotency, retries, timeouts).

5. Go live — after successful testing we issue production credentials and enable live traffic.

Authentication & security

All API calls require Basic Authentication and must be made over HTTPS (TLS).

Example HTTP header:

GET /v1/bank-accounts/lookup HTTP/1.1
Host: api.example.com
Authorization: Basic {BASE64(username:password)}
Content-Type: application/json

What we expect from you

During the top-up process, we expect your system to provide a Status Check endpoint. This endpoint allows us to verify the status of payments from your side, ensuring reliable reconciliation between systems.

Endpoints (overview)

• Bank Account Lookup — validate and retrieve bank account details by account number.

• Bank Transfer Transaction — initiate an inter-bank transfer .

• Wallet Account Lookup — find wallet accounts by phone number or email.

• Top-Up Transaction — push funds into a wallet.

• Status Check — callback or polling endpoint used for final settlement and reconciliation.

Note

What’s Next?