UPI Autopay V2 - Mandate Status

Introduction

Introducing the Transaction Status API, an indispensable component within the mandate creation process that revolutionizes the transparency and real-time monitoring of financial transactions. This API serves as a crucial interface, offering unparalleled insights into the status of a transaction ID throughout its lifecycle. As an integral part of the mandate creation workflow, the Transaction Status API empowers users with instant access to comprehensive details, ensuring a seamless and informed experience. Whether confirming the successful execution of a transaction or identifying potential issues, this API provides a vital link in the chain of financial operations, enhancing accountability and efficiency within the mandate creation process. With its real-time transaction tracking capabilities, the Transaction Status API stands at the forefront of financial technology, fostering a heightened level of control and confidence for stakeholders engaged in the dynamic landscape of transaction management.

Authentication

This API employs API Keys for request authentication. It's crucial to safeguard your API Keys, as they grant various privileges. To obtain the Access Key, kindly reach out to our Support/CSM team. Once obtained, please utilize this access key in the Authorization header.

Authentication for the API is executed through the Authorization header.

--header 'Authorization: YOUR_ACCESS_KEY_HERE'

Feel free to replace 'YOUR_ACCESS_KEY_HERE' with the actual Access Key provided by our Support/CSM team.

API Details

The details of the API can be found here.

Sample Request

curl --location 'https://api.signzy.app/api/v3/upi-autopay/mandate-status' \
--header 'Content-Type: application/json' \
--data '{
    "entityId": "89b5dfb3-415e-4669-a49b-02ccf61a7caf",
    "programId": "437",
    "merchantId": "991112",
    "mandateReferenceNumber": "MANDATEREF08",
    "mandateAction": "create"
}'

Input Parameters

Parameter	Data Type	Description	Required
entityId	String	Entity identifier	Mandatory
programId	String	Program identifier	Mandatory
merchantId	String	Merchant identifier	Mandatory
mandateReferenceNumber	String	Original mandate reference	Mandatory
mandateAction	String	Action type	Mandatory

Sample Response

{
    "mandateReferenceNumber": "MandateTest001",
    "merchantReferenceId": "MerchantRef001",
    "mandateStatus": "SB_CREATION_SUCCESS",
    "amount": 100,
    "payerVpa": "user@bank",
    "payerName": "JohnDoe",
    "mandateAction": "create",
    "status": "SB_CREATION_SUCCESS",
    "statusDescription": "Mandate status retrieved successfully",
    "mandateUMN": "UMN123456789",
    "mandateStartDate": "2025-01-15T10:00:00Z",
    "mandateEndDate": "2025-12-15T10:00:00Z"
}

######################

{
    "error": {
        "name": "error",
        "message": "mandateAction must be either create or revoke",
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}

Output Parameters

Parameter	Data Type	Description
mandateReferenceNumber	String	Unique identifier for the mandate request
merchantReferenceId	String	Reference ID provided by the merchant to track the mandate
mandateStatus	String	Status of the mandate
amount	Number	Authorized Mandate amount
payerVpa	String	Virtual Payment Address (VPA) of the payer
payerName	String	Name of the payer
mandateAction	String	Action performed on the mandate
status	String	Overall API response status
statusDescription	String	Human-readable message describing the response
mandateUMN	String	Unique Mandate Number (UMN) generated by the bank or system
mandateStartDate	String	Date when the mandate becomes active
mandateEndDate	String	Date when the mandate expires or ends

Sample Errors

{
    "error": {
        "name": "error",
        "message": "mandateAction must be either create or revoke",
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}

Error Codes

Error Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]