A Get Token Status message is a request to get the details of an already generated Token. Please request the context URL from Interswitch.
Get Token Status Request (Sent from Third-party)
The following describes the important element required to be sent for a Get Token Status request.
| S/N | Data Element (DE) | Description | |
| 1 | paycode | Mandatory | Token being queried |
| 2 | subscriberID | Mandatory | Subscriber ID used in token generation |
Sample Request
| GET https://sandbox.interswitchng.com/api/v1/pwm/info/{subscriberID}/tokens
Content-Type: application/json paycode : {paycode} [Other ISW HTTP headers]…Click on this link to see the documentation
{} |
Get Token Status Response (Sent from Interswitch)
The following describes the important data element required for a Get Token Status response.
| S/N | Data Element (DE) | Description |
| 1 | channel | Channel generated token is to be used on e.g. ATM |
| 2 | token | Queried token |
| 3 | Code | Response code of transaction e.g. “0” |
| 4 | Description | Response message of transaction e.g. “Successful” |
| 5 | PaymentMethodCode | A unique Identifier of payment instrument issuer e.g. GTMM, FBN. See Payment Methods in Appendix B |
| 6 | Surcharge | Surcharge on transaction |
| 7 | PaymentMethodIdentifier | Payment Method Identifier |
| 8 | PaymentMethodTypeCode | The type of payment instrument e.g. MMO, QTA, VMP. See “Payment Method Type Codes” in Appendix B for more. |
| 9 | TokenLifeTimeInMinutes | The time this Paycode token should expire |
| 10 | Amount | Transaction amount. |
| 11 | SubscriberID | Customer ID. E.g. 2348012233220 |
| 12 | SettlementCode | Code used for settlement of transaction |
| 13 | Status | Status of queried token e.g. 0 |
| 14 | FrontEndPartner | A unique Identifier of App developer e.g. GTMM. See Front End Partners in Appendix B |
NB: Refer to the APPENDIX for the list of status code and description. The status code is used to determine the status of the paycode generated.
Successful Response
| HTTP Status Code: 200
{ “channel”: “ATM”, “token”: “1260591524”, “code”: “0”, “description”: “Successful”, “paymentMethodCode”: “VEC”, “surcharge”: “10000”, “paymentMethodIdentifier”: “E192F3F3B3BA4596BC9704C44EA801BC”, “paymentMethodTypeCode”: “QTA”, “tokenLifeTimeInMinutes”: “90”, “amount”: “500000”, “subscriberId”: “2348124888436”, “settlementCode”: “3LFANTA”, “status”: “0”, “frontEndPartner”: “455” } |
Unsuccessful Response
| HTTP Status Code: 401
{ “errors”: [ { “code”: “E50”, “message”: “PayCode is Required” } ], “error”: { “code”: “E50”, “message”: “PayCode is Required” } }
HTTP Status Code: 401
{ “errors”: [ { “code”: “400503”, “message”: “The referenced transaction does not exist” } ], “error”: { “code”: “400503”, “message”: “The referenced transaction does not exist” } } |