Cancel Mandate

Introduction

Introducing the Cancel Mandate API, a pivotal tool in mandate lifecycle management that empowers financial institutions and service providers with a streamlined mechanism to cancel mandates based on customer authentication ID. This API represents a critical element in the dynamic landscape of financial operations, providing a responsive and efficient solution to revoke mandates in a secure and compliant manner. By accepting customer authentication ID as input, the Cancel Mandate API enables swift and accurate identification of the specific mandate slated for cancellation, offering a level of precision crucial in mandate lifecycle management. This powerful API not only enhances operational efficiency but also ensures the seamless execution of mandate cancellations, contributing to a robust and responsive framework for financial institutions navigating the intricacies of mandate 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/enach/cancelmandate' \
--header 'Content-Type: application/json' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--data '{
    "customerAuthenticationId": "6482ba7a3cc88901a97be6cb"
}'

Input Parameters

Key	Type	Mandatory/Optional	Description
customerAuthenticationId	String	Mandatory	The unique ID for customer authentication which was created in Initiate Payment API

Sample Response

{
    "status": true,
    "message": "Mandate cancelled successfully",
    "data": {
        "customerAuthenticationId": "64880707efb97e0301a63ff03434",
        "signzyId": "E230613P1TR0LM89"
    }
}

Output Parameters

Key	Type	Description
status	Boolean	The status of the request. True indicates success
message	String	A message describing the result of the request
data.customerAuthenticationId	String	The unique ID for customer authentication
data.signzyId	String	The unique Signzy ID

Sample Errors

{
    "error": {
        "name": "error",
        "message": "No Details found for the given customerAuthenticationId",
        "status": 404,
        "reason": "Not Found",
        "type": "Not Found",
        "statusCode": 200
    }
}

Error Parameters

Key	Description	Type
error	Main error object	Object
error.name	Error name	String
error.message	Error message	String
error.status	Error status code	String
error.reason	Error reason	String
error.type	Type of error	String
error.statusCode	HTTP status code	String

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]