Recurring Payments

Get Single Subscription Payment Details

Introduction
The "Get Single Subscription Payment Details" API offers a focused solution for retrieving specific payment details associated with a subscription. This API allows users to target and retrieve information about a particular payment transaction within a subscription. By providing the unique payment ID or other identifiers, users can efficiently access comprehensive details such as payment amount, currency, status, timestamps, and any relevant remarks or failure reasons associated with the payment. This targeted approach streamlines the process of accessing payment information, enabling precise tracking and analysis of individual payment transactions within the subscription framework.
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 'https://api-preproduction.signzy.app/api/v3/eNach/eMandates/{subReferenceId}/payments/{paymentId}' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--data ''
curl --location 'https://api-preproduction.signzy.app/api/v3/eNach/eMandates/{subReferenceId}/payments/{paymentId}' \
--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 Payment",
        "payment": {
            "paymentId": 2276563,
            "referenceId": 214308920,
            "cfOrderId": 236286405,
            "orderId": "ORD_24534",
            "subReferenceId": 5513463,
            "currency": "INR",
            "amount": 250,
            "cycle": 5,
            "status": "INITIALIZED",
            "remarks": null,
            "scheduledOn": "2021-09-13",
            "addedOn": "2021-09-09 11:05:19",
            "retryAttempts": 0,
            "failureReason": null
        }
    }
}
{
    "result": {
        "status": "OK",
        "message": "Subscription Payment",
        "payment": {
            "paymentId": 2276563,
            "referenceId": 214308920,
            "cfOrderId": 236286405,
            "orderId": "ORD_24534",
            "subReferenceId": 5513463,
            "currency": "INR",
            "amount": 250,
            "cycle": 5,
            "status": "INITIALIZED",
            "remarks": null,
            "scheduledOn": "2021-09-13",
            "addedOn": "2021-09-09 11:05:19",
            "retryAttempts": 0,
            "failureReason": null
        }
    }
}
﻿
Output Parameters
Key
Description
Type
result
Result object
Object
result.status
Status of the result
String
result.message
Message of the result
String
result.payment
Payment details
Object
payment
Payment object
Object
payment.paymentId
Payment ID
Integer
payment.referenceId
Reference ID
Integer
payment.cfOrderId
Custom field order ID
Integer
payment.orderId
Order ID
String
payment.subReferenceId
Subscription reference ID
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 about the payment
String
payment.scheduledOn
Scheduled date
String
payment.addedOn
Date added
String
payment.retryAttempts
Number of retry attempts
Integer
payment.failureReason
Reason for failure
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]
﻿

Get Subscription Details

Get All Subscription Payment Details

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

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]