UPI Autopay V2 - Create Debit

Introduction

In the ever-evolving landscape of financial technology, the Debit Request API emerges as a pivotal tool, seamlessly integrating the critical functionality of presenting mandates for the deduction of funds from a customer's bank account. This innovative API plays a central role in the automated and secure execution of financial transactions, specifically focusing on the post-registration phase of mandates.

At its core, the Debit Request API facilitates the streamlined process of requesting and initiating debit transactions after successfully registering a mandate. The mandate, in this context, serves as the customer's authorization for the withdrawal of a specified amount from their bank account. Once a mandate has been successfully established, the Debit Request API takes center stage, orchestrating the presentation of this authorization to the financial institution for the deduction of funds.

Key features of the Debit Request API include its robust security measures, ensuring the confidentiality and integrity of sensitive financial information. Moreover, the API operates with a keen focus on automation, reducing manual intervention and expediting the overall transaction process. This not only enhances efficiency but also minimizes the potential for errors that may arise from manual handling.

The Debit Request API is designed to empower financial institutions, businesses, and service providers with a reliable and standardized mechanism for handling debit transactions in a compliant and user-friendly manner. By leveraging this API, organizations can navigate the complexities of financial operations with greater ease, providing a seamless experience for both businesses and their customers in the realm of automated fund transfers.

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/debit' \
--header 'Content-Type: application/json' \
--header 'Authorization: ' \
--data-raw '{
    "entityId": "89b5dfb3-415e-4669-a49b-02ccf61a7caf",
    "programId": "437",
    "merchantId": "991112",
    "mandateUMN": "e101d748fa1a43f9a2b20f6bc3d15e58@superyes",
    "mandateReferenceNumber": "V343434301400007111149830",
    "mandateNextExecutionTimestamp": "2025-10-18T20:00:00Z",
    "executionSequenceNumber": 2,
    "debitAmount": "1.11"
}'

Input Parameters

Here's a table outlining the key parameters, descriptions, whether they are mandatory or optional, and their data types.

Parameters	Data Type	Description	Required
entityId	String	Client Entity Identifier.	Mandatory
programId	String	Specific Program Identifier.	Mandatory
merchantId	String	Merchant Identifier.	Mandatory
mandateUMN	String	Unique Mandate Number	Mandatory
mandateReferenceNumber	String	Unique identifier for the mandate	Mandatory
mandateNextExecutionTimestamp	String	Scheduled execution date/time.	Mandatory
executionSequenceNumber	Integer	The sequence number for this attempt.	Mandatory
debitAmount	String	The exact amount to be collected.	Mandatory

Sample Response

{
  "id": "AVP20251204123045",
  "status": "SUCCESS",
  "referenceNo": "REF879321456",
  "statusDescription": "u",
  "errorCode": ""
}

Output Parameters

Parameters	Data Type	Description
id	String	Internal Transaction ID.
status	String	Collection status (e.g., SB_COLLECTION_INITIATED).
referenceNo	String	External reference number for the execution.
statusDescription	String	Human readable status message
errorCode	String	Status code

Sample Errors

{
   "error": {
       "name": "error",
       "message": "\"executionSequenceNumber\" is required",
       "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]