Charge Subscription

Introduction

The Charge Subscription API offers a powerful tool for managing subscription-based services by facilitating the explicit debiting of a customer's account for an ON-DEMAND plan. This API serves as a crucial component in the workflow of subscription-based businesses, enabling them to seamlessly collect payments from their customers.

With the Charge Subscription API, businesses can initiate payment transactions directly from the customer's account, triggering a real-time debit process for services rendered on an on-demand basis. This functionality streamlines the payment collection process, ensuring prompt and efficient processing of subscription charges.

One of the key features of this API is its ability to trigger notifications to customers via their respective banks regarding the payment transaction. This ensures transparency and enhances communication between the business and its customers, providing them with timely updates on financial transactions related to their subscriptions.

By leveraging the Charge Subscription API, businesses can maintain control over their subscription billing cycles, initiate payments as needed, and provide a seamless payment experience for their customers. Whether it's for digital services, content subscriptions, or any other subscription-based model, this API empowers businesses to efficiently manage their subscription billing processes.

In summary, the Charge Subscription API offers a reliable solution for businesses seeking to streamline subscription billing operations, improve payment collection efficiency, and enhance customer communication in the realm of subscription-based services.

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-preproduction.signzy.app/api/v3/eNach/eMandates/{subReferenceId}/charge' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 2.00
}'

Path & Body 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
amount	The amount which will be debited from the customer	Mandatory	Float

Sample Response

{
    "result": {
        "status": "OK",
        "message": "Subscription charge initialized",
        "payment": {
            "paymentId": 122129,
            "cfOrderId": null,
            "referenceId": null,
            "subReferenceId": 110386,
            "currency": "INR",
            "amount": 1,
            "cycle": 1,
            "status": "INITIALIZED",
            "addedOn": "2023-01-19 16:49:49",
            "retryAttempts": 0,
            "remarks": "",
            "failureReason": "",
            "scheduledOn": "2023-01-20",
            "initiatedOn": "2023-01-19",
            "merchantTxnId": "test-txn-id-888"
        }
    }
}

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.cfOrderId	Identifier for the order (custom field)	Nullable
payment.referenceId	Reference identifier for the payment	Nullable
payment.subReferenceId	Sub-reference identifier for the payment	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.addedOn	Timestamp when payment was added	String
payment.retryAttempts	Number of retry attempts for the payment	Integer
payment.remarks	Remarks regarding the payment	String
payment.failureReason	Reason for payment failure (if applicable)	String
payment.scheduledOn	Scheduled date for the payment	String
payment.initiatedOn	Date when the payment was initiated	String
payment.merchantTxnId	Merchant transaction ID associated with payment	String

Sample Errors

{
    "error": {
        "name": "error",
        "message": "",
        "status": "400",
        "reason": "ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}

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]