Skip to main content
Use this endpoint to retrieve all fund accounts.

​
Request

Curl

​
Response

Success

​
Parameters

account_type optional : string The fund account type to be retrieved. Possible values: contact_id optional : string The unique contact ID for which fund accounts are to be retrieved. For example, cont_00000000000001. from optional : integer Timestamp, in Unix, from when fund accounts are to be retrieved. to optional : integer Timestamp, in Unix, till when fund accounts are to be retrieved. count optional : integer The number of fund accounts to be retrieved. Default = 10. Maximum = 100. This can be used for pagination, in combination with skip. skip optional : integer The number of fund accounts to be skipped. Default = 0. This can be used for pagination, in combination with count.

​
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
  • completed
  • failed
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
  • invalid registered_name : string The name linked to the account. For example,Gaurav Kumar or null. details : string Brief description of the validation. name_match_score : string The 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: active
  • false: 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: active
  • false: inactive

​
Errors

“ is not a valid id.
  • code: 4xx
  • description: The fund account ID entered is invalid.
  • solution: Re-check or find the Fund Account ID: - In the response body of create a Fund Account API.