post https://business-api.test.equal.in/ie/transaction/journey/execute
Preconfigured Journeys to verify Bank Account.
This is the pre-configured journey to perform the Bank Account Verification using Bank Account Number and IFSC code.
Bank Account Verification
The businesses can configure these checks with our Bank Account Verification journey
Journey Input Data
{
"account_number": "<BankAccount number>",
"ifsc": "<Ifsc of the BankAccount>"
}Journey Output Data
{
"transaction_id": "",
"journey_transaction_id": "",
"journey_id": "",
"status": "SUCCESS|FAILURE|IN_PROGRESS",
"status_code": "Refer to the table below",
"message": "Refer to the table below",
"decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
"checks": [],
"data": {
"keys": {
"bank_account": [
{
"account_number": "<BankAccount number>",
"name": "",
"ifsc": "",
"bank_name": "",
"branch_name": "",
"source": "",
"issuer": "",
"decision": "",
"checks": []
}
]
}
}
}This journey does not include any pre-configured Ownership or Fraud Checks. To configure these checks, please contact your Account Manager.
Status Codes
| Scenario | HttpStatus | status | status_code | message |
|---|---|---|---|---|
| When request is successful and Bank Account details are available. | 200 | SUCCESS | success | Request successful |
| When Bank Account is not valid | 200 | FAILURE | invalid_input | Bank Account No is Invalid |
| When IFSC code is not valid | 200 | FAILURE | invalid_ifsc | IFSC is invalid |
| When no details found at Source for given Bank Account Number | 200 | FAILURE | document_not_found | Entity not found |
| When Input doesn't contain the account_number or IFSC field. | 400 | FAILURE | invalid_input | account_number and IFSC are required |
| Any unhandled error from Equal's end | 500 | FAILURE | internal_server_error | Something went wrong, please try again. |
| Too many requests | 429 | No object will be sent, throttling happens at the gateway level. | ||
| Service Unavailable | 503 | |||
| Invalid Client Credentials | 401 | FAILURE | invalid_credentials | Invalid Client Credentials |
Status (Journey Status)
| Possible Values | Description |
|---|---|
| SUCCESS | Shows that the verification process was completed successfully. |
| FAILURE | Indicates that the verification process did not succeed. |
| IN_PROGRESS | Signifies that the verification process is currently underway and has not yet been completed. |
Decision
| Possible Values | Description |
|---|---|
| CLEAR | Indicates that the verification has been completed and the information is confirmed as accurate and legitimate. |
| MUST REVIEW | Signifies that further review is needed due to potential issues or inconsistencies in the verification results. |
| NEEDS REVIEW | Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made. |
Journey ID will be shared as part of Onboarding
Key Descriptions
| Key | Description |
|---|---|
| transaction_id | Unique identifier for the transaction. |
| journey_transaction_id | Unique identifier for the journey transaction. |
| journey_id | Unique identifier for the journey. |
| status | Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS. |
| status_code | Code representing the specific status of the transaction. Refer to the documentation for possible values. |
| message | Detailed message about the transaction status. Refer to the documentation for specific messages. |
| decision | Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks | List of checks performed during the transaction. |
| bank_account | List of bank account-related data points. |
| account_number | Bank account number for verification. |
| name | Name of the account holder. |
| ifsc | IFSC code of the bank branch. |
| bank_name | Name of the bank where the account is held. |
| branch_name | Name of the branch where the account is held. |
| source | Source from which the data was extracted (e.g., bank records). |
| issuer | Issuer of the bank account (e.g., bank). |
| decision (specific key) | Decision for this specific key based on the checks performed. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks (specific key) | List of checks performed on this specific key. |