Introduction

API reference

The guides earlier in these docs show you what to build. This section is the full technical reference for Paga’s three APIs: Collect, Business and Connect, with every operation, parameter, response and error code.

Which API do I need?

You want toUseStart with
Collect payments by bank transfer, USSD, Paga Wallet or direct debitCollect APIAccept payments
Give customers permanent account numbers, or hold their fundsCollect APISubsidiary Accounts
Send money to banks or Paga wallets, buy airtime and data, or pay billsBusiness APIMake payments
Charge a customer’s Paga wallet after they authorise your appConnect APIConnect API

Checkout runs on its own hosted page and has its own reference in Checkout.

The three APIs at a glance

Collections

Collect API

Payment requests, dynamic virtual accounts, Subsidiary Accounts, direct debit and refunds.

Authentication: HTTP Basic and a hash header

Operations · Status codes

Payouts

Business API

Money transfer, airtime and data, bill payment, balance and transaction history.

Authentication: principal and credentials headers and a hash

Operations · Error codes

Wallet access

Connect API

Charge a customer’s Paga wallet, send money and read their details, once they’ve authorised your app.

Authentication: OAuth 2.0

Getting started · Operations

Before you start

Get your API keys

Your public key, secret key and hash key are in the business portal. See Get your API keys.

Authenticate requests

Each API authenticates slightly differently. See Authentication.

Whitelist your servers

Every API only accepts requests from registered IP addresses. See IP whitelisting.

Handle errors safely

Look up every non-zero code before acting. See Error handling.

New to Paga? Start with Get started to create your Sandbox and Live accounts.

Need help? We’re here 24/7

Talk to our support team any time, or ask questions in the developer community.