Developer docs
Balances & revenue account
Your money, and the bank account it is paid to.
Balance
GET https://www.harrenapay.com/api/public/v1/balances{
"currency": "NGN",
"available_balance_kobo": 1250000,
"lifetime_collected_kobo": 25000000,
"lifetime_paid_out_kobo": 23750000,
"lifetime_commission_kobo": 1250000,
"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": []
}available_balance_kobo is what you can pay out right now. lifetime_collected_kobo is everything you have collected, lifetime_commission_kobo is what you earned as commission, and lifetime_paid_out_kobo is what has left for your bank. blockers lists anything stopping a payout.
Revenue account
This is the bank account your collected money is paid out to. It is the only destination the API can pay.
GET https://www.harrenapay.com/api/public/v1/settlement-accountcurl -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"
}'| Field | Type | Notes |
|---|---|---|
| bank_code | string | From the bank directory. |
| account_number | string | 10-digit account number. |
| bank_name | string | Optional display name. |
We run a name enquiry with the bank and store the name the bank returns. An account that is not in your (or your company's) name is rejected — see banks for the directory and the resolve endpoint.
Automatic settlement
Merchants on a live plan with a verified revenue account can have collections swept automatically once their balance passes a threshold. Manual transfers always work too.