Introduction

Call this API when the user provides the recipient’s bank account(NGN) details.

Verify that the recipient’s account information is correct and the account is active, and display the cardholder’s name for user confirmation before initiating the transfer.

API Description

Request Method:POST

Request Path:open/api/bankCheck

Parameters

Request Parameters

Parameter	Sign	Mandatory	Type	Length	Description
appId	Y	Y	string	64	AppId is unique for merchant
sign	N	Y	string	512	Sign
currency	Y	Y	string	12	Fiat currency:`NGN`
bankCode	Y	N	string	512	Bank code (bankCode) + accountNumber or phoneNumber (either one is required)
accountNumber	Y	N	string	512	Bank code (bankCode) + accountNumber or phoneNumber (either one is required)
phoneNumber	Y	N	string	512	Bank code (bankCode) + accountNumber or phoneNumber (either one is required)

Request Parameter Example (Bank Code)

{
    "appId": "TEST000001",
    "sign": "D18DE66EC86F41CFCE7E0F720E7899B1C378AB056E4A949EC0AEB99A320DBEF8FD4B3C055ADB6BFFA25FABE1738C03E138421CE529C9C897AE646A7A6D91E86C",
    "currency": "NGN",
    "bankCode": "232",
    "accountNumber": "5268053284"
}

Request Parameter Example (Phone Number)

{
    "appId": "TEST000001",
    "currency": "NGN",
    "phoneNumber": "2348012345678",
    "sign": "D18DE66EC86F41CFCE7E0F720E7899B1C378AB056E4A949EC0AEB99A320DBEF8FD4B3C055ADB6BFFA25FABE1738C03E138421CE529C9C897AE646A7A6D91E86C"
}

Response Parameters

Parameter	Type	Description
success	boolean	Success
error	boolean	Error
code	long	Response code
msg	string	Response message
traceId	string	Trace id
model	object	Response content

Response Parameter Example(Bank Transfer)

{
    "code": "0",
    "msg": "success",
    "model": {
        "bankId": "16",
        "phoneNumber": null,
        "accountName": "CORALPAY-NextGen PG",
        "accountNumber": "5268053284"
    },
    "traceId": "691c3f0ec282a3d1db2701242e33508c",
    "error": false,
    "success": true
}

Response Parameter Example(Phone Number)

{
    "code": "0",
    "msg": "success",
    "model": {
        "bankId": null,
        "phoneNumber": "2348012345678",
        "accountName": null,
        "accountNumber": null
    },
    "traceId": "691c3fea0060435066ae824447a444d9",
    "error": false,
    "success": true
}

Response Parameter Example(failed)

{
    "code": "1087",
    "msg": "User not exist [A.U.I.user_not_found] (1087)",
    "model": null,
    "traceId": "691c46865a75171f9b19c93286a59f3e",
    "error": true,
    "success": false
}