Check Wallet Balance API (eStamping)
Introduction
Embark on a journey of financial empowerment with the cutting-edge Signzy system, where clients can effortlessly monitor their wallet balance. By simply crediting a stamp or a challan, clients gain the remarkable ability to unlock a wealth of financial insights within the Signzy ecosystem. The secret lies in the ingenious use of the "Parameter type," a powerful identifier that allows clients to seamlessly retrieve their eStamp or eChallan wallet, providing a comprehensive view of their available funds. Say goodbye to uncertainty and embrace a world where financial visibility is at your fingertips, courtesy of Signzy's intuitive and secure platform.
Client can check their wallet balance in signzy system once they have credited stamp/challan. Parameter type is used to identify the eStamp or eChallan wallet to be fetched.
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call.
API Details
The details of the API can be found here.
Sample cURL (For One Touch Sign Product)
curl --location 'https://api-preproduction.signzy.app/api/v3/contract/eStamp/walletBalance' \
--header 'Authorization: *********************************' \
--header 'Content-Type: application/json' \
--data '{
"type": "eChallan"
}'Sample cURL (For Contracting SDK Product)
curl --location --request POST 'https://contracting-preproduction.signzy.tech/api/customers/<<<customerId>>>/estamp/walletBalance' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "..eStamp/eChallan.."
}'
Input Parameters
PARAMETERS | DESCRIPTION | TYPE | MANDATORY/OPTIONAL |
|---|---|---|---|
type | eStamp or eChallan By default eStamp will be used | String | Mandatory |
Sample Response
{
"result": {
"logFile": "...logFile..."
}
}Output Parameters
PARAMETERS | TYPE | DESCRIPTION |
|---|---|---|
logFile | String | CSV file |
The following terms are used in CSV reports.
- firstParty- Name of First Party
- challanNo - eChallan no which have the balance left
- State Code - State code for the eChallan
- ArticleCode - Article code for the eChallan
- initialBalance - The uploaded amount
- currentBalance- Amount present in the challan.
- denomination- Value of stamp
- StampFile : stamp file
Sample Error
{
"name": "error",
"message": "",
"reason": "VALIDATION_ERROR",
"type": "Bad Request",
"statusCode": 400
}Error Parameter
Parameter | Type | Description |
|---|---|---|
name | String | In case of errors, it will have the value "error". It represents an error. |
message | String | Message for the error |
reason | String | Reasons for the error |
type | String | Type of error |
statusCode | String | Status code of the error |
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 | Not found |
500 | Internal Server Error | Internal error at Signzy, Please reach out to [email protected] |