API reference

Merchant API operations for wallet balance, collection, payout, card checkout, status, phone lookup, and bank transfer.

Download the OpenAPI document. It is generated from the same catalog as these pages. The API itself is unversioned.

Wallet

POST /api/acc_balance
Read the organization wallet balance.

Mobile money collections

POST /api/deposit
Ask a customer to approve a mobile-money collection into the wallet.

Mobile money payouts

POST /api/withdraw
Send mobile money from the wallet to a customer.

Visa and Mastercard

POST /api/card/collect
Start a hosted Visa or Mastercard checkout.

Transaction status

POST /api/get_status/{externalReference}
Read the status of a collection, payout, or card payment by your reference.

Transaction history

POST /api/transaction-history
List wallet transactions for one date or a date range.

Recipient lookup

POST /api/msisdn-verification
Look up the registered name for a Ugandan mobile number.

POST /api/verify_msisdn
Older phone-name lookup. Prefer /api/msisdn-verification.

Bank transfers

POST /api/push-to-bank/get-banks
List banks you can pay.

POST /api/push-to-bank/request-bank-transfer
Request a transfer from the wallet to a bank account.

POST /api/push-to-bank/check-bank-transfer-status
Read a bank transfer that belongs to the authenticated organization.

Not available on the public API

• Refunds and reversals. Keep polling status; unfinished work stays PENDING.
• Beneficiary management.
• An Idempotency-Key header. Uniqueness is the external reference.
• Documented rate limits.