Enach Supported Banks

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, PAN & Customer ID.
  • 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.

ParametersDescription
decentro_txn_idA unique transaction ID from Decentro for the API hit
statusStatus of the API hit
response_keyAPI status response code
messageAPI status message.
debit_cardA boolean value if the bank supports Debit Card based registration flow
net_bankingA boolean value if the bank supports Netbanking based registration flow
panA boolean value if the bank supports PAN based registration flow
customer_idA boolean value if the bank supports customer id based registration flow
aadhaarA boolean value if the bank supports Aadhaar based registration flow
bank_code4 digits bank code assigned by NPCI
bank_nameOfficial bank name

API Endpoints

Query Params
string
Defaults to yesb

This will be the bank code of the destination bank as available on NPCI website.

string
Defaults to debitcard

Possible values are "aadhaar", "netbanking", "pan", "customerid" & "debitcard"

Headers
string
required
string
required
Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json