Get BAV Status V2

Use this API to check the status of your bank verification requests by passing reference ID or user ID to see if the validation is complete and get the results.

GET /bank-account

Get BAV Status V2

cURL

curl --request GET \
  --url https://sandbox.cashfree.com/verification/bank-account \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'

200

Valid account

{
  "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
  }
}

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

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.

Query Parameters

reference_id · string

It is unique ID you receive in the response of Bank Account Verification Sync and Async APIs.

user_id · string

It is the unique ID created by you to identify the verification request for async.

Response

200

application/json

Success response for Get Details 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
• RECEIVED
• FAILED
• REJECTED
• APPROVAL_PENDING
• PARTIALLY_APPROVED
• IN_PROCESS
• CANCELLED
• PROCESSING
• MANUALLY_REJECTED

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
• FRAUD_ACCOUNT
• FAILED_AT_BANK
• NPCI_UNAVAILABLE
• CONNECTION_TIMEOUT
• SOURCE_BANK_DECLINED
• BENE_BANK_DECLINED
• IMPS_MODE_FAIL
• BENEFICIARY_BANK_OFFLINE
• VALIDATION_IN_PROGRESS
• INVALID_ACCOUNT_FAIL
• INVALID_IFSC_FAIL
• VERIFICATION_ALREADY_UNDER_PROCESS
• NRE_ACCOUNT_FAIL
• ACCOUNT_BLOCKED
• INSUFFICIENT_BALANCE

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