Become a Merchant

Merchant API

Collect payments from customers and settle payouts to beneficiaries — all via API.

Pay-In API

Accept customer payments

Initiate hosted checkout sessions, verify payment status and receive IPN webhooks on completion.

  • POST /api/initiate-payment
  • GET /api/verify-payment/{trx_id}
  • Sandbox & production keys
Pay-In response
{
  "payment_url": "https://bytepay.online/payment/...",
  "info": {
    "ref_trx": "order_9281",
    "merchant_receives": 4950
  }
}
POST /api/initiate-payout
{
  "withdraw_method_id": 19,
  "currency_code": "NGN",
  "payout_amount": 5000,
  "ref_trx": "settlement_001",
  "beneficiary": {
    "bank_code": "100004",
    "account_number": "0123456789"
  }
}
Pay-Out API

Automated settlements

Send bank transfers to vendors, drivers or any beneficiary. Account names are auto-resolved.

  • XudoPay, Korapay & multi-rail support
  • GET /api/verify-payout/{trx_id}
  • GET /api/payout-methods?currency=NGN

Webhook events

payment.success

Customer payment completed and merchant wallet credited.

payout.success

Payout completed successfully to beneficiary bank.

payout.failed

Payout failed — wallet refunded automatically.

Integration guide

  1. Register as a merchant and complete KYC verification.
  2. Generate API keys (sandbox first, then production).
  3. Implement pay-in checkout redirect and IPN webhook handler.
  4. Add payout endpoints for settlements with beneficiary details.
  5. Go live and monitor transactions in the merchant dashboard.
Full Merchant API Docs