Reference Search

Reference Search allows you to search with only one Transaction ID at a time.

This is typically ideal for where you have an Identifier for that transaction.

This could be a:

-Retrieval Reference Number (RRN)

-Settlement Transaction ID

-Payment Reference Number

POST Reference Search

πŸ‘

<<https://switch-online-gateway-service.k9.isw.la/switch-online-gateway-service/api/v1/gateway/reference-search>

Authorization

AuthorizationBearer TokenComments
TokenRefer to Authentication

Header

KeyValueComments
ClientIdYour Client ID generated for your Project on the Developer ConsoleLogin to get your Authentication

Query Params

KeyValuesComments
reference_typepossible label values : rrn, tran_number, payment_reference
reference_id
page_number1
Page_size20
start_date
end_date

Request Body

KeyValuesComments
cursorvalue to send in your next request, so you can query the next set of dataFirst Call leave cursor blank

Sample Request Payload

{
    "cursor": "eyJwYWdpbmdTdGF0ZSI6IkFBQUFBT29IQUFBa0FBQUFBZ0FBQUFnQUFBQUFBQUdMQWRyVEFBd0FBQUF3TURBd01EQXdNREF3TWpJQllRQUFBQWNBQUFBSUFBQUFNbFJGVUVkYVJFRVRBQUFBTlRBMk1URTRLaW9xS2lvcUtpb3FOek00TkFZQUFBQXdNREF3TWpJSUFBQUFBQUFBQUFEVm40QUVBQUFBTURJd01BZ0FBQUFBQUVsWmNqVWJRQWdBQUFBQUFBQUV0M21HZk92Ly8vKzlSNlVDR0xrV3IxcWNaenJXNWcrZ0dBQUFBRGtBQUFBQkdRQUFBQlFBQUFBQkFBQUFDQUFBQUtSU1k4VW9KNmRTQVFFWkFBQUFGQUFBQUFFQUFBQUlBQUFBcEZKanhTZ25wMUlCQVFFQUFBQUNUMVdJV3pmeHFNUHhyL3lUc0Q2Uk9RQUFBQUVaQUFBQUZBQUFBQUVBQUFBSUFBQUFEaUxnUUpNUjcrd0JBUmtBQUFBVUFBQUFBUUFBQUFnQUFBQU9JdUJBa3hIdjdBRUJBUUFBQUFKUFZZaGJOL0dvdy9Hdi9KT3dQcEU1QUFBQUFSa0FBQUFVQUFBQUFRQUFBQWdBQUFESUZCcjhlVUMyUkFFQkdRQUFBQlFBQUFBQkFBQUFDQUFBQU1nVUd2eDVRTFpFQVFFQkFBQUFBazlWaUZzMzhhakQ4YS84azdBK2tUa0FBQUFCR1FBQUFCUUFBQUFCQUFBQUNBQUFBQWdNdllzTHlnSStBUUVaQUFBQUZBQUFBQUVBQUFBSUFBQUFDQXk5aXd2S0FqNEJBUUVBQUFBQ1QxV0lXemZ4cU1QeHIveVRzRDZST1FBQUFBRVpBQUFBRkFBQUFBRUFBQUFJQUFBQWNGdXRpeThFNkxFQkFSa0FBQUFVQUFBQUFRQUFBQWdBQUFCd1c2MkxMd1Rvc1FFQkFRQUFBQUpQVlloYk4vR293L0d2L0pPd1BwRTVBQUFBQVJrQUFBQVVBQUFBQVFBQUFBZ0FBQUFsT1VHZnNjeUNPZ0VCR1FBQUFCUUFBQUFCQUFBQUNBQUFBQ1U1UVoreHpJSTZBUUVCQUFBQUFrOVZpRnMzOGFqRDhhLzhrN0Era1RrQUFBQUJHUUFBQUJRQUFBQUJBQUFBQ0FBQUFJVTVQNFBnbDYzUUFRRVpBQUFBRkFBQUFBRUFBQUFJQUFBQWhUay9nK0NYcmRBQkFRRUFBQUFDVDFXSVd6ZnhxTVB4ci95VHNENlJPUUFBQUFFWkFBQUFGQUFBQUFFQUFBQUlBQUFBNXBVVUs0Vy9iQndCQVJrQUFBQVVBQUFBQVFBQUFBZ0FBQURtbFJRcmhiOXNIQUVCQVFBQUFBSlBWWWhiTi9Hb3cvR3YvSk93UHBFNUFBQUFBUmtBQUFBVUFBQUFBUUFBQUFnQUFBQUg0Rm5VT0hHMWZ3RUJHUUFBQUJRQUFBQUJBQUFBQ0FBQUFBZmdXZFE0Y2JWL0FRRUJBQUFBTUVOQTNHeC9WNlBiYUU5eUVnWjZ1emtBQUFBQkdRQUFBQlFBQUFBQkFBQUFDQUFBQUVnQUlmUUJsRk12QVFFWkFBQUFGQUFBQUFFQUFBQUlBQUFBU0FBaDlBR1VVeThCQVFFQUFBQXdRMERjYkg5WG85dG9UM0lTQm5xN09RQUFBQUVaQUFBQUZBQUFBQUVBQUFBSUFBQUF6SkVjK1pkTVpnc0JBUmtBQUFBVUFBQUFBUUFBQUFnQUFBRE1rUno1bDB4bUN3RUJBUUFBQURCRFFOeHNmMWVqMjJoUGNoSUdlcnM1QUFBQUFSa0FBQUFVQUFBQUFRQUFBQWdBQUFCSCtVbWUwWkRZZ2dFQkdRQUFBQlFBQUFBQkFBQUFDQUFBQUVmNVNaN1JrTmlDQVFFQkFBQUFBazlWaUZzMzhhakQ4YS84azdBK2tUa0FBQUFCR1FBQUFCUUFBQUFCQUFBQUNBQUFBTmJYRENnYTRocGpBUUVaQUFBQUZBQUFBQUVBQUFBSUFBQUExdGNNS0JyaUdtTUJBUUVBQUFBd1EwRGNiSDlYbzl0b1QzSVNCbnE3T1FBQUFBRVpBQUFBRkFBQUFBRUFBQUFJQUFBQVU1MjlsRTVKVXdzQkFSa0FBQUFVQUFBQUFRQUFBQWdBQUFCVG5iMlVUa2xUQ3dFQkFRQUFBQUpQVlloYk4vR293L0d2L0pPd1BwRTVBQUFBQVJrQUFBQVVBQUFBQVFBQUFBZ0FBQURxZmMwQ2FBSFdnUUVCR1FBQUFCUUFBQUFCQUFBQUNBQUFBT3A5elFKb0FkYUJBUUVCQUFBQUFrOVZpRnMzOGFqRDhhLzhrN0Era1RrQUFBQUJHUUFBQUJRQUFBQUJBQUFBQ0FBQUFMTW40cVl3SE5XSEFRRVpBQUFBRkFBQUFBRUFBQUFJQUFBQXN5ZmlwakFjMVljQkFRRUFBQUF3UTBEY2JIOVhvOXRvVDNJU0JucTdPUUFBQUFFWkFBQUFGQUFBQUFFQUFBQUlBQUFBK1cvQzhycVB1aEVCQVJrQUFBQVVBQUFBQVFBQUFBZ0FBQUQ1YjhMeXVvKzZFUUVCQVFBQUFBSlBWWWhiTi9Hb3cvR3YvSk93UHBFNUFBQUFBUmtBQUFBVUFBQUFBUUFBQUFnQUFBQ25ubDNyQi9WdmhRRUJHUUFBQUJRQUFBQUJBQUFBQ0FBQUFLZWVYZXNIOVcrRkFRRUJBQUFBQWs5VmlGczM4YWpEOGEvOGs3QStrVGtBQUFBQkdRQUFBQlFBQUFBQkFBQUFDQUFBQU5RTnprakc5U2I0QVFFWkFBQUFGQUFBQUFFQUFBQUlBQUFBMUEzT1NNYjFKdmdCQVFFQUFBQUNUMVdJV3pmeHFNUHhyL3lUc0Q2Uk9RQUFBQUVaQUFBQUZBQUFBQUVBQUFBSUFBQUEzZlJJZTRmamt4QUJBUmtBQUFBVUFBQUFBUUFBQUFnQUFBRGQ5RWg3aCtPVEVBRUJBUUFBQUFKUFZZaGJOL0dvdy9Hdi9KT3dQcEU1QUFBQUFSa0FBQUFVQUFBQUFRQUFBQWdBQUFBWEM2QzhJalVjT2dFQkdRQUFBQlFBQUFBQkFBQUFDQUFBQUJjTG9Md2lOUnc2QVFFQkFBQUFBazlWaUZzMzhhakQ4YS84azdBK2tUa0FBQUFCR1FBQUFCUUFBQUFCQUFBQUNBQUFBTm8rN2h3eWFuYnZBUUVaQUFBQUZBQUFBQUVBQUFBSUFBQUEyajd1SERKcWR1OEJBUUVBQUFBQ1QxV0lXemZ4cU1QeHIveVRzRDZST1FBQUFBRVpBQUFBRkFBQUFBRUFBQUFJQUFBQTFtcVpVTEtsKzc0QkFSa0FBQUFVQUFBQUFRQUFBQWdBQUFEV2FwbFFzcVg3dmdFQkFRQUFBREJEUU54c2YxZWoyMmhQY2hJR2VyczVBQUFBQVJrQUFBQVVBQUFBQVFBQUFBZ0FBQUNEanhFZEg2cU55QUVCR1FBQUFCUUFBQUFCQUFBQUNBQUFBSU9QRVIwZnFvM0lBUUVCQUFBQUFrOVZpRnMzOGFqRDhhLzhrN0Era1FFQUFBQUFBUC8vLy84QUFBQUFBQUlcdTAwM2QiLCJyZW1haW5pbmdNYXRjaGluZ0RhdGEiOltdLCJwcmV2aW91c1BhZ2VOdW1iZXIiOjF9"
}

