Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getcarbon.co/llms.txt

Use this file to discover all available pages before exploring further.

1

Get Your API Keys

Before you can start using the Carbon Business API, you need to obtain your API credentials:
  1. Log in to the Carbon Business developer portal
  2. Navigate to the Developer menu (Top right dropdown > Developer)
  3. Generate your CARBON_API_KEY or use an existing one
  4. Contact our integration team to obtain your apikey
You’ll need both keys for authentication: apikey (provided by our team) and x-carbon-key (generated from your dashboard).
2

Make Your First Request

Test your integration with the health check endpoint to ensure everything is working correctly.
curl -X GET https://carbonapistagingsecure.getcarbon.co/baas/api/health_check \
  -H "apikey: YOUR_API_KEY" \
  -H "x-carbon-key: YOUR_CARBON_API_KEY"
Expected Response:
{
  "message": "OK"
}
3

Create Your First Customer

Before creating accounts, you need to create a customer record:
const customer = await fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers', {
  method: 'POST',
  headers: {
    'apikey': 'YOUR_API_KEY',
    'x-carbon-key': 'YOUR_CARBON_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'John',
    last_name: 'Doe',
    email: 'john.doe@example.com',
    phone: '08012345678',
    dob: '1990-01-01',
    gender: 'male',
    street: '123 Main St',
    city: 'Lagos',
    state: 'Lagos',
    country: 'Nigeria',
    bvn: '12345678901',
    nin: '12345678901'
  })
});
4

Create a Virtual Account

Now create a virtual account for your customer:
const account = await fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts', {
  method: 'POST',
  headers: {
    'apikey': 'YOUR_API_KEY',
    'x-carbon-key': 'YOUR_CARBON_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_type: 'static',
    third_party: true,
    customer_id: 'customer-uuid-from-step-3'
  })
});

const accountData = await account.json();
console.log('Virtual account created:', accountData);

​
What’s Next?

Set Up Webhooks

Configure webhook endpoints to receive real-time transaction notifications.

Explore API Reference

Dive deeper into our comprehensive API documentation.

Test Payouts

Learn how to initiate payouts to beneficiary accounts.

Manage Transactions

Understand how to verify and fetch transaction details.