Developer docs
Build with HarrenaPay
Merchant API for escrow-backed checkout. Hold buyer funds until delivery is confirmed, then release to the seller.
Quickstart
Initiate → fund → deliver → release in under 10 minutes.
Authentication
Bearer API keys (hpay_live_ / hpay_test_).
Escrow API
Create and manage merchant-key escrows.
Webhooks
Signed events for funded, delivered, released, and more.
Base URL
HTTP
https: //www.harrenapay.com/api/public/v1Two integration models
- Merchant API key — e-commerce plugins. Create one-off escrows funded by bank transfer to a virtual account. This docs site focuses here.
- Connect (OAuth) — act on a user’s real wallet via
/me/*. SeeAPI_REFERENCE.mdin the repo for the full OAuth surface.
Lifecycle (merchant key)
POST /escrow/initiate→awaiting_payment+ hosted/checkout/{reference}- Buyer signs in with
customer_email, pays the virtual account →funded+escrow.fundedwebhook - Optional managed delivery: rates → attach → book (live keys)
POST /escrow/:reference/deliver→ sets delivery timestamp; starts the 24h inspection / auto-release clock (self-managed requires dispatch proof)POST /escrow/:reference/release(or auto-release) → funds move to seller +escrow.released
Start free with sandbox keys (hpay_test_…) from Settings → API sandbox. Live keys and the Merchant console require the Business plan — upgrade under Plan & Billing.