Cashfree Payments Developer Documentation

Secure ID APIs

V2

Aadhaar
Advanced Employment
BAV V2
- Sync
- Async
- Bulk
  - POST
    Bulk Bank Account Verification V2
  - GET
    Get Bulk BAV Status V2
- BAV Response Description
- Webhooks
CIN
Digilocker
PAN
Driving License
E-sign
Face Match
GSTIN
IP
Liveliness
Name Match
PAN to GSTIN
Passport
Reverse Penny Drop
Reverse Geocoding
Vehicle RC
Voter ID
Account Aggregator
Mobile 360 OTP Flow
Secure-Share
BharatOCR
IFSC
KYC Links

V1

Bank Account Verification

GET

bank-account

bulk

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

{
  "bulk_verification_id": "test-bulk-123",
  "bulk_reference_id": 1234,
  "entries": [
    {
      "bank_account": 11020001772,
      "ifsc": "HDFC0000001",
      "name": "John Doe",
      "phone": 7709736537,
      "reference_id": 1097293,
      "name_at_bank": "John Doe",
      "account_status": "VALID",
      "account_status_code": "ACCOUNT_IS_VALID",
      "utr": "404223241811",
      "name_match_score": "100",
      "name_match_result": "DIRECT_MATCH"
    }
  ]
}

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

Query Parameters

bulk_reference_id

integer

It is unique ID you receive in the response of Bulk Bank Account Verification API. format: int64

bulk_verification_id

string

It is the unique ID created to identify the bulk bank validation request.

reference_id

integer

It is unique ID for a single entry you receive in the response of Get status of Bulk Bank Account Verification API. format: int64

Response

200

application/json

Success response for Get Bulk BAV Status V2

Find the description for each response parameter

bulk_reference_id

integer

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

Example:

1234

bulk_verification_id

string

It displays the unique ID you created to identify the API request.

Example:

"test-bulk-123"

entries

object[]

It displays the verified bank account information

entries.reference_id

integer

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

Example:

123

entries.name_at_bank

string

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

Example:

"JOHN DOE"

entries.bank_name

string

It displays the name of the bank.

Example:

"YES BANK"

entries.utr

string

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

Example:

"404223241811"

entries.city

string

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

Example:

"MUMBAI"

entries.branch

string

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

Example:

"SANTACRUZ, MUMBAI"

entries.micr

integer

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

Example:

33

entries.name_match_score

string

It displays the score of the name match verification.

Example:

"90.00"

entries.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"

entries.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"

entries.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"

Example:

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

Was this page helpful?

Bulk Bank Account Verification V2 BAV Response Description

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

{
  "bulk_verification_id": "test-bulk-123",
  "bulk_reference_id": 1234,
  "entries": [
    {
      "bank_account": 11020001772,
      "ifsc": "HDFC0000001",
      "name": "John Doe",
      "phone": 7709736537,
      "reference_id": 1097293,
      "name_at_bank": "John Doe",
      "account_status": "VALID",
      "account_status_code": "ACCOUNT_IS_VALID",
      "utr": "404223241811",
      "name_match_score": "100",
      "name_match_result": "DIRECT_MATCH"
    }
  ]
}