harrenapay

Developer docs

Changelog

Documentation and public API notes for merchants.

2026-07-17 — Docs accuracy + code theme

  • Code samples use a dark professional theme with syntax coloring (JSON / cURL / HTTP / Node / PHP).
  • Webhook docs now match the live flat payload (event, reference, amount, currency) and include create/list examples.
  • Public webhook allowlist includes charge.success / charge.failed.
  • Fixed the 10-endpoint cap check on POST /webhooks.

2026-07-17 — Free sandbox API keys

  • hpay_test_… keys can be created from in-app API sandbox without a Business plan (max 3 active).
  • hpay_live_… keys and the Merchant console remain Business-gated.

2026-07-17 — Managed delivery + charge docs

  • Documented POST /delivery/rates, POST /escrow/:reference/delivery/attach, and POST /escrow/:reference/delivery/retry.
  • Documented POST /charge (Idempotency-Key + optional non-escrow path).
  • Retrieve response docs include delivery_mode, delivery_tracking, and dispatch_proof.
  • Dashboard webhook event picker now includes escrow.accepted, escrow.declined, and escrow.delivered (already on the public API).

2026-07-17 — Dispatch proof on deliver

  • POST /escrow/:reference/deliver accepts tracking_number, courier_name, proof_photo_url, notes.
  • Self-managed (default for new initiates) requires tracking + photo; stored in dispatch_proof.
  • initiate accepts delivery_mode (self_managed | managed).

2026-07-17 — Known-buyer checkout

  • /checkout/{reference} requires a HarrenaPay session. Virtual-account details are withheld until the signed-in email matches customer_email from initiate.
  • Claiming checkout sets buyer_user_id so disputes and wallet features can attach to the buyer.

2026-07-17 — Developer docs site

  • Public /developer docs launched for the live merchant API (/api/public/v1).
  • Documented lifecycle as built: statuses + seller_delivered_at + 24h inspection window via auto_release_at.
  • Corrected hosted checkout path to /checkout/{reference} (Vbaas virtual account), not a Paystack hosted page.
  • Merchant console at /merchant for keys, webhooks, and API transactions (Business plan).

Earlier

  • Merchant API key escrow initiate / deliver / release + webhooks.
  • OAuth Connect /me/* wallet APIs (see repo API_REFERENCE.md).