get https://staging.api.decentro.tech/v3/payments/enach/bank_support
This API allows the platform to check if a bank is supported on the ENACH V3 stack.
Overview
This API lets a platform check if the ENACH authentication modes support a specific bank before executing the registration flow.
It is recommended that the platform use this API to check if ENACH supports a bank to avoid a poor experience with the registration flow.
Ensure to use only staging credentials.
Flow
Below is the flow for using this API.
- The platform collects the bank where the payer holds a bank account.
- The platform uses the bank code or auth mode to hit the endpoint to check the status.
- Decentro responds with the authorization modes supported by the bank while checking with bank code.
- Decentro response with the list of banks supported by particular authentication modes. For eg- Netbanking, Aadhaar, Debitcard.
- If the bank doesn't support any mode, the same is relayed to the platform as well
- If the bank is supported, the platform can use the Registration API to initiate the registration flow
Response Parameters
Below are the parameters propagated by Decentro in the response.
| Parameters | Description |
|---|---|
| decentro_txn_id | A unique transaction ID from Decentro for the API hit |
| status | Status of the API hit |
| response_key | API status response code |
| message | API status message. |
| debit_card | A boolean value if the bank supports Debit Card based registration flow |
| net_banking | A boolean value if the bank supports Netbanking based registration flow |
| aadhaar | A boolean value if the bank supports Aadhaar based registration flow |
| bank_code | 4 digits bank code assigned by NPCI |
| bank_name | Official bank name |
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/enach/bank_support |
| Production | https://api.decentro.tech/v3/payments/enach/bank_support |