API Reference

Physical NACH Registration Status

You can query the registration status of Physical nach using the below API:

GET /api/v1/nach/physical/<physical_nach_id>/status/

A sample response is given below:

{
    "is_success": true,
    "data": {
        "umrn": "<registered UMRN number>",
        "status": "<initiated/registered/failed/expired>",
        "physical_nach_id": "<uuid of physical nach>"
    }
}

This API will return the status of the transaction. In case the status is “registered”, the umrn would be returned.

We can also share the same information via webhook, the format for the webhook response is given below. In the demo environment, you can pass 12345678 as the account number to get an initiated response, for all other account numbers it would return a webhook with registered status.

{
   "entity":"nach",
   "payload":{
      "umrn":"<registered UMRN number>",
      "status":"<initiated/registered/failed/expired>",
      "physical_nach_id":"<uuid of physical nach>"
   },
   "event":"physical_nach.status_update",
   "id":"<webhook id>",
   "created_at":"<timestamp when webhook was created>"
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!