Developer docs

Retrieve escrow

GET /escrow/:reference — poll status for an escrow you created.

HTTP

GET https://www.harrenapay.com/api/public/v1/escrow/:reference

cURL

curl https://www.harrenapay.com/api/public/v1/escrow/order_4821 \
  -H "Authorization: Bearer hpay_live_…"

200 response (selected fields)

JSON

{
  "id": "uuid",
  "reference": "order_4821",
  "status": "funded",
  "amount_kobo": 2500000,
  "service_fee_kobo": 0,
  "description": "…",
  "seller_email": "seller@example.com",
  "seller_name": "Ada Store",
  "virtual_account_number": "90……",
  "seller_accepted_at": "2026-07-16T10:00:00.000Z",
  "seller_delivered_at": null,
  "release_window_hours": 168,
  "delivery_mode": "self_managed",
  "delivery_tracking": null,
  "dispatch_proof": null,
  "created_at": "…",
  "updated_at": "…"
}

Statuses

Live enum values: pending, awaiting_payment, funded, released, refunded, cancelled, disputed, release_failed.

Delivery is tracked by seller_delivered_at while status may remain funded until release. delivery_mode is self_managed (default) or managed.