Transaction Status
Introduction
Introducing the Transaction Status API, an indispensable component within the mandate creation process that revolutionizes the transparency and real-time monitoring of financial transactions. This API serves as a crucial interface, offering unparalleled insights into the status of a transaction ID throughout its lifecycle. As an integral part of the mandate creation workflow, the Transaction Status API empowers users with instant access to comprehensive details, ensuring a seamless and informed experience. Whether confirming the successful execution of a transaction or identifying potential issues, this API provides a vital link in the chain of financial operations, enhancing accountability and efficiency within the mandate creation process. With its real-time transaction tracking capabilities, the Transaction Status API stands at the forefront of financial technology, fostering a heightened level of control and confidence for stakeholders engaged in the dynamic landscape of transaction 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.
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/transactionstatus' \
--header 'Authorization: YOUR_ACCESS_KEY_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{
"txnId": "*******************",
"amount": "8.0",
"email": "*******************",
"phone": "*******************"
}'Input Parameters
Key | Type | Mandatory/Optional | Description |
|---|---|---|---|
txnId | String | Mandatory | The unique transaction ID |
amount | String | Mandatory | The transaction amount |
String | Mandatory | The email address associated with the transaction of the customer | |
phone | String | Mandatory | The phone number associated with the transaction of the customer |
Sample Response
{
"msg": {
"txnId": "648814f29a535202fa53a0c5",
"firstName": "",
"phone": "",
"email": "",
"mode": "NA",
"unmappedstatus": "NA",
"cardCategory": "NA",
"addedon": "2023-06-13 07:04:19",
"paymentSource": "Easebuzz",
"pgType": "NA",
"bankRefNum": "ENA2306131237110766UX7MMC6BXZ2AP",
"bankcode": "NA",
"error": "NA",
"errorMessage": "NA",
"nameOnCard": "NA",
"upiva": "NA",
"cardnum": "NA",
"issuingbank": "NA",
"amount": "1.0",
"netAmountDebit": "0.0",
"cashBackPercentage": "50.0",
"deductionPercentage": "0.0",
"merchantLogo": "NA",
"successCallbackUrl": "https://www.google.com",
"failureCallbackUrl": "https://example.com/failure",
"productinfo": "Test Product",
"signzyId": "E230613CSPV1A0",
"userDefinedField1": "",
"userDefinedField2": "",
"UserDefinedField3": "",
"cardType": "E-NACH",
"status": "success",
"bankName": "NA",
"customerAuthenticationIdd": "648814f29a535202fa53a0c590",
"authorizationStatus": "accepted",
"autoDebitAccessKey": "NA",
"autoDebitAuthError": "NA",
"autoDebitAuthMsg": "Authorization is accepted for verification."
}
}Output Parameters
Key | Type | Description |
|---|---|---|
msg.txnId | String | The unique transaction ID |
msg.firstName | String | The first name associated with the transaction |
msg.phone | String | The phone number associated with the transaction of the customer |
msg.email | String | The email address associated with the transaction of the customers |
msg.mode | String | The mode of the transaction |
msg.unmappedstatus | String | The status of the transaction in the original system |
msg.cardCategory | String | The card category of the transaction |
msg.addedon | String | The date and time when the transaction was added |
msg.paymentSource | String | The source of the payment |
msg.pgType | String | The type of payment gateway used |
msg.bankRefNum | String | The bank reference number for the transaction |
msg.bankcode | String | The bank code associated with the transaction |
msg.error | String | The error code of the transaction, if any |
msg.errorMessage | String | The error message of the transaction, if any |
msg.nameOnCard | String | The name on the card used for the transaction |
msg.upiva | String | The UPI Virtual Address associated with the transaction |
msg.cardnum | String | The card number used for the transaction |
msg.issuingbank | String | The bank that issued the card used for the transaction |
msg.amount | String | The amount of the transaction |
msg.netAmountDebit | String | The net amount debited in the transaction |
msg.cashBackPercentage | String | The percentage of cashback for the transaction |
msg.deductionPercentage | String | The percentage of amount deducted in the transaction |
msg.merchantLogo | String | The merchant logo associated with the transaction |
msg.successCallbackUrl | String | The URL to which the user is redirected after success |
msg.failureCallbackUrl | String | The URL to which the user is redirected after failure |
msg.productinfo | String | Information about the product associated with the transaction |
msg.signzyId | String | The unique Signzy ID |
msg.userDefinedField1 | String | The first user-defined field |
msg.userDefinedField2 | String | The second user-defined field |
msg.UserDefinedField3 | String | The third user-defined field |
msg.cardType | String | The type of card used for the transaction |
msg.status | String | The status of the transaction |
msg.bankName | String | The name of the bank associated with the transaction |
msg.customerAuthenticationIdd | String | The unique ID for customer authentication |
msg.authorizationStatus | String | The status of the transaction authorization |
msg.autoDebitAccessKey | String | The unique auto debit access key |
msg.autoDebitAuthError | String | The error message for auto debit authorization, if any |
msg.autoDebitAuthMsg | String | The authorization message for auto debit |
Sample Errors
{
"error": {
"name": "error",
"message": "Hash mismatch",
"status": 404,
"reason": "ERROR",
"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] |