Developer docs

Charge (legacy name)

POST /charge still works and behaves exactly the same. The current name is /collections.

We renamed the money-in endpoint from /charge to /collections when the API stopped being escrow-shaped. Both names are live, take the same body and return the same response — so an existing integration does not break.

HTTP
POST https://www.harrenapay.com/api/public/v1/collections   # current
POST https://www.harrenapay.com/api/public/v1/charge       # still works

New integrations should use /collections — it is the name the quick reference and the assistant use.

Body

  • reference (1–120) — your idempotency key.
  • amount — positive integer kobo.
  • customer_email — required.
  • customer_name, description, return_url (optional), metadata (optional).
  • escrow — default true; false for a direct collection.
  • release_window_hours — 1–1440, default 168 (escrow only).

Response

JSON
{
  "checkout_url": "https://www.harrenapay.com/checkout/order_4821",
  "account_number": "6185…",
  "bank_name": "Wema Bank",
  "amount_kobo": 2500000,
  "expires_at": "2026-11-12T10:00:00.000Z",
  "reference": "order_4821",
  "charge_id": "uuid",
  "escrow": true,
  "collection_fee_kobo": 25000,
  "net_settlement_kobo": 2475000,
  "fee_model": "api-v1",
  "settles_to": "merchant_revenue_account"
}

Full collection documentation · migration guide