Skip to content

Beneficiary validation

Check a beneficiary account before paying it.

Validate Account

Request

Check that a beneficiary bank account exists and, when a name is supplied, that it matches the account holder. India only (country must be IND).

Security
bearerAuth
Bodyapplication/jsonrequired
countrystring(ApiCountry)required

Destination country. Must be IND — account validation is available for India only, because it is the only corridor with the bank reference data the validation backends need. Any other value is a 400.

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
payment_typestring(PaymentType)

Payment type the beneficiary will be paid out under; picks the provider route the validation runs on

Default:"C2C"
Enum:"B2B""B2C""C2B""C2C"
account_numberstring(Account Number)required

Bank account id of the beneficiary

branch_codestring(Branch Code)required

Bank branch code (IFSC code for India)

beneficiary_namestring or null(Beneficiary Name)
Any of:

Bank account holder name, when known

string
curl -i -X POST \
  https://docs.leanx.me/_mock/openapi/v3/validate_account \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_number": "99345724439934",
    "beneficiary_name": "Nikhil Sharma",
    "branch_code": "FDRL0001883",
    "country": "IND",
    "payment_type": "C2C"
  }'

Responses

Successful Response

Bodyapplication/json
countrystring(ApiCountry)required

Destination country

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
account_numberstring(Account Number)required

Bank account id of the beneficiary

branch_codestring(Branch Code)required

Bank branch code (IFSC code for India)

statusstring(BankAccountStatus)required

Account status as reported by the validation backend. pending means the backend has queued the check and the account should be validated again later

Enum ValueDescription
invalid

The account was not found, or is blocked, closed or inactive, or the IFSC code is invalid. Do not send a payment to it.

nre

The account exists and is an Indian NRE (Non-Resident External) account. It passes validation; payments to it are handled under NRE rules.

pending

The check is still running at the provider. This is not a failure: check again later.

valid

The account exists and is active.

namestring or null(Name)
Any of:

Account holder name reported by the backend

string
Response
{ "account_number": "99345724439934", "branch_code": "FDRL0001883", "country": "IND", "name": "Nikhil Sharma", "status": "valid" }