Developer docs

Virtual accounts

Every collection gets a dedicated bank account. Your customer transfers into it, we match the incoming credit to your collection by reference.

How it works

  1. You create a collection (POST /collections) and get back an account_number and the bank_name that issued it.
  2. Your customer transfers that exact amount into it. The account is unique to the collection, so the credit is matched automatically — no reference to copy.
  3. When the credit lands you get a webhook (payment.success / charge.success) and the collection moves to funded.

What you get back

JSON
{
  "account_number": "6185834978",
  "bank_name": "Wema Bank",
  "amount_kobo": 2500000,
  "expires_at": "2026-11-12T10:00:00.000Z"
}

The account is issued by a Nigerian bank and expires after 24 hours. bank_name is the bank's own name — always show it to your customer exactly as returned, because their banking app will show the same name.

Hosted checkout

Prefer not to show account details yourself? Send the customer to checkout_url instead — we show them the account, the amount and the reference, and they pay. You get the same webhook either way.

Sandbox

Sandbox keys return a fake account number and never create a real bank account. Complete a test payment with POST /escrow/{reference}/simulate-fund using the same test key — a simulated collection never touches a ledger.