POST
/
bank-account
/
sync
{
  "reference_id": 34,
  "name_at_bank": "BHARATHTEST GKUMARUT",
  "bank_name": "YES BANK",
  "city": "MUMBAI",
  "branch": "SANTACRUZ, MUMBAI",
  "micr": 400532038,
  "name_match_score": "90.00",
  "name_match_result": "GOOD_PARTIAL_MATCH",
  "account_status": "VALID",
  "account_status_code": "ACCOUNT_IS_VALID",
  "utr": "404223241811"
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Request body for BAV V2 Sync

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.

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.

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.

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.

Response

200 - application/json

Find the description for each response parameter

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.

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.

bank_name
string

It displays the name of the bank.

branch
string

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

city
string

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

micr
integer

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

name_at_bank
string

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

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.

name_match_score
string

It displays the score of the name match verification.

reference_id
integer

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

utr
string

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