Core API

Payouts

Send naira from your withdrawable balance to the settlement account saved in Settings. Test mode rejects withdrawals.

Create a payout

amount is a JSON number of at least 1 with at most 2 decimal places — not a string. Always send an Idempotency-Key. A retry with the same key returns the original payout and never sends money twice.

curl https://api.nerat.app/api/payouts \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: payout-2026-10-18-1" \
  -d '{"amount":5000,"note":"Weekly settlement"}'

Response codes

• 201 — PalmPay accepted the payout
• 202 — NeratPay could not confirm whether PalmPay received it; the payout stays pending and the amount stays held. Retry with the same Idempotency-Key, never a new one.

Wait for transfer.completed before you mark the money as gone. transfer.failed means the amount is available again.

List & get