Name Enquiry
Resolve a payout beneficiary account name.
Use name enquiry to verify a beneficiary bank account before creating a beneficiary or initiating a transfer.
-H "x-api-key: your_secret_key"GET {{host}}/v1/transfer/name-enquiry?bankCode=ORANGE_CIV&accountNumber=2250700000000¤cy=XOFQuery Parameters
| Field | Data Type | Required | Description |
|---|---|---|---|
| bankCode | string | Yes | Bank code returned from the Banks endpoint. For XOF mobile money payouts, this is the provider code such as ORANGE_CIV. |
| accountNumber | string | Yes | Beneficiary account number, or mobile money phone number for mobile money payouts. |
| currency | string | Yes | Payout currency. Supported payout currencies include NGN, GHS, KES, and XOF, depending on what is enabled for your business. |
{
"status": true,
"message": "Success",
"code": 200,
"data": {
"accountName": "FEMI ZACK",
"accountNumber": "0123456789",
"bankCode": "000014",
"bankName": "Access Bank",
"bvn": "",
"nameEnqRef": "SESSION_123456789"
}
}Notes
- Name enquiry availability depends on the payout currency and provider.
- KES and XOF payouts may require you to provide beneficiary account details directly when creating the beneficiary, depending on provider support for name enquiry.
- If the response includes
nameEnqRef, pass it when creating the beneficiary.
Updated 10 days ago
Did this page help you?
