Developer docs

Quick reference

Every endpoint, one line each. Base URL: https://www.harrenapay.com/api/public/v1

Generated from the API registry — the same list the AI assistant uses, so it cannot go stale.

Collections (money in)

MethodPathWhat it does
POST/collectionsCreate a collection: returns a bank account to pay into and a checkout URL.
GET/collectionsList your collections (filter with ?status=, search with ?q=).
GET/collections/{reference}Retrieve one collection with its fee split.
POST/chargealiasPOST /collections under its older name. Same behaviour.
GET/charge/{reference}aliasGET /collections/{reference} under its older name. Same behaviour.
POST/collections/{reference}/refundRefund a collection. The customer's money goes back to the customer; the merchant's balance is reversed first.
POST/collections/{reference}/splitSplit a collection between several beneficiaries. Planned — not available yet (a commission split is available at creation).planned

Transfers (money out)

MethodPathWhat it does
POST/transfersPay collected funds to your registered revenue account.
GET/transfersList your transfers, newest first.
GET/transfers/{reference}Retrieve one transfer.
POST/payoutsaliasPOST /transfers under its older name. Same behaviour.
GET/payoutsaliasGET /transfers under its older name. Same behaviour.
GET/payouts/{reference}aliasGET /transfers/{reference} under its older name. Same behaviour.
POST/transfers/bulkPay out to many beneficiaries at once. Planned — not available yet.planned

Money

MethodPathWhat it does
GET/balancesAvailable balance, lifetime collected / paid out / commission, revenue account.
GET/balancealiasGET /balances under its older name. Same behaviour.
GET/settlement-accountThe bank account your money is paid out to, and whether it is verified.
PUT/settlement-accountRegister or replace your revenue account (name-verified against your KYC).
GET/pricingThe fee card, machine readable.
GET/banksThe banks you can pay out to (code + name). Search with ?q=.
GET/banks/resolveName enquiry on a bank account.
POST/verificationsVerify a customer: BVN consent (the customer authorises with their bank) or a bank account name enquiry.
GET/verifications/{id}Read the outcome of a verification.
GET/statements/{period}Monthly statement as CSV (YYYY-MM): collected, fees, paid out, net.

Escrow product

MethodPathWhat it does
POST/escrow/initiateCreate an escrow: seller invitation, release window, optional commission split.
GET/escrow/{reference}Retrieve an escrow, including how the money will be split on release.
POST/escrow/{reference}/deliverMark the order delivered — starts the inspection window.
POST/escrow/{reference}/releaseRelease the funds to the seller who accepted the escrow.
POST/escrow/{reference}/simulate-fundSandbox only: mark a test collection as paid.

Managed delivery

MethodPathWhat it does
POST/delivery/ratesDelivery rates for a pickup, dropoff and parcel.
POST/escrow/{reference}/delivery/attachAttach a delivery rate to an escrow (live keys only).
POST/escrow/{reference}/delivery/retryRetry a failed delivery booking (live keys only).

Developer

MethodPathWhat it does
GET/webhooksList your webhook endpoints.
POST/webhooksRegister a webhook endpoint. The signing secret is returned once.
DELETE/webhooks/{id}Remove a webhook endpoint.
GET/webhooks/deliveriesWebhook delivery log.
POST/webhooks/deliveries/{id}/replayReplay a failed webhook delivery.

Connect (OAuth)

MethodPathWhat it does
GET/oauth/authorizeConsent screen for a third-party app acting on a user's wallet.
POST/oauth/tokenExchange an authorization code (or a refresh token) for tokens.
POST/oauth/revokeRevoke a user's connection to your app.
GET/me/*Act on a user's wallet with their consent (scoped).

New here? Quickstart has a working collection in under five minutes.