API referenceOverview

API reference

Endpoints available to every Swappr merchant. No additional gating beyond authentication + permissions.

Resources

  • Payouts — Send money to recipients. Single payouts, list, retrieve, requery, cancel.
  • Batches — Bulk payout creation up to 150 rows per call.
  • Wallets — Multi-currency wallets with balances + ledger history + funding events.
  • Beneficiaries — Saved recipient management with per-currency rail validation.
  • Virtual accounts — Read-only list of merchant-level funding accounts.
  • Name enquiry — Resolve NGN account numbers to bank-of-record names via NUBAN.
  • Webhook endpoints — CRUD for webhook subscriptions + signing secrets.
  • Webhook deliveries — Read-only delivery history with retry attempts.
  • Reports — Aggregated reports in JSON, CSV, or XLSX.
  • Banks — NG bank list with CBN codes.

Base URL

https://api.swappr.me/v1

The same hostname serves both sandbox and live environments. We route based on the API key prefix (sk_test_ vs sk_live_).

Common headers

HeaderRequired forNotes
Authorization: Bearer sk_<env>_<secret>All endpointsSee Authentication
Idempotency-Key: <unique>All POST endpointsSee Idempotency
Content-Type: application/jsonPOST / PATCH with body