API Reference

eNACH Mandate Status - Mandate Transaction ID

Overview

Fetches current status of mandate creation, execution, or update/revoke transactions.

Description

Allows merchant to fetch the current status of: Mandate Creation, Execution, or Update/Revoke transactions at any time.

Prerequisites

  • Valid UMRN or transaction reference
  • Merchant credentials
  • Nttdata Payment Services API access

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 mandate status, you need to call the below API by passing the mandate transaction ID (mandateTxnId) directly in the URL

API Endpoint:

/ots/auto-pay/v1.0/manage/status/transactions/{mandateTxnId}

Replace {mandateTxnId} with the actual mandate transaction ID 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 mandateTxnId.

Response Attributes

Attribute
Description
data
object (18 fields)
Optional
Response payload containing mandate creation details
code
numberOptional
Status Codes
message
stringOptional
Status Message
description
stringOptional
Status Description