Validate Token
This endpoint handles the validation of tokens on Cardless. This endpoint should be called during the cashout process. to validate the token before attempting a cashout.
Request Message description
| Field# | Field name | Data type | Max length | Required | Description |
|---|---|---|---|---|---|
| 1 | frontEndPartner | string | yes | Front end partner code to identify client on cardless | |
| 2 | agentId | string | yes | Agent network’s agent Identifier | |
| 3 | domainCode | string | yes | Domain code set up on ISW CORE | |
| 4 | tokenHash | string | yes | SHA512 hash of the token. | |
| 5 | amount | long | yes | (in minor denomination) | |
| 6 | oneTimePin | string | yes | 4 digit PIN | |
| 7 | channel | string | yes | AGENT is the only acceptable channel for this API | |
| 13 | paymentMethodTypeCode | string | yes | MMO is the only acceptable for this channel |
| POST /cardless-service/api/v3/cardless-services/transactions/validate |
<enter headers below>
| Accept application/json Content-Type application/json Authorization Bearer <access_token> |
Sample Request
<enter sample request below>
| { “frontEndPartner” : “codecsystems”, “agentId”: “SMX001”, “domainCode” : “RCG”, “tokenHash” : “f6b6810ad6077d7c900d3f665e21f35fd488508ba2544122e6e0f13625a75ccdfc01e94e37a9d4e7d4a522ac026d2f71c1ed28e83b086645533f59c07d0deba3”, “amount” : “100000”, “oneTimePin” : “1234”, “channel” : “AGENT”, “paymentMethodTypeCode”: “MMO” } |
Sample Response (success)
<enter sample response(success) below>
| { “code”: “00”, “description”: “Approved or completed successfully” } |
Sample Response (failure)
<enter sample response(failure) below>
| { “code”: “12”, “description”: “Invalid transaction” } |
Response Codes
<Enter field description for response>
| Field# | Field name | Description |
|---|---|---|
| 1 | 400524 | Invalid Front End Partner |
| 2 | 400523 | Invalid Domain Code |
| 3 | 58 | Transaction not permitted on terminal |
| 4 | 12 | Invalid transaction |
| 5 | 75 | PIN tries exceeded |
| 6 | 13 | Invalid Amount |
| 7 | 55 | Invalid PIN |
| 8 | 00 | Approved or completed successfully |
Notification
This endpoint is to notify cardless system whether to close the paycode or not. If cashout was successful at client’s end, then 0 should be passed as status, otherwise 1 should be passed as status.
Request Message description
<Enter field description for request below>
| Field# | Field name | Data type | Max length | Required | Description |
|---|---|---|---|---|---|
| frontEndPartner | string | yes | Front end partner code to identify client on cardless | ||
| 1 | tokenHash | string | yes | SHA512 hash of the token. | |
| 2 | status | int | yes | 0 to close transaction, 1 to re-open. | |
| 3 | agentId | string | yes | Agent network’s agent Identifier | |
| 4 | domainCode | string | yes | Domain code set up on ISW CORE |
<enter endpoint below>
| POST /cardless-service/api/v3/cardless-services/transactions/notify |
<enter headers below>
| Accept application/json Content-Type application/json Authorization Bearer <access_token> |
Sample Request
<enter sample request below>
| { “frontEndPartner” : “codecsystems”, “tokenHash” :”38111b2b4a413f5e5fb31e398de2f1714761daaef3629e47483b0615f6d535a796d634319e62b85ddcc449848e7df75f1f83e086c29cb1ce017bad662b33a764″, “status”: 0, “agentId” : “SMX001”, “domainCode”: “RCG” } |
Sample Response (success)
<enter sample response(success) below>
| { “code”: “00”, “description”: “Completed successfully” } |
Sample Response (failure)
<enter sample response(failure) below>
| { “code”: “12”, “description”: “Invalid transaction” } |
Response Codes
<Enter field description for response>
| Field# | Field name | Description |
|---|---|---|
| 1 | 400523 | Invalid Domain Code |
| 2 | 400524 | Invalid Front End Partner |
| 3 | 400525 | Invalid Issuing Front End Partner |
| 4 | 400526 | Invalid Issuing Domain Code |
| 5 | 400527 | Transaction not found or Transaction already closed |
| 6 | 06 | Error logging settlement request. |
| 7 | 00 | Completed successfully. |