Developer docs

Capability map

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

CapabilityStatusHow
Bank transfer (dedicated virtual account)LivePOST /collections
Hosted checkout pageLivecheckout_url on every collection
Card paymentsOn the roadmap— (chargebacks need handling first)
USSD, NIBSS QR, OPay, eNairaOn the roadmap—
Payment linksLiveMerchant console → Collections
Recurring / e-mandate, tokenisationOn the roadmap—
Preauthorisation (capture / void)On the roadmap—

Payouts

CapabilityStatusHow
Bank transfer out (any Nigerian bank)LivePOST /transfers
Beneficiary registerPartialYour revenue account; a beneficiary API is planned
Bulk transfersOn the roadmap—
Transfer retry, fee query, statusLiveGET /transfers, retry on failure
Cash pickup, wallet-to-walletNot offeredNot part of a Nigeria BaaS product
International, FX, stablecoinsNot offeredNGN only

Money

CapabilityStatusHow
BalancesLiveGET /balances
Revenue account (where money is paid out)LiveGET|PUT /settlement-account
Monthly statements (CSV)LiveGET /statements/{period}
Settlement logsPartialStatements cover it; a settlement log endpoint is planned

Virtual accounts

CapabilityStatusHow
Per-collection accountLiveReturned by POST /collections
Static / permanent accountPartialYour wallet account; a dedicated static account is planned
Bulk account creationOn the roadmap—

Verification

CapabilityStatusHow
BVN consent verificationLivePOST /verifications (type=bvn)
Bank account name enquiryLiveGET /banks/resolve
Business verification (KYB)LivePOST /verifications/kyb
Card BIN checkNot offeredWe do not issue cards

Operations

CapabilityStatusHow
Escrow (hold, deliver, release, dispute)LivePOST /escrow/*
Split payments / commissionLivesplit on escrow creation
RefundsLivePOST /collections/{reference}/refund
Chargebacks (card scheme disputes)On the roadmap—
DisputesLivePOST /me/disputes (Connect) — API-scoped disputes are planned
Managed delivery quotes and bookingLivePOST /delivery/rates, /escrow/{ref}/delivery/*
Bill payments (airtime, data, electricity)On the roadmapThe rail supports it; we are scoping the catalogue and the settlement flow
OTP generation and validationOn the roadmapWe are adding an SMS/OTP provider for phone verification

Developer

CapabilityStatusHow
Webhooks with signature verification and replayLive/webhooks
Sandbox environmentLivehpay_test_ keys
Idempotency on every writeLiveIdempotency-Key header + your reference
Connect (OAuth) for acting on a user's walletLive/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.

HTTP
GET  https://www.harrenapay.com/api/public/v1/capabilities   # (planned) machine-readable version of this table