Recurring Payments

Cancel Charge

Introduction
The Cancel Charge API is a powerful tool designed to enable businesses to manage and control transactions effectively within their payment systems. This API provides a seamless mechanism to cancel transactions that are in the INITIALIZED state, offering flexibility and control over payment processes.
With the Cancel Charge API, businesses can initiate cancellation requests for transactions that have been initialized but not yet processed. This functionality ensures that businesses can rectify erroneous or unwanted transactions promptly, mitigating potential financial discrepancies and enhancing customer satisfaction.
One of the key features of the Cancel Charge API is its ability to streamline the cancellation process for transactions in the INITIALIZED state. By providing a simple and intuitive interface, businesses can efficiently trigger cancellation requests without the need for complex manual interventions, thereby saving time and resources.
Furthermore, the Cancel Charge API facilitates seamless integration with existing payment systems, allowing businesses to incorporate cancellation functionalities seamlessly into their workflows. This ensures interoperability and compatibility with various payment platforms, enhancing the overall efficiency and effectiveness of transaction management processes.
By leveraging the Cancel Charge API, businesses can maintain greater control and oversight over their payment operations, ensuring accuracy and integrity throughout the transaction lifecycle. Whether it's rectifying erroneous transactions, managing customer requests, or optimizing payment processes, this API empowers businesses to streamline their operations and deliver a superior customer experience.
In summary, the Cancel Charge API offers a robust solution for businesses seeking to cancel transactions in the INITIALIZED state, providing flexibility, efficiency, and control over payment processes. By leveraging this API, businesses can effectively manage their transactional workflows and enhance overall operational efficiency within their payment systems.
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 
Pre-Production
Production
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/eNach/eMandates/{subReferenceId}/charge/{paymentId}/cancel' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--data ''
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/eNach/eMandates/{subReferenceId}/charge/{paymentId}/cancel' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--data ''
﻿
Path Parameters
Here's a table outlining the key parameters, descriptions, whether they are mandatory or optional, and their data types.
Key
Description
M/O
Type
subReferenceId
A unique ID which was generated when the subscription was created
Mandatory
String
paymentId
A unique Id for the payment
Mandatory
String
Sample Response
200
{
    "result": {
        "status": "OK",
        "message": "Subscription charge cancelled",
        "payment": {
            "paymentId": 2276563,
            "referenceId": 214308920,
            "subReferenceId": 5513463,
            "cfOrderId": 236286405,
            "currency": "INR",
            "amount": 250,
            "cycle": 5,
            "status": "CANCELLED",
            "remarks": null,
            "scheduledOn": "2021-09-13",
            "addedOn": "2021-09-09 11:05:19",
            "retryAttempts": 0,
            "failureReason": null
        }
    }
}
{
    "result": {
        "status": "OK",
        "message": "Subscription charge cancelled",
        "payment": {
            "paymentId": 2276563,
            "referenceId": 214308920,
            "subReferenceId": 5513463,
            "cfOrderId": 236286405,
            "currency": "INR",
            "amount": 250,
            "cycle": 5,
            "status": "CANCELLED",
            "remarks": null,
            "scheduledOn": "2021-09-13",
            "addedOn": "2021-09-09 11:05:19",
            "retryAttempts": 0,
            "failureReason": null
        }
    }
}
﻿
Output Parameters
Key
Description
Type
result
Object containing the result
Object
result.status
Status of the result
String
result.message
Message related to the result
String
result.payment
Object containing payment information
Object
payment.paymentId
Identifier for the payment
Integer
payment.referenceId
Reference identifier for the payment
Integer
payment.subReferenceId
Sub-reference identifier for the payment
Integer
payment.cfOrderId
Identifier for the order (custom field)
Integer
payment.currency
Currency of the payment
String
payment.amount
Amount of the payment
Integer
payment.cycle
Cycle of the payment
Integer
payment.status
Status of the payment
String
payment.remarks
Remarks regarding the payment
String
payment.scheduledOn
Scheduled date for the payment
String
payment.addedOn
Timestamp when payment was added
String
payment.retryAttempts
Number of retry attempts for the payment
Integer
payment.failureReason
Reason for payment failure (if applicable)
String
Sample Errors
400
401
404
{
    "error": {
        "name": "error",
        "message": "",
        "status": "404",
        "reason": "ERROR",
        "type": "Not Found",
        "statusCode": "404"
    }
}
{
    "error": {
        "name": "error",
        "message": "",
        "status": "404",
        "reason": "ERROR",
        "type": "Not Found",
        "statusCode": "404"
    }
}
﻿
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
404
Not Found
The eneterd Sub Reference ID is not found
500
Internal Server Error
Internal error at Signzy, Please reach out to [email protected]
﻿

Charge Subscription

Subscription Status and Workflow

Docs powered by Archbee

TABLE OF CONTENTS

Key	Description	M/O	Type
subReferenceId	A unique ID which was generated when the subscription was created	Mandatory	String
paymentId	A unique Id for the payment	Mandatory	String

Key	Description	Type
result	Object containing the result	Object
result.status	Status of the result	String
result.message	Message related to the result	String
result.payment	Object containing payment information	Object
payment.paymentId	Identifier for the payment	Integer
payment.referenceId	Reference identifier for the payment	Integer
payment.subReferenceId	Sub-reference identifier for the payment	Integer
payment.cfOrderId	Identifier for the order (custom field)	Integer
payment.currency	Currency of the payment	String
payment.amount	Amount of the payment	Integer
payment.cycle	Cycle of the payment	Integer
payment.status	Status of the payment	String
payment.remarks	Remarks regarding the payment	String
payment.scheduledOn	Scheduled date for the payment	String
payment.addedOn	Timestamp when payment was added	String
payment.retryAttempts	Number of retry attempts for the payment	Integer
payment.failureReason	Reason for payment failure (if applicable)	String

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
404	Not Found	The eneterd Sub Reference ID is not found
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]