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
GET Reference Search
Authorization
Authorization | Bearer Token | Comments |
---|---|---|
Token | Refer to Authentication |
Header
Key | Value | Comments |
---|---|---|
client_id | Your Client ID generated for your Project on the Developer Console | Login to get your Authentication |
Query Params
Key | Values | Comments |
---|---|---|
referencey_type | possible label values : rrn, tran_number, payment_reference | |
reference_id | ||
page_number | 1 | |
Page_size | 20 |
Sample Request Payload
Response Body
Response Parameters | Description | Comments |
---|---|---|
timestamp | time of Search Operation | |
response message | ||
responseCode | transaction number originating from terminal | |
data | Object 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:
Updated 25 days ago
What’s Next