Skip to main content
Hero Light

​
Carbon Business API

Welcome to the Carbon Business API documentation. This API enables businesses to integrate financial services into their applications with ease.

​
Overview

The Carbon Business API enables developers and businesses to integrate financial services into their applications seamlessly. With a feature-rich set of endpoints, you can manage accounts, transactions, payouts, and more.

​
Key Features

Account Management

Create and manage virtual accounts for your customers with dynamic or static account numbers.

Transaction Handling

Retrieve and verify transactions with real-time status updates and comprehensive filtering.

Payouts

Initiate and track payouts to beneficiaries with detailed transaction monitoring.

Banking Services

Resolve account details and fetch comprehensive bank information across Nigeria.

Webhook Notifications

Receive real-time updates on account and transaction events for immediate processing.

Customer Management

Comprehensive customer lifecycle management with KYC and business verification.

​
Getting Started

1

Create Your Account

Sign up for a Carbon Business account and get access to the developer dashboard.
2

Get API Keys

Generate your API keys from the developer portal for both Sandbox and Live environments.
3

Make Your First Request

Start with our quickstart guide to make your first API call and create a virtual account.
4

Set Up Webhooks

Configure webhook endpoints to receive real-time notifications about transactions.

​
Use Cases

Accept payments through virtual accounts, handle refunds, and manage customer transactions seamlessly.
Build digital wallets, payment processing systems, and financial management tools.
Integrate payment collection for subscriptions, handle marketplace transactions, and automate payouts.
Manage multi-party transactions, escrow services, and automated commission distributions.

​
Quick Example

const response = await fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts', {
  method: 'POST',
  headers: {
    'apikey': 'your-api-key',
    'x-carbon-key': 'your-carbon-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_type: 'static',
    third_party: true,
    customer_id: 'customer-uuid'
  })
});

const account = await response.json();
console.log('Account created:', account);

​
API Specifications

Base URL: https://carbonapistagingsecure.getcarbon.co/baas/api (Sandbox)
Authentication: API Key + x-carbon-key headers
Response Format: JSON
Rate Limits: Contact support for current limits

​
Ready to Get Started?

Start Building

Jump into our quickstart guide to create your first virtual account and start processing transactions.

API Reference

Explore our comprehensive API documentation with detailed endpoint specifications.