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)
| Method | Path | What it does |
|---|---|---|
| POST | /collections | Create a collection: returns a bank account to pay into and a checkout URL. |
| GET | /collections | List your collections (filter with ?status=, search with ?q=). |
| GET | /collections/{reference} | Retrieve one collection with its fee split. |
| POST | /chargealias | POST /collections under its older name. Same behaviour. |
| GET | /charge/{reference}alias | GET /collections/{reference} under its older name. Same behaviour. |
| POST | /collections/{reference}/refund | Refund a collection. The customer's money goes back to the customer; the merchant's balance is reversed first. |
| POST | /collections/{reference}/split | Split a collection between several beneficiaries. Planned — not available yet (a commission split is available at creation).planned |
Transfers (money out)
| Method | Path | What it does |
|---|---|---|
| POST | /transfers | Pay collected funds to your registered revenue account. |
| GET | /transfers | List your transfers, newest first. |
| GET | /transfers/{reference} | Retrieve one transfer. |
| POST | /payoutsalias | POST /transfers under its older name. Same behaviour. |
| GET | /payoutsalias | GET /transfers under its older name. Same behaviour. |
| GET | /payouts/{reference}alias | GET /transfers/{reference} under its older name. Same behaviour. |
| POST | /transfers/bulk | Pay out to many beneficiaries at once. Planned — not available yet.planned |
Money
| Method | Path | What it does |
|---|---|---|
| GET | /balances | Available balance, lifetime collected / paid out / commission, revenue account. |
| GET | /balancealias | GET /balances under its older name. Same behaviour. |
| GET | /settlement-account | The bank account your money is paid out to, and whether it is verified. |
| PUT | /settlement-account | Register or replace your revenue account (name-verified against your KYC). |
| GET | /pricing | The fee card, machine readable. |
| GET | /banks | The banks you can pay out to (code + name). Search with ?q=. |
| GET | /banks/resolve | Name enquiry on a bank account. |
| POST | /verifications | Verify 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
| Method | Path | What it does |
|---|---|---|
| POST | /escrow/initiate | Create 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}/deliver | Mark the order delivered — starts the inspection window. |
| POST | /escrow/{reference}/release | Release the funds to the seller who accepted the escrow. |
| POST | /escrow/{reference}/simulate-fund | Sandbox only: mark a test collection as paid. |
Managed delivery
| Method | Path | What it does |
|---|---|---|
| POST | /delivery/rates | Delivery rates for a pickup, dropoff and parcel. |
| POST | /escrow/{reference}/delivery/attach | Attach a delivery rate to an escrow (live keys only). |
| POST | /escrow/{reference}/delivery/retry | Retry a failed delivery booking (live keys only). |
Developer
| Method | Path | What it does |
|---|---|---|
| GET | /webhooks | List your webhook endpoints. |
| POST | /webhooks | Register a webhook endpoint. The signing secret is returned once. |
| DELETE | /webhooks/{id} | Remove a webhook endpoint. |
| GET | /webhooks/deliveries | Webhook delivery log. |
| POST | /webhooks/deliveries/{id}/replay | Replay a failed webhook delivery. |
Connect (OAuth)
| Method | Path | What it does |
|---|---|---|
| GET | /oauth/authorize | Consent screen for a third-party app acting on a user's wallet. |
| POST | /oauth/token | Exchange an authorization code (or a refresh token) for tokens. |
| POST | /oauth/revoke | Revoke 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.