Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This API allows you to verify that the Bank verification number and the account number supplied by a user match the BVN and account number linked to that account.

This endpoint is protected by OAuth 2.0 Bearer Token

Scenario 1: BVN is not valid.

Sample Request:

{
	"bankCode":"057",
	"accountNumber":"2191802645",
	"bvn":"22222222226"
}

Sample Response:

{
    "requestSuccessful": false,
    "responseMessage": "Unable to process request. Invalid BVN provided",
    "responseCode": "99"
}

Scenario 2: Supplied account number is not valid.

Sample Request:

{
	"bankCode":"044",
	"accountNumber":"0103284195",
	"bvn":"22228765899"
}

Sample Response:

{
    "requestSuccessful": false,
    "responseMessage": "Unable to process request. Name inquiry failed. Account  0103284195 Bank  044.  Invalid Account",
    "responseCode": "99"
}

Scenario 3: BVN, Bank Code, and Account Number is valid

Sample Request:

{
	"bankCode":"044",
	"accountNumber":"0105284275",
	"bvn":"22222222226"
}

Sample Response:

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "bvn": "22222222226",
        "accountNumber": "0105284275",
        "accountName": "OLATUNDE JOSIAH OGUNBOYEJO",
        "matchStatus": "FULL_MATCH",
        "matchPercentage": 100
    }
}

Field Reference:

Field

Description

Comment

bvn

11 digit bank verification number expected to belong to the account holder.

Required

bankCode

CBN bank code for the bank where the account number is domiciled. Click here to get a full list of all supported banks.

Required

accountNumber

10 digit bank account number.

Required

  • No labels