Create Reserved Account

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

RAW_BODY

string

optional

email

string

required

Customer's email address

Default:

test@collect.africa

bvn

string

required

Customer's bvn

Default:

22200000000

account_name

string

required

Reserved account name

Default:

John Doe

phone_number

string

optional

customer's phone number

Default:

+23480000000000

metadata

object

optional

Example

{
    "RAW_BODY": "string",
    "email": "test@collect.africa",
    "bvn": "22200000000",
    "account_name": "John Doe",
    "phone_number": "+23480000000000",
    "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://devapi.collect.africa/reserved_accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RAW_BODY": "string",
    "email": "test@collect.africa",
    "bvn": "22200000000",
    "account_name": "John Doe",
    "phone_number": "+23480000000000",
    "metadata": {}
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Reserved account created successfully

data

object

optional

id

integer

optional

Default:

0

Example:

44

status

string

optional

Example:

active

account_name

string

optional

Example:

John Doe

account_number

string

optional

Example:

7995441901

email

string

optional

Example:

test@collect.africa

bvn

string

optional

Example:

22200000000

phone_number

string

optional

Example:

+23480000000

reference

string

optional

Example:

ca-va-78

bank_code

string

optional

Example:

035

bank_name

string

optional

Example:

Alat

currency

string

optional

Example:

NGN

country

string

optional

Example:

NG

metadata

optional

created_at

string

optional

Example:

2022-01-12T14:39:09.519Z

updated_at

string

optional

Example:

2022-01-12T14:39:09.519Z

Example

{
    "message": "Reserved account created successfully",
    "data": {
        "id": 44,
        "status": "active",
        "account_name": "John Doe",
        "account_number": "7995441901",
        "email": "test@collect.africa",
        "bvn": "22200000000",
        "phone_number": "+23480000000",
        "reference": "ca-va-78",
        "bank_code": "035",
        "bank_name": "Alat",
        "currency": "NGN",
        "country": "NG",
        "metadata": null,
        "created_at": "2022-01-12T14:39:09.519Z",
        "updated_at": "2022-01-12T14:39:09.519Z"
    }
}

🟠400Bad Request