Skip to content

MojoPay Omni OMNI / Payments API

← All MojoPay APIs

Payments API · v1.0

Filter pages

Introduction Base URL API credentials Integration paths

Overview

Integration quick start 1. Portal setup (one time) Testing mode Portal team roles Collection fees Payout fees Settlement and wallets (portal) 2. Choose your integration path 3. Authenticate (every ~20 minutes) 4. Hosted checkout (minimal happy path) 5. Webhook handler checklist 6. Verify webhook signatures 7. Idempotency and safe retries 8. Integration checklist

Global conventions

Security baseline

Authentication

Errors Error code catalog (v1)

Webhooks (outbound to your server)

API reference

Connect POST Get an access token GET Check sub-account context

Get paid POST Charge a wallet or issue a bank account GET Find a payment by your reference GET Find a payment by id POST Create a browser pay link GET Get a pay link GET Verify any payment by your reference

Bank accounts POST Create customer GET List customers GET Get customer POST Issue customer bank account GET Get customer bank account POST Deactivate customer bank account GET List payments into customer bank account POST Issue merchant standing bank account GET Get merchant standing bank account

Pay out POST Send money GET Find a payout by your reference

Direct debit POST Set up recurring GET Check recurring status POST Cancel recurring POST Charge recurring now GET Check recurring charge status

Subscriptions GET List active subscription plans POST Enroll a subscription GET Get subscription by merchant_reference

Name checks POST Check mobile money name POST Check bank account name

Wallet & lookups GET List bank codes GET List mobile networks GET Check wallet balance

Guide

Endpoint details 8.1 Collection (wallet collection) 8.1b Customers and static virtual accounts 8.2 Checkout session (hosted) 8.3 Unified verify by merchant reference 8.4 Payout (mobile money) 8.5 Payout (bank) 8.6 Verification 8.7 Mandates and mandate debits 8.8 Metadata and balance 8.9 Account context (sub-accounts) 8.10 Subscriptions

Status vocabulary

Rate limits

Appendix A - Changelog

Appendix B - Webhook delivery

Appendix C - Integration resources

Appendix D - Ghana bank code reference

Resources

OpenAPI spec YAML download (opens in new tab) Sample payloads API tester

Wallet & lookups

Check wallet balances and load bank codes / mobile network codes at runtime.

Endpoints

GET List bank codes /v1/metadata/banks
GET List mobile networks /v1/metadata/mobile_providers
GET Check wallet balance /v1/balance

← Previous POST Check bank account name Next → GET List bank codes

© 2026 MojoPay Omni. Omni API v1.0.

OpenAPI spec · YAML · Sample payloads