Request

Parameters

Response

Example Response

Overview

Retrieve a list of customers with pagination support.

Fetch Customers

This endpoint makes an HTTP GET request to retrieve a list of customers with pagination support. It fetches a specified page of customer data with a limit on the number of results per page.

### Request Parameters

- `page` (integer): Specifies the page number to retrieve.
- `limit` (integer): Specifies the maximum number of customers to be included in the response.
    

### Response

Upon a successful request, the server responds with a status code of 200 and a JSON object containing the following fields:

- `status` (string): Indicates the status of the response.
- `message` (string): Provides additional information about the response.
- `data` (array): Contains customer information including their unique identifier, first name, last name, email, phone number, National Identification Number (NIN), Bank Verification Number (BVN), business status, business name, creation and update timestamps.
- `total` (string): Represents the total number of customers available.
    

Example Response:

``` json
{
    "status": "",
    "message": "",
    "data": [
        {
            "id": "",
            "first_name": "",
            "last_name": "",
            "email": "",
            "phone": "",
            "nin": "",
            "bvn": "",
            "is_business": true,
            "business_name": null,
            "mode": "",
            "created_at": "",
            "updated_at": ""
        }
    ],
    "total": ""
}

 ```

apikeyAuth

Replace {{base_url}} with your API base URL (e.g., https://api.example.com)

Customers

Carbon Business API documentation provides all the necessary information to integrate with our platform, including guides, API references, and endpoint examples.

Carbon Business API

Learn about the Carbon Business API, its features, and how it enables seamless integration of financial services into your applications.

Introduction

Get started with the Carbon Business API by generating your API key, making your first request, and exploring the API.

Quickstart

Learn how to authenticate with the Carbon Business API.

Authentication

We use the conventional HTTP response codes to indicate the success or failure of an API request.

Error Handling

Learn how to use the Carbon BaaS SDK for seamless integration via npm.

Node/Javascript

Integrate MCP to enable search functionality for Carbon Business API documentation.

MCP Integration

Create a new customer with detailed information.

Create Customer

Retrieve details of a specific customer by ID.

Fetch Customer

Create a new virtual account for a customer.

Create Account

Retrieve details of a specific account by account number.

Get Account

Retrieve a list of accounts with pagination.

Fetch Accounts

Retrieve the balance of a specific account.

Fetch Balance

Flush the balance of an account to another account.

Flush Account

Initiate a payout to a beneficiary account.

Create Payout

Retrieve the status of a specific payout by reference.

Fetch Payout Status

Retrieve details of a specific payout transaction by reference.

Fetch Payout Transaction

Retrieve transaction details for a specific account and reference.

Verify Transaction

Retrieve a list of transactions for a specific account.

Fetch Transactions

Retrieve a list of banks and financial institutions

Get Banks

Resolve account details using the bank code and account number

Resolve Account

Uptime Monitoring

Retrieve the history of webhook events with pagination.

Webhook Events

Resend a webhook event to the specified endpoint.

Name	In	Type	Required	Description
`x-carbon-key`	Header	`string`	Yes	API key for authentication.
`page`	Query	`integer`	No	Page number for pagination.
`limit`	Query	`integer`	No	Number of customers per page.

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

Fetch Customers

Overview

Request

Parameters

Response

Example Response

Authorizations

Headers

Query Parameters

Response

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

​Overview

​Request

​Parameters

​Response

​Example Response

Authorizations

Headers

Query Parameters

Response

Overview

Request

Parameters

Response

Example Response