We are a merchant of our payment rail, so everything it can do for NGN is on the table. This is what we expose today, what is partly there, and what we are not doing.
If something you need is marked "on the roadmap", say so — we plan the order of the backlog with our partners, and a partner requirement moves things up.
Collections
| Capability | Status | How |
|---|
| Bank transfer (dedicated virtual account) | Live | POST /collections |
| Hosted checkout page | Live | checkout_url on every collection |
| Card payments | On the roadmap | — (chargebacks need handling first) |
| USSD, NIBSS QR, OPay, eNaira | On the roadmap | — |
| Payment links | Live | Merchant console → Collections |
| Recurring / e-mandate, tokenisation | On the roadmap | — |
| Preauthorisation (capture / void) | On the roadmap | — |
Payouts
| Capability | Status | How |
|---|
| Bank transfer out (any Nigerian bank) | Live | POST /transfers |
| Beneficiary register | Partial | Your revenue account; a beneficiary API is planned |
| Bulk transfers | On the roadmap | — |
| Transfer retry, fee query, status | Live | GET /transfers, retry on failure |
| Cash pickup, wallet-to-wallet | Not offered | Not part of a Nigeria BaaS product |
| International, FX, stablecoins | Not offered | NGN only |
Money
| Capability | Status | How |
|---|
| Balances | Live | GET /balances |
| Revenue account (where money is paid out) | Live | GET|PUT /settlement-account |
| Monthly statements (CSV) | Live | GET /statements/{period} |
| Settlement logs | Partial | Statements cover it; a settlement log endpoint is planned |
Virtual accounts
| Capability | Status | How |
|---|
| Per-collection account | Live | Returned by POST /collections |
| Static / permanent account | Partial | Your wallet account; a dedicated static account is planned |
| Bulk account creation | On the roadmap | — |
Verification
| Capability | Status | How |
|---|
| BVN consent verification | Live | POST /verifications (type=bvn) |
| Bank account name enquiry | Live | GET /banks/resolve |
| Business verification (KYB) | Live | POST /verifications/kyb |
| Card BIN check | Not offered | We do not issue cards |
Operations
| Capability | Status | How |
|---|
| Escrow (hold, deliver, release, dispute) | Live | POST /escrow/* |
| Split payments / commission | Live | split on escrow creation |
| Refunds | Live | POST /collections/{reference}/refund |
| Chargebacks (card scheme disputes) | On the roadmap | — |
| Disputes | Live | POST /me/disputes (Connect) — API-scoped disputes are planned |
| Managed delivery quotes and booking | Live | POST /delivery/rates, /escrow/{ref}/delivery/* |
| Bill payments (airtime, data, electricity) | On the roadmap | The rail supports it; we are scoping the catalogue and the settlement flow |
| OTP generation and validation | On the roadmap | We are adding an SMS/OTP provider for phone verification |
Developer
| Capability | Status | How |
|---|
| Webhooks with signature verification and replay | Live | /webhooks |
| Sandbox environment | Live | hpay_test_ keys |
| Idempotency on every write | Live | Idempotency-Key header + your reference |
| Connect (OAuth) for acting on a user's wallet | Live | /oauth/*, /me/* |
What is deliberately not here
- Anything that is not NGN. We are a Nigeria product. International transfers, FX, stablecoins and multi-currency wallets are out.
- Open money movement. The API pays only to a revenue account we have name-verified against your KYC, or to the seller who accepted an escrow. There is no "send money to any account I type" endpoint, and there will not be one.
- Unreviewed card issuance. Cards and chargebacks come with a settlement and dispute surface of their own; we would rather do them properly than quickly.
Everything above is also in the assistant in the corner of this page — ask it "can I pay out to a beneficiary I choose?" and it will answer from the same table. The quick reference has every endpoint we ship today.
GET https://www.harrenapay.com/api/public/v1/capabilities # (planned) machine-readable version of this table