POST
/
bank-account
/
sync
curl --request POST \
  --url https://sandbox.cashfree.com/verification/bank-account/sync \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "bank_account": "26291800001191",
  "ifsc": "YESB0000001",
  "name": "John Doe",
  "phone": "9999999999"
}'
{
  "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",
  "ifsc_details": {
    "bank": "YES BANK",
    "ifsc": "YESB0000262",
    "ifsc_subcode": "YESB0",
    "address": "GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, MUMBAI - 560098",
    "city": "MUMBAI",
    "state": "MAHARASHTRA",
    "branch": "SANTACRUZ, MUMBAI",
    "category": "SUB_MEMBER",
    "swift_code": "ABCDINBBDCL",
    "micr": 560751026,
    "nbin": 1234
  }
}

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.

Headers

​
x-cf-signature
string

Send the signature if IP is not whitelisted

Body

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

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.

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

Find the description for each response parameter

​
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.

Was this page helpful?