Skip to main content
POST
/
beneficiaries
/
beneficiary-lookup
Beneficiary Lookup
curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/beneficiaries/beneficiary-lookup \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "bankCode": "000014",
  "accountNumber": "0123456789"
}
'
{
  "status": 200,
  "success": true,
  "message": "Account details retrieved successfully",
  "data": {
    "accountNumber": "0123456789",
    "accountName": "JOHN DOE",
    "bankCode": "000014",
    "bankName": "Access Bank"
  }
}
Validate a bank account and retrieve the account holder’s name. Use this to confirm details before creating a beneficiary.

​
Example Request

curl -X POST "https://api.rolla.xyz/api/v1/external/beneficiaries/beneficiary-lookup" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "bankCode": "000014",
    "accountNumber": "0123456789"
  }'

​
Example Response

{
  "status": 200,
  "success": true,
  "message": "Account details retrieved successfully",
  "data": {
    "accountNumber": "0123456789",
    "accountName": "JOHN DOE",
    "bankCode": "000014",
    "bankName": "Access Bank"
  }
}
Always verify the account name with your user before creating a beneficiary or initiating a payout. Incorrect details may result in failed or misdirected payments.

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Body

application/json
​
bankCode
string
required

Bank code from /banks endpoint

Example:

"000014"

​
accountNumber
string
required

10-digit account number

Example:

"0123456789"

Response

Account details retrieved successfully

​
status
integer
Example:

200

​
success
boolean
Example:

true

​
message
string
Example:

"Account details retrieved successfully"

​
data
object