API products

Products below match the API reference tab. Use Sign requests for playground headers. Writes that move money need Idempotency-Key and the matching *:write scope.

Core API

Endpoint	Path
Get wallets	`GET /wallets`
List transactions	`GET /transactions`

Scopes: wallets:read, transactions:read.

Transfers (NGN local)

List banks → Validate account → Local transfer → Get transfer

Step	Endpoint
1	List banks
2	Verify account
3	Local transfer
4	Get transfer

Scopes: transfers:read, transfers:write. Use the accountName from validate on create.

Identity (BVN / NIN)

List products → Validate BVN, look up BVN (full), or look up NIN

Step	Endpoint
1	List products
2	Validate BVN · Look up BVN (full)
3	Verify NIN (basic) · enhanced

Scopes: identity:read, identity:write. Writes need Idempotency-Key. Live keys debit your NGN wallet when the provider answers (including not-found); provider-down errors are refunded. Start: Identity overview

VAS (bill payments + eSIM)

Base: /api/v1/merchant/vas · scopes vas:read, vas:write

Shared

Endpoint	Notes
List billers	`category` = airtime, data, cable, electricity, betting, internet, esim, or all
Get VAS transaction	Poll after purchase

Airtime & data

Endpoint	Network / planId
Purchase airtime	`network` from billers (`MTN`, `AIRTEL`, `GLO`, `NINE_MOBILE`)
Purchase data	Use `plans[].planId` slug (e.g. `mtn_1gb_7d`), not UUID `id`

Cable & electricity (validate first)

Endpoint	Notes
Validate cable	`provider`: DSTV, GOTV, STARTIMES, SHOWMAX
Pay cable TV	After validate
Validate electricity	`planId` slug e.g. `ekedc_prepaid`
Pay electricity	Same slug `planId` from billers

Other VAS

Endpoint	Notes
Fund betting	`provider` from `category=betting`
Pay internet	Plan from billers
Purchase eSIM	`category=esim` → `locationCode` → package UUID `id` (not `packageCode`)

Gift cards

Buy catalog → pricing → order. Sell catalog → pricing → sell order.

Area	Start
Buy	Overview → products / brands / pricing → Create order
Sell	Sell countries → brands → offers → Sell order

Scopes: gift-cards:read, gift-cards:write.

Virtual cards

Create → Get / List → Fund · Freeze · Unfreeze · Withdraw → Close (2-step)

Endpoint	Notes
Create card	Live key often required
Fund / Withdraw	Idempotency-Key
Close → Confirm close	Two-step

Scopes: virtual-cards:read, virtual-cards:write.

Crypto (may be disabled)

If crypto is OFF for your merchant, calls fail until enabled.

Enable / wallets → Quotes → Buy · Sell · Send · Swap → Confirm intent

Start: Crypto overview Scopes: crypto:read, crypto:write. Writes usually need a live key + Idempotency-Key.

Webhooks

Configure HTTPS callbacks in the portal. Verify X-SendPadi-Signature.

Getting started

API basics

API products

API products

Core API

Transfers (NGN local)

Identity (BVN / NIN)

VAS (bill payments + eSIM)

Shared

Airtime & data

Cable & electricity (validate first)

Other VAS

Gift cards

Virtual cards

Crypto (may be disabled)

Webhooks

​API products

​Core API

​Transfers (NGN local)

​Identity (BVN / NIN)

​VAS (bill payments + eSIM)

​Shared

​Airtime & data

​Cable & electricity (validate first)

​Other VAS

​Gift cards

​Virtual cards

​Crypto (may be disabled)

​Webhooks

API products

Core API

Transfers (NGN local)

Identity (BVN / NIN)

VAS (bill payments + eSIM)

Shared

Airtime & data

Cable & electricity (validate first)

Other VAS

Gift cards

Virtual cards

Crypto (may be disabled)

Webhooks