contact_id, bank_account.name, bank_account.ifsc and bank_account.account_number.
- If all the above details match the details of an existing fund account, the API returns details of the existing fund account.
- You cannot edit the details of a fund account.
Request
Curl
Response
Success
Parameters
contact_idmandatory
: string This is the unique identifier linked to a contact. For example, cont_00000000000001.
account_typemandatory
: string The account type you want to link to the contact ID. Here it is bank_account.
bank_accountmandatory
: object The contact’s bank account details.
namemandatory
: string Account holder’s name. Name must be between 3 - 120 characters. This field is case-sensitive. Name cannot end with a special character, except .. Supported characters: a-z, A-Z, 0-9, space, ’ , - , _ , / , ( , ) and , .. For example,Gaurav Kumar.
ifscmandatory
: string Beneficiary bank IFSC. Has to be 11 characters. Unique identifier of a bank branch. For example, HDFC0000053.
account_numbermandatory
: string Beneficiary account number. Between 5 and 35 characters. Supported characters: a-z, A-Z and 0-9. Beneficiary account number. For example, 765432123456789.
Parameters
id
: string The unique identifier linked to the fund account validation. For example, fav_0000000001.
entity
: string Here it is fund_account.validation.
status
: string The status of the account validation transaction.
Possible values: - created
completedfailed
validation_results
: object Details extracted from the results of the fund account validation.
account_status
: string Displays if the account is valid or not.
Possible values: - active
-
invalidregistered_name:stringThe name linked to the account. For example,Gaurav Kumarornull.details:stringBrief description of the validation.name_match_score:stringThe percentage score indicating how closely the account holder’s name matches the records.
validated_account_type
: string Here it is bank_account.
bank_account
: object The contact’s bank account details.
bank_routing_code
: string Beneficiary bank IFSC. For example, HDFC0000053.
account_number
: string Beneficiary account number. For example, 765432123456789.
bank_name
: string The contact’s bank name. For example, HDFC.
account_type
: string The account type being validated. For example savings, current.
status_details
: object Status of the fund account validation.
description
: string A brief description stating if the validation is complete or not.
source
: string The source from which validation was done. For example, beneficiary_bank
reason
: string Reason for validation.
reference_id
: string Unique reference_id generated for the validation transaction.
fund_account
: object The details of the fund account which was validated.
id
: string The unique identifier linked to the fund account. For example, fa_00000000000001.
entity
: string Here it is fund_account.
account_type
: string Fund account type.
vpa
: object The details associated with the account holder’s virtual payment address.
address
: string The virtual payment address of the contact whose account is validated. For example, gaurav.kumar@exampleupi
active
: boolean Possible values of fund account status:
true: activefalse: inactive
created_at
: integer Timestamp, in unix, when the fund account was created. For example, 1543650891.
contact
: object The contact’s details.
id
: string The unique identifier linked to the contact. For example, cont_00000000000001.
entity
: string Here it is contact
name
: string Account holder’s name. For example,Gaurav Kumar.
email
: string Email address of the contact.
contact
: string Phone number of the contact.
type
: string Contact Type. For example, employee, contractor.
reference_id
: string Reference id associated with the contact.
active
: boolean Possible values of contact status:
true: activefalse: inactive
Errors
The contact id provided does not exist.- code: 4xx
- description: The contact ID provided is incorrect.
- solution: Enter the correct Contact ID. Check if this contact already exists in your RazorpayX account using Fetch Contact id API or use the search option on the Dashboard. Or find the Contact ID: - In the response body of create a Contact API.
- On the Contacts Dashboard.
- code: 4xx
- description: The IFSC code provided is either incorrect or does not have 11 characters.
- solution: Check and pass the correct 11 characters IFSC.
- code: 4xx
- description: The account number is incorrect.
- solution: Enter the beneficiary account number between 5 and 35 characters. Supported characters- a-z, A-Z, and 0-9.