Developer docs

Transfers out

Money you collected, paid out to the bank account you registered. A flat fee per transfer, whatever the amount.

HTTP
POST https://www.harrenapay.com/api/public/v1/transfers

Body

FieldTypeNotes
amount_kobointegerKobo to send. Minimum ₦1,000. A flat payout fee is charged on top.

Example

cURL
curl -X POST https://www.harrenapay.com/api/public/v1/transfers \
  -H "Authorization: Bearer hpay_live_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: payout_2026_11_12" \
  -d '{ "amount_kobo": 1250000 }'

201 response

JSON
{
  "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",
  "destination": "merchant_revenue_account"
}

Where the money goes

The destination is your registered revenue account — it cannot be changed per request. That is deliberate: the API only pays accounts it has name-verified against your KYC, so it can never be used as an open money-mover. Register the account first with PUT /settlement-account.

Rules

  • Live keys only. A sandbox key gets 403 wrong_environment — a test key can never move real money.
  • The transfer comes out of your available_balance_kobo — money you have actually collected. GET /balances shows it.
  • Settlement is confirmed by webhook (payout.completed / payout.failed), not by polling a screen.

Track it

HTTP
GET https://www.harrenapay.com/api/public/v1/transfers              # list
GET https://www.harrenapay.com/api/public/v1/transfers/{reference}  # one