API Reference

eNACH Execute Status - Unique Mandate Number

Overview

The Status API allows merchants to check the current status of exceute mandate. It ensures secure access through user credentials provided by Nttdata Payment Services. The API helps in tracking the progress of a execute mandate request using a unique transaction reference.

Description

This API requires authentication using Nttdata Payment Services provided user credentials to access the service. It accepts the merchant transaction ID as a key input parameter to retrieve the execute mandate status. The response provides details about whether the mandate is successfully executed, pending, or failed, enabling merchants to monitor and manage transactions efficiently.

Prerequisites

  • Valid transaction ID (Unique Mandate Number)
  • Merchant credentials
  • Nttdata Payment Services API access

Execute Mandate Status Attributes

This API requires Basic Authentication for access. The request must include valid credentials in the form of a username and password, which will be provided separately. Only authorized users with the correct credentials will be able to successfully authenticate and interact with the API.

Request Attributes

To check the execute mandate status, you need to call the below API by passing the execution transaction ID (executionTxnId) directly in the URL

API Endpoint:

/ots/auto-pay/v1.0/execute/status/transactions/umn/{uniqueMandateNumber}/page/1/size/1

Replace {uniqueMandateNumber} with the actual Unique Mandate Number while making the request.

  • No request body is required.
  • The input parameter is passed directly in the URL.
  • The API will return the mandate status based on the provided merchTxnId.

Response Attributes

Attribute
Description
merchId
numberOptional
Merchant ID shared by Nttdata Payment Services
mandateTxnId
numberOptional
Nttdata Payment Services Transaction ID
uniqueMandateNumber
stringOptional
Unique Mandate Number generated by NPCI
executionData
arrayOptional
List of mandate execution response records
pagination
object (6 fields)
Optional
Pagination details for response data