UPI Autopay - PreDebit Notification

Introduction

The Pre-Debit Notification API is designed to notify customers in advance about an upcoming UPI AutoPay transaction. This ensures transparency and allows users to be informed of the scheduled debit from their bank account.

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

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

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 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]