This API is used to explicitly expire a wallet token, providing merchants with control over token lifecycle management and enhanced security.
Environment
| Environment | URL |
|---|---|
| Test | https://test.mobikwik.com/walletapis/tokenexpire |
| Production | https://walletapi.mobikwik.com/walletapis/tokenexpire |
Method: POST
Content-Type: application/json
Request parameters
| Parameter | Description | Example |
|---|---|---|
expiryReasonmandatory | String Reason for token expiry | User logout |
tokenmandatory | String Token to be expired | MBK_TOKEN_123456789 |
midmandatory | String Unique parent merchant ID | MBK9006 |
cellNomandatory | String Mobile number of the user | 9311032820 |
merchantnamemandatory | String Alias for the merchant | TestMerchant |
aggregatedMerchantIdoptional | String Unique ID for aggregated merchants (For Aggregators Only) | AGG123 |
checksummandatory | String Calculated checksum for validation | calculated_hash |
Response parameters
| Field | Description | Example |
|---|---|---|
| status | String Transaction status | SUCCESS |
| statuscode | String Numeric status code | 0 |
| statusdescription | String Description of the status | Token expired successfully |
| token | String Token that was expired | MBK_TOKEN_123456789 |
| expiryReason | String Reason for expiry | User logout |
| expiredAt | String Timestamp when token was expired | 2025-01-17T10:30:00Z |
| checksum | String Response checksum for validation | 8feac7700a4efd1ef08ea 0ec5bf5921c3f1fc339894 4421978794b9ada1c2c47 |
Response Attributes
The response checksum that will be returned to the users will have the following format:
Note: Always validate the response checksum to ensure data integrity and security.
| Status & Status Code | Status Code | Status description |
| FAILURE | 1 | Failed |
| FAILURE | 17 | Merchant cancelled transaction |
| FAILURE | 16 | User cancelled transaction |
| FAILURE | 20 | Transaction expired |
| FAILURE | 2 | Pending |
| SUCCESS | 0 | Success / Refund / Partial Refund |
Sample response
{
"status": "SUCCESS",
"statuscode": "0",
"statusdescription": "Token expired successfully",
"token": "MBK_TOKEN_123456789",
"expiryReason": "User logout",
"expiredAt": "2025-01-17T10:30:00Z",
"checksum": "8feac7700a4efd1ef08ea0ec5bf5921c3f1fc3398944421978794b9ada1c2c47"
}