Developer docs

Payouts & balance

Your collected money sits in your HarrenaPay balance. Move it to your revenue account whenever you want — with a flat payout fee.

Balance

HTTP
GET https://www.harrenapay.com/api/public/v1/balance
JSON
{
  "currency": "NGN",
  "available_balance_kobo": 1250000,
  "lifetime_collected_kobo": 25000000,
  "lifetime_paid_out_kobo": 23750000,
  "payout_fee_kobo": 6000,
  "settlement_account": {
    "bank_code": "057",
    "bank_name": "Zenith bank PLC",
    "account_number": "0123456789",
    "account_name": "ADA OBI",
    "configured": true,
    "name_verified": true
  },
  "blockers": []
}

Create a payout

HTTP
POST https://www.harrenapay.com/api/public/v1/payouts
FieldTypeNotes
amount_kobointegerKobo to send. Min ₦1,000. A flat payout fee is charged on top.
cURL
curl -X POST https://www.harrenapay.com/api/public/v1/payouts \
  -H "Authorization: Bearer hpay_live_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: payout_2026_11_12" \
  -d '{ "amount_kobo": 1250000 }'
JSON (201)
{
  "payout": {
    "id": "uuid",
    "reference": "po_m1a2b3c4_d5e6f708",
    "amount_kobo": 1250000,
    "fee_kobo": 6000,
    "total_debited_kobo": 1256000,
    "status": "processing",
    "bank_name": "Zenith bank PLC",
    "account_number": "0123456789"
  },
  "fee_kobo": 6000,
  "fee_model": "api-v1"
}

The destination is your registered revenue account — it cannot be changed per request. Register one before your first payout.

Track payouts

HTTP
GET https://www.harrenapay.com/api/public/v1/payouts
HTTP
GET https://www.harrenapay.com/api/public/v1/payouts/{reference}

You also get a payout.completed (or payout.failed) webhook — see webhooks.