Developers REST API
OrbytPay SDK & API
Integrate Nigerian payments with a straightforward REST API — create collections, verify connections, receive signed webhooks, and withdraw to any Nigerian bank. Base URL: https://www.orbytpay.app
Core endpoints
POST /v1/payments— create a hosted checkout link (bank + card)GET /v1/payments/:ref— poll payment statusGET /v1/balance— merchant balance after settlementPOST /v1/withdrawals— payout to a Nigerian bank accountPOST /v1/refunds— refund a credited paymentPOST /v1/connect/verify— confirm your secret key from docs or SDK
Webhooks & ledger
Every merchant event can be delivered as an HMAC-signed webhook — verify x-orbytpay-signature before trusting payloads. Balance movements are recorded on OrbytPay’s hash-chained ledger; your portal and API responses are the authoritative merchant view.
Key events include payment.credited, withdrawal status updates, and refund confirmations. Configure webhook URLs in the merchant portal.
Integration pattern
1. Connect
Sign up, complete KYC, and unlock orbk_sec_ keys. Never embed secrets in mobile apps or browser code.
2. Collect
Create a payment with amount, customer, and optional fee_bearer. Redirect to hosted checkout.
3. Settle
Listen for webhooks or poll until credited. Balance updates only after double-verify.
4. Payout
Resolve bank details, then withdraw. OTP protects sensitive disburse flows.
Flat ₦100 per collection. Default fee_bearer: customer adds ₦100 on top (you receive the full amount). Set merchant when you want the customer to pay exactly the face value and ₦100 comes off your credit. See terms for the ₦50 Kora + ₦50 OrbytPay breakdown.