Bank Account Verification Sync V2

Use this API to do bank account verification in sync. View the test data and use the information to trigger the validations. You can use the test data only in sandbox environment.

• Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
• For further queries, please refer to the Bank Account Verification FAQs.
• IMPS verifies only the first five characters of the IFSC code, which represent the bank. It does not verify the remaining six characters that identify the branch.

Authorizations

x-client-id · string · header · required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret · string · header · required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-cf-signature · string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameters to verify the bank account information using the sync method

bank_account · string · default: 26291800001191 · required

It is the bank account number for verification. It can be an alphanumeric value between 6 and 40 characters.

Example:

"26291800001191"

ifsc · string · default: YESB0000001 · required

It is the IFSC information of the bank where the bank account is registered. It should be ann alphanumeric value of 11 characters. The first 4 characters should be alphabets, the 5th character should be a 0, and the remaining 6 characters should be numeric digits.

Example:

"YESB0000001"

name · string · default: John Doe

It is the name of the bank account holder. When provided, a name match verification is done. Only alphanumeric, whitespace ( ), period (.), hyphen ( - ), slash (/), and ampersand ( & ) are allowed.

Example:

"John Doe"

phone · string · default: 9999999999

It is the phone number of the account holder that is associated with the entered bank account. Only numeric digits betweem 8 and 13 characters are allowed.

Example:

"9999999999"

Response

200

application/json

Success response for Bank Account Verification Sync V2

reference_id · integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

Example:

23

name_at_bank · string

It displays the name of the account holder as per the bank records.

Example:

"JOHN DOE"

bank_name · string

It displays the name of the bank.

Example:

"YES BANK"

utr · string

It displays the unique transaction reference (UTR) number created by the bank to identify the transaction.

Example:

"404223241811"

city · string

It displays the name of the city where the bank is located.

Example:

"MUMBAI"

branch · string

It displays the name of the branch where the bank account is registered.

Example:

"SANTACRUZ, MUMBAI"

micr · integer

It represents the code used to identify banks and branches participating in the Electronic Clearing System (ECS).

Example:

33

name_match_score · string

It displays the score of the name match verification.

Example:

"90.00"

name_match_result · string

It displays the result of the name match verification. Possible values are:

• DIRECT_MATCH
• GOOD_PARTIAL_MATCH
• MODERATE_PARTIAL_MATCH
• POOR_PARTIAL_MATCH
• NO_MATCH

Click here to view the detailed descriptions of each value.

Example:

"GOOD_PARTIAL_MATCH"

account_status · string

It displays the status of the bank account. Possible values are:

• VALID
• INVALID

Click here to view the detailed descriptions of each value.

Example:

"VALID"

account_status_code · string

It displays the status code of the bank account. Possible values are:

• ACCOUNT_IS_VALID
• INVALID_ACCOUNT_FAIL
• ACCOUNT_BLOCKED
• INVALID_IFSC_FAIL
• NRE_ACCOUNT_FAIL

Click here to view the detailed descriptions of each value.

Example:

"ACCOUNT_IS_VALID"

ifsc_details · object

It displays the details corresponding to IFSC.

Show child attributes