Introduction

Guides

API Reference

Get API Key

Support

Overview

Environments

Postman Collection

Authentication

Errors

Metadata

Pagination

Lecture

Sign Up

Create API Key

Setup Webhooks

Creating Cards

Onboarding

Physical Cards

Virtual Cards

Displaying Sensitive Card Data

Spending Controls

Funding Sources

Real-time Authorizations

Fraud Protection

Authorizations

Transactions

Disputes

Testing

Merchant Categories

Create Customer

Fetches existing customer objects according to query parameters.

Get Customers

Fetches a specific customer object. Provide the customer `_id` and the corresponding object will be returned.

Get Customer

Updates the specific customer by setting the values of the parameters provided. Only provided parameters will be changed.

Update Customer

Generate a document upload URL for a specific customer KYC.

Generate Customer Document URL

Create Funding Source

Get Funding Sources

Fetches a specific funding source object. Provide the source `_id` and the corresponding object will be returned.

Get Funding Source

Updates the specific funding source by setting the values of the parameters provided.

Update Funding Source

Create, map or replace cards for a specific customer.

Create Card

Fetches cards according to query parameters.

Get Cards

Fetches all cards that are mapped to a specific customer according to the query parameters.

Get Customer Cards

Get Card

Send Default PIN for a specific card. Only available for Verve cards at the moment.

Send Default Card PIN

Change PIN for a specific card. Only available for Verve virtual cards at the moment.

Change Card PIN

Enroll 2FA for a specific card. Only available for Verve cards at the moment.

Enroll Card for 2FA

Update Card

This endpoint generates a card token to be used for displaying sensitive card data.

Generate Card Token

Order Cards

Create Account

Fetches existing accounts according to query parameters.

Get Accounts

Fetches a specific account object. Provide the account `_id` and the corresponding object will be returned.

Get Account

Fetches the balance of the specified account.

Get Account Balance

Fetches all transactions of the specified account according to the query parameters.

Get Account Transactions

Gets the list of banks for a given country.

Banks List

Gets the bank account name on a given account.

Name Enquiry

Transfers funds from one account, wallet, or card to another.

Fund Transfer

Get Transfer Status

Returns the exchange rate between two currency pairs. Currently supports `USDNGN` only.

Transfer Rate

Fetches all authorizations for all cards according to the query parameters.

Get Authorizations

Fetches all authorizations for a specific card according to the query parameters.

Get Card Authorizations

Fetches details about a specific authorization using the provided id.

Get Authorization

Update Authorization

Fetches all transactions for all cards according to the query parameters.

Get Transactions

Fetches all transactions for a specific card according to the query parameters.

Get Card Transactions

Fetches details about a specific transaction using the provided id.

Get Transaction

Update Transaction

Creates a dispute for a specific transaction.

Create Dispute

Fetches all disputes according to the query parameters.

Get Disputes

Fetches details about a specific dispute using the provided id.

Get Dispute

Updates a dispute for a specific transaction.

Update Dispute

Funds an account with the specified amount.

Fund Account

Generates a test card which can be mapped to a customer or used to simulate authorisations or balance enquiry.

Generate Test Card

Simulates card enquiry for a specific card.

Balance Enquiry

Simulates different types of authorizations across several merchant categories and channels.

Method	Url
`POST`	/accounts/simulator/fund
`GET`	/cards/simulator/generate
`POST`	/cards/simulator/balance_enqiry
`POST`	/cards/simulator/authorization
`GET`	/cards/simulator/authorization/:id/reversal