Response Body

Response ParametersDescriptionComments
timestamptime of Search Operation
response message
responseCodetransaction number originating from terminal
dataObject containing some information for a transaction.The transaction_id in is then used to get details for the transaction. See how it's done here

Response Payload

{  
    "timeStamp": "2023-11-07T15:50:42.614+00:00",  
    "responseMessage": "Transactions Received Successfully",  
    "responseCode": "202",  
    "dataSize": 1,  
    "totalPages": 1,  
    "pageNumber": 1,  
    "pageSize": 20,  
    "data": [  
        {  
            "retrieval_reference_number": "696843517287",  
            "merchant_code": "2057LA200002957",  
            "masked_pan": "519911******3279",  
            "terminal_id": "20573ZLY",  
            "stan": "373758",  
            "unique_reference": "95aa59d0-77fb-11ee-a39f-f7013f7f10c0",  
            "transaction_date": "2023-10-09",  
            "transaction_amount": 210000,  
            "beneficiary_account": null,  
            "transaction_id": "958804c0-77fb-11ee-a39f-f7013f7f10c0",  
            "acquirer_code": "ZIB",  
            "issuer_code": "GTB"  
        }  
    ],  
    "errors": null  
}

πŸ‘

To get the Full Transaction Details. Use the transaction_id value in the response payload to make a Get Transaction Details call

You can Test out the API call directly here:

Response Payload (WITH ERROR)

{
    "timeStamp": "2024-03-25T13:30:37.164+00:00",
    "responseMessage": "Page Size cannot be greater than 20",
    "responseCode": "400",
    "data": null,
    "errors": [
        "Page Size cannot be greater than 20"
    ]
}

What’s Next