NeratPay API
A number for every customer.
Create dedicated virtual accounts from your server, match deposits the moment they land, and pay out to your settlement bank. Base URL:
https://api.nerat.app/api
(also available under /api/v1).
Authentication
Bearer secret keys. Live and test are separate pairs.
Virtual accounts
Issue one account number per customer via the API.
Webhooks
Signed deposit and payout events to your HTTPS endpoint.
Payouts
Withdraw withdrawable balance to your settlement account.
Quickstart
- Open the dashboard Developers page and copy your test secret key.
- Create a virtual account with an
Idempotency-Keyand your customer’s BVN or NIN. - Simulate a deposit in test mode, then verify the webhook signature before you credit anyone.
- Switch to live keys when KYB is approved and you are ready for real money.
POST
/virtual-accounts
curl https://api.nerat.app/api/virtual-accounts \
-H "Authorization: Bearer sk_test_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 7c9e2a14-6b31-4f08-9d2e-1a0b6c4d8e11" \
-d '{
"customerName": "Amaka Okafor",
"customerEmail": "amaka@example.com",
"customerPhone": "08012345678",
"customerBvn": "12345678901",
"preferredBank": "palmpay",
"customerReference": "user-42"
}'
Call NeratPay only from your server. Never put a secret key or webhook secret in a browser, mobile app, or public repo.