Request Structure

Sample Request Structure

Here's an example of how to send an API request :

Sample Request (Curl)

Curl

curl --location -g '{baseurl}/api/account/{version}/create' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
}'

Name	Type	Description
baseurl*	string	This is the base URL section for your API request, which can be in staging or production.
token*	string	The token will be the access token generated from your "get access token" API.
unique_reference*	string	unique_reference is a unique reference for your API calls, used for reference purposes and to track each request in the CBA database.
version	string	The API version. The version is currently at v1.

Note: Every request that creates or modifies data must include a unique request reference in the header with a maximum string length of 100 characters.

Request Header

When making an API call, including the appropriate header for a successful API request is essential. Failing to pass the header correctly will result in an error. This header is necessary to authenticate the user making the request.

Header	Description
Authorization	Bearer token supplied to you on request
Request-Reference	When creating or modifying data, ensure that the request header contains a unique reference. The maximum length of the string is 100 characters.

Date Format

When using an API, make sure to use the correct date format as specified in the documentation, such as "YYYY-MM-DD". For example, "2025-01-31" is a valid date format. You can always refer to this page to confirm the required date format for your API request.

Amount Format

When sending a parameter to an API request, use the amount in the smallest currency unit. For example, 100 naira should be passed as 10000 kobo. Our system supports multi-currency.

Optional Fields

For optional fields, pass null as the value or exclude the field from the payload.