This API will fetch the response dump for Load API call based on the value of "clientTxnId" field.
Environment
Request Header
This API uses HMAC-SHA512 authentication on the header.
| Parameter | Description |
|---|---|
|
walletIdentifier mandatory |
String Program Type (e.g., CLW)
|
|
date mandatory |
String GMT formatted date (e.g., Thu, 17 Feb 2022 08:17:59 GMT)
|
|
Authorization mandatory |
String HMAC-SHA512-based authentication token
|
|
Content-Type mandatory |
String application/json
|
If you do not post the authentication, you will get error in response. For the list of error codes, refer to Status Codes
hmac authentication logic
hmac username="smsplus", algorithm="sha512", headers="date", signature="7ff938849aa79265a3de63fe241dfecb1c680f58c6d11e9f9ca08512afea374705eb9f8995ef6c4584e16eca2e1dc688262bb0937a36cc0f75ec22a9eea33523"Where, the fields in this example are:
- username: The merchant key of the merchant.
- algorithm: This must have the value as hmac-sha512 that is used for this API.
- headers: This must have the value as date digest.
- signature: This must contain the hmacsha512 of (signing_string, merchant_secret), where:
- signing_string: It must be in the "date: {dateValue}"format. Here, the dateValue is the same values in the fields listed in this table For example, "date: Thu, 17 Feb 2022 08:17:59 GMT"
- merchant_secret: The merchant Salt of the merchant. For more information on getting the merchant Salt, refer to Generate Merchant Key and Salt.
Request parameters
| Parameter | Description | Example |
|---|---|---|
| messageCode mandatory | Numeric(4)API Code to uniquely identify 'Check Status' API. Use only the value 2050 for this API. | 2050 |
| clientTxnId mandatory | String(100)Unique Id generated by the calling application for each transaction. This ID should always be unique in all API Requests. | 20150701235959xhstiesqfdscheck |
| requestDateTime mandatory | Numeric(14)Date of API hit in YYYYMMDDHHMMSS in 24-hour time format. | 20161031214559 |
| verifyclientTxnId mandatory | String(100)The value of "clientTxnId" passed in the request body of the API call for which response dump is needed. | 20150701235959xhstiesqfds |
| fromDate optional | String(10)The starting value for time range in which to search for the transaction, in YYYY-MM-DD format. | 2024-01-01 |
| toDate optional | String(10)The ending value for time range in which to search for the transaction, in YYYY-MM-DD format. | 2024-12-31 |
Sample request
curl --location --request POST 'https://apitest.payu.in/loyalty-points/v1/wallet/check-status' \
--header 'walletIdentifier: CLW' \
--header 'mid: 2' \
--header 'Content-Type: application/json' \
--data-raw '{
"messageCode": "2050",
"clientTxnId": "saddadasda1",
"requestDateTime": "20220302153036",
"verifyclientTxnId": "11111111",
"fromDate": "2024-06-13",
"toDate": "2024-06-13"
}'
Response parameters
| Parameter | Description | Example |
|---|---|---|
messageCodemandatory | Numeric(4)API Code to uniquely identify 'Check Status' API. | 2050 |
clientTxnIdmandatory | String(100)Unique Id generated by the calling application for each transaction. This ID should always be unique in all API Requests. | 20150701235959xhstiesqfdscheck |
responseCodeconditional | String(100)Contains the status of the request. 00 indicates success. | 00 |
responseMessageconditional | String(15)Response message based on response code will be sent. | SUCCESS |
urnconditional | Numeric(6)Unique identifier of a wallet also known as reference number. | 70000000008 |
bankIdconditional | Numeric(4)Bank Id is provided by Prepaid Aero during program enrolment to uniquely identify the wallet issuer. | 7000 |
responseDateTimemandatory | Numeric(14)Response date time in the format YYYYMMDDHHMMSS with time in 24-hour format. | 20230804181306 |
responseDumpmandatory | String(100)Will contain the response dump of the transaction, or error message. | 3591893 |
Sample response
{
"urn": 70000000008,
"responseCode": "00",
"messageCode": 2051,
"clientTxnId": "ChangecardStatus000015",
"bankId": 7000,
"response_dump": [
{
"urn": 70000000008,
"customerId": "128918",
"responseCode": "00",
"messageCode": 3011,
"clientTxnId": "ChangecardStatus000015",
"clientId": "1040",
"responseDateTime": "20230622145005",
"responseMessage": "SUCCESS",
"bankId": 6010,
"accosaRefNo": "41072"
}
]
}