API Overview
Use the environment that matches your key. All request examples in this documentation use sandbox:
| Environment | Base URL | Key prefix |
|---|---|---|
| Sandbox | https://sandbox.payscribe.ng/api/v1 | ps_pk_test_... |
| Production | https://api.payscribe.ng/api/v1 | ps_pk_live_... |
All requests require authentication via Bearer token. See Authentication.
For an interactive endpoint browser and the machine-readable contract, use OpenAPI & API Explorer.
Start here
New to Payscribe? Follow the Quickstart with a sandbox key, then use the reference below while building a product flow. For request patterns, retry behaviour, and production checks, see Sandbox Testing, Webhooks, and Going Live.
Resources
| Resource | Description | |---|---|---| | My Account | Balances, profile, ledger, transactions | | Collections | Virtual accounts, wallet payments, confirm/verify payment | | Transfers | Single & bulk bank transfers, name lookup | | Customers | Create, verify, manage, blacklist customers | | Cards | Issue, top up, freeze, terminate virtual/physical cards | | Bills | Airtime, data, cable TV, electricity, betting, ePins, internet, airtime-to-wallet | | Payment Links | Create, update, delete hosted payment pages | | Invoices | Create, send, manage invoices with webhooks | | KYC | BVN lookup and identity verification | | Savings | Automated savings plan management | | FX | Live rates, quotes, currency conversion | | Stablecoin | USDT/USDC wallet addresses and balances | | Webhooks | Event callbacks, signature verification, retry policy | | Blacklist & Misc | Blacklist management, service lookup | | Transaction Report | Reconcilation and transaction reporting | | Pagination | Page-based and cursor-based pagination |
Was this page helpful?