Developer docs

Revenue account

Your revenue account is the bank account your money goes to. It is the only account the API can pay out to, and it must be in your name.

Why it matters

Collections are credited to your HarrenaPay balance and then paid out to this account. We never hold your money as our own revenue — the platform earns the collection fee, you keep the rest.

Read the current account

HTTP
GET https://www.harrenapay.com/api/public/v1/settlement-account
JSON
{
  "bank_code": "057",
  "bank_name": "Zenith bank PLC",
  "account_number": "0123456789",
  "account_name": "ADA OBI",
  "provider": "primary",
  "configured": true,
  "name_verified": true,
  "blockers": []
}

Register or replace it

HTTP
PUT https://www.harrenapay.com/api/public/v1/settlement-account
FieldTypeNotes
bank_codestringBank code — see GET /banks.
account_numberstring10-digit account number.
bank_namestringOptional display name.
cURL
curl -X PUT https://www.harrenapay.com/api/public/v1/settlement-account \
  -H "Authorization: Bearer hpay_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_code": "057",
    "account_number": "0123456789"
  }'

We run a name enquiry with the bank and store the name the bank returns, not the one you typed. An account that is not in your name (or your company's name) is rejected — that is what stops the API from being used to pay arbitrary accounts.

Once it is set, payouts can be sent to it.