- Introduction
- Terminologies
- Webhooks
- Authentication
- Account
- Transaction
- Transfer
- Invoice
- Refunds
- Notifications
- Merchant
- Admin
Create Bulk Accounts
POST
/accounts
Query Parameters#
| Field Name | Type | Required | Description |
|---|---|---|---|
| callback | string | true | The endpoint where the generated account numbers will be sent. |
Request Body#
| Field Name | Data Type | Required | Description |
|---|---|---|---|
groupCode | string | true | A unique code used to group the accounts being created. |
accounts | array | true | An array of account objects to be created. |
accounts array must include:| Field Name | Data Type | Required | Description |
|---|---|---|---|
name | string | true | The name of the account. |
accountID | string | true | The unique identifier (account number) for the account. |
bvn | string | true | The Bank Verification Number (BVN) for the account. |
Response Body#
| Field Name | Data Type | Required | Description |
|---|---|---|---|
id | integer | true | A unique identifier for the bulk account creation operation. |
processedStatus | string | true | The processing status of the bulk operation (e.g., "SUBMITTED"). |
createdDate | string | true | The timestamp when the bulk creation request was processed. |
Callback Payload (PUT)#
| Field Name | Type | Description |
|---|---|---|
| id | Integer | Unique identifier for the sub-ledger account. |
| subLedgerID | String | A unique identifier assigned to the sub-ledger. |
| externalID | String | An external reference ID associated with the sub-ledger. |
| name | String | The name of the sub-ledger account, typically including the entity or individual it belongs to. |
| subLedgerGroupCode | String | A code representing the group to which the sub-ledger belongs. |
| isBlocked | Boolean | Indicates whether the sub-ledger account is blocked from transactions (true for blocked, false for active). |
| blockAmount | Integer | The amount that is currently blocked or restricted within the sub-ledger. |
| isMainLedger | Boolean | Specifies whether the account is a main ledger (true) or a sub-ledger (false). |
| savingsAccountNoID | Integer | The identifier for the associated savings account, if applicable. |
| created_date | Integer | The timestamp (in milliseconds) indicating when the sub-ledger was created. |
| bvn | String | The Bank Verification Number (BVN) linked to the sub-ledger account. |
| new | Boolean | Indicates if the sub-ledger is newly created (true) or existing (false). |
Request
Query Params
Body Params application/json
Example
{
"groupCode": "N4ZBHZB1J2",
"accounts": [
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/accounts?callback=https://webhook.site/73ac8860-f042-4685-b992-61a460484826' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupCode": "N4ZBHZB1J2",
"accounts": [
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
},
{
"name": "Greater Height Primary School",
"accountID": "0812345627",
"bvn": "12356675"
}
]
}'Responses
🟢200Success
application/json
Body
Example
{
"id": 9,
"processedStatus": "SUBMITTED",
"createdDate": "2023-08-31T10:46:00.070+00:00"
}Modified at 2025-04-02 10:13:18