API Endpoints

POSTCreate Dedicated Virtual Account

http://127.0.0.1:8000/api/v1/create_account

Provide dob in the formats below

1989-10-04

Either the phone number or bvn must be provider.

If bvn is not provided, phone number must be provided and vice versa. Also, both can be provided.

It is up to you to handle your user verification when using phone number only. Else, we advice you to provide user bvn in your request.

For Safe Haven MFB: It is now required to generate BVN OTP from the BVN phone number and submit both OTP and BVN to generate safehaven account number.

To get BVN OTP, Dial *565*3# , Enter 11113 as iGree Number then Send. Finally, on Prompt, Input your BVN Number. An 8 DIGIT OTP will be sent to you. Enter submit this as otp in account create dedicated virtual account endpoint.

Our current supported banks are

providus

safehaven

netbank

It is required to parse the provider parameter for the account you want to create. When provider is not provided, netbank account would be generated.

AUTHORIZATIONBearer Token

Token

sk_test_2648indlqawzd5si8vigopdvpdl49brh2ed30of

Bodyraw (json)

json

{
    "firstname":"Tolulope",
    "lastname":"Oyeniyi",
    "address":"No 5 address",
    "gender":"Male",
    "email":"tolulope@lonytechsolution.com",
    "phone":"08135542261",
    "dob":"1960-10-04",
    "bvn":"",
    "nin":"",
    "otp":"",
    "provider":"netbank"
}

Example Request

curl

curl --location 'http://127.0.0.1:8000/api/v1/create_account' \
--data-raw '{
    "firstname":"Tolulope",
    "lastname":"Oyeniyi",
    "address":"No 5 address",
    "gender":"Male",
    "email":"tolulope@lonytechsolution.com",
    "phone":"08135542261",
    "dob":"1960-10-04",
    "bvn":"",
    "nin":"",
    "otp":"",
    "provider":"netbank"
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTCreate Dedicated Business Virtual Account

http://127.0.0.1:8000/api/v1/create_business_account

Provide dob in the formats below

1989-10-04

Either the phone number or bvn must be provider.

If bvn is not provided, phone number must be provided and vice versa. Also, both can be provided.

It is up to you to handle your user verification when using phone number only. Else, we advice you to provide user bvn in your request.

For Safe Haven MFB: It is now required to generate BVN OTP from the BVN phone number and submit both OTP and BVN to generate safehaven account number.

Our current supported banks are

providus

safehaven

netbank

It is required to parse the provider parameter for the account you want to create. When provider is not provided, netbank account would be generated.

AUTHORIZATIONBearer Token

Token

sk_test_2648indlqawzd5si8vigopdvpdl49brh2ed30of

Bodyraw (json)

json

{
    "accountName":"Tolulope",
    "firstname":"Tolulope",
    "lastname":"Oyeniyi",
    "email":"tolulope@lonytechsolution.com",
    "phone":"08135542261",
    "bvn":"",
    "address":"No 5 address",
    "gender":"Male", // optional
    "dob":"1960-10-04", // optional (only required for vfd, and must match bvn)
    "nin":"", // optional
    "otp":"", // optional (only required for safehaven account)
    "provider":"netbank"
}

Example Request

curl

curl --location 'http://127.0.0.1:8000/api/v1/create_business_account' \
--data-raw '{
    "accountName":"Tolulope",
    "firstname":"Tolulope",
    "lastname":"Oyeniyi",
    "email":"tolulope@lonytechsolution.com",
    "phone":"08135542261",
    "bvn":"",
    "address":"No 5 address",
    "gender":"Male", // optional
    "dob":"1960-10-04", // optional (only required for vfd, and must match bvn)
    "nin":"", // optional
    "otp":"", // optional (only required for safehaven account)
    "provider":"netbank"
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

GETBVN Consent Request (VFD Account Only)

http://127.0.0.1:8000/api/v1/bvn_consent/{bvn}

Provide dob in either of the formats below

1989-10-04

04 October 1989

Either the phone number or bvn must be provider.

If bvn is not provided, phone number must be provided and vice versa. Also, both can be provided.

It is up to you to handle your user verification when using phone number only. Else, we advice you to provide user bvn in your request.

AUTHORIZATIONBearer Token

Token

sk_test_2648indlqawzd5si8vigopdvpdl49brh2ed30of

Example Request

curl

curl --location -g 'http://127.0.0.1:8000/api/v1/bvn_consent/{bvn}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTUpdate Dedicated Virtual Account (Providus only)

http://127.0.0.1:8000/api/v1/update_account/{reference}

Account name update is currently available for providus accounts only.

NOTE: Their is an account control limit on providus accounts generated. You can not keep generating providus account when you are not using the already generated accounts. You need to make sure to re-assign accounts to customers that will use the account by taking the account from those that are not making any deposit on providus account over the first 30days.

AUTHORIZATIONBearer Token

Token

sk_test_2648indlqawzd5si8vigopdvpdl49brh2ed30of

Bodyraw (json)

json

{
    "firstname":"Tolulope",
    "lastname":"Oyeniyi"
}

Example Request

curl

curl --location -g 'http://127.0.0.1:8000/api/v1/update_account/{reference}' \
--data '{
    "firstname":"Tolulope",
    "lastname":"Oyeniyi"
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers