Loading the API reference…

API Reference

The interactive reference needs JavaScript. You can also download the OpenAPI specification.

GET / Check API status
GET /whoami Identify the current key
GET /transactions/tsq/{reference} Query transaction status
GET /accounts List accounts
GET /accounts/main Get the main account
GET /accounts/main/transactions List main account transactions
GET /accounts/{id} Get an account
GET /accounts/{id}/transactions List account transactions
GET /customers List customers
POST /customers/individual Create an individual customer
POST /customers/business Create a business customer
GET /customers/{id} Get a customer
PUT /customers/{id} Update a customer
POST /customers/{id}/photo Upload a customer photo
POST /customers/{id}/identity/verify Verify identity without an OTP
POST /customers/{id}/identity/initiate Start OTP identity verification
POST /customers/{id}/identity/validate Complete OTP identity verification
GET /virtual-accounts List virtual accounts
POST /virtual-accounts/static Create a static virtual account
POST /virtual-accounts/dynamic Create a dynamic virtual account
GET /virtual-accounts/{id} Get a virtual account
GET /virtual-accounts/{id}/transactions List virtual account payments
GET /virtual-accounts/transactions/{id} Get a virtual account payment
GET /virtual-accounts/transactions/reference/{reference} Get a virtual account payment by reference
GET /transfers/banks List banks
POST /transfers/resolve-account Resolve a bank account
POST /transfers/resolve-recipient Resolve a Payinto Tag
POST /transfers/fee Quote a transfer fee
POST /transfers Initiate a transfer
GET /bulk-transfers List bulk transfers
POST /bulk-transfers Create a bulk transfer draft
GET /bulk-transfers/template Download the import template
GET /bulk-transfers/{id} Get a bulk transfer
PATCH /bulk-transfers/{id} Update a bulk transfer draft
DELETE /bulk-transfers/{id} Delete a bulk transfer draft
POST /bulk-transfers/{id}/items Add a recipient
POST /bulk-transfers/{id}/import Import recipients from a file
POST /bulk-transfers/{id}/import/preview Preview an import
POST /bulk-transfers/{id}/duplicate Duplicate a bulk transfer
PATCH /bulk-transfers/items/{itemId} Update a recipient
DELETE /bulk-transfers/items/{itemId} Remove a recipient
POST /bulk-transfers/items/{itemId}/resolve Resolve a recipient
POST /bulk-transfers/{id}/submit Submit a bulk transfer
POST /bulk-transfers/{id}/retry Retry failed recipients
GET /bulk-transfers/{id}/export Export recipients as CSV
GET /scheduled-bulk-transfers List schedules
POST /scheduled-bulk-transfers Create a schedule
GET /scheduled-bulk-transfers/{id} Get a schedule
PATCH /scheduled-bulk-transfers/{id} Update a schedule
GET /scheduled-bulk-transfers/{id}/executions List a schedule's runs
POST /scheduled-bulk-transfers/{id}/pause Pause a schedule
POST /scheduled-bulk-transfers/{id}/resume Resume a schedule
POST /scheduled-bulk-transfers/{id}/cancel Cancel a schedule
GET /vas/services List services
GET /vas/services/{id} Get a service
GET /vas/services/{id}/billers List a service's billers
GET /vas/billers/{id} Get a biller
GET /vas/billers/{id}/products List a biller's products
GET /vas/products/{id} Get a product
POST /vas/verify/cable-tv Validate a smart card
POST /vas/verify/electricity Validate a meter
POST /vas/pay/airtime Buy airtime
POST /vas/pay/data Buy data
POST /vas/pay/cable-tv Pay for cable TV
POST /vas/pay/electricity Pay for electricity
POST /vas/pay/betting Fund a betting account
POST /addons/otps Send an OTP
POST /addons/otps/{reference}/validate Validate an OTP
POST /addons/credit-check Get a credit report
POST /addons/credit-check/fee Quote a credit report fee
POST /addons/bvn-verification Verify a BVN
GET /addons/bvn-verification/fee Get the BVN verification fee