Bulk Search
Bulk Search allows you to search for Multiple transactions at a time.
You start by downloading the sample search template, where you fill in all your requests.
Steps
- Download Template by making the Download Template Call
- Populate the document with the required content: Transaction Date,Stan, Retrieval Referenc Number, Terminal ID, Pan, Merchant ID, Beneficiary Account, Interswitch Reference, Amount
- Save File with a unique name.
Authorization
| Authorization | Bearer Token | Comments |
|---|---|---|
| Token | Refer to Authentication |
Header
| Key | Value | Comments |
|---|---|---|
| ClientId | Your Client ID generated for your Project on the Developer Console | Login to get your Authentication |
GET Download File Template
Response Body
save the response both into a directory and input the transactions to be searched for.
POST Bulk Upload
Request Body
The file in the request body would be the updated file that was downloaded initially that now contains all the search request parameters.
| Key | Values | Comments |
|---|---|---|
| file | filetype | |
Response Body
| Response Parameters | Description | Comments |
|---|---|---|
| SessionId | Uniquely identifies an Upload request. | |
| fileName | Name of the file containing transactions to be searched. | |
| fileContentCount | Number of Transactions that should be searched. | |
| emailAddress | System automatically notifies the email address specified on Search Operation Completion | |
| UserName | who is triggering the search requests | |
| requestDateTime | timestamp on upload request | |
| UpdatedAt | timestamp for when an update occurs on the file in the system. | |
| successfulTransactionSearchCount | this give a summary count of how many transactions were found for all the searches. | |
| failedTransactionsearchCount | this gives a summary of invalid or failed transactions that could not complete processing. | |
| outputFileGenerationStatus | this status tells us whether a final report has been generated for the bulk search request. [PENDING, PROCESSING, COMPLETED] | |
| fileProcessingStatus | this status tells us the processing state of the bulk search request. can be [NEW, PROCESSING, COMPLETED] | |
| bankCode | this is an identifier or a code that represent the institution making this search. | |
| error |
Response Payload
{
"timeStamp": "2024-03-25T13:54:20.242+00:00",
"responseMessage": "Successful",
"responseCode": "202",
"data": {
"sessionId": "a96d5e32-9f1f-4811-a6df-69fe2485c790",
"fileName": "bulk-search-template1711374188656.xlsx",
"fileContentCount": 2,
"emailAddress":"" ,
"userName":"" ,
"requestDateTime": "2024-03-25T13:54:20.128417025",
"updatedAt": "2024-03-25T13:54:20.128429526",
"successfulTransactionSearchCount": 0,
"failedTransactionSearchCount": 0,
"outputFileGenerationStatus": "PENDING",
"fileProcessingStatus": "NEW",
"fileRetryCount": 0,
"bankCode": "ISW"
},
"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"
]
}
Bulk Search Record
This endpoint retrieves the search history for bulk searches performed by a particular user.
<<https://switch-online-gateway-service.k9.isw.la/switch-online-gateway-service/api/v1/bulk/record>
Request Params
| Key | Values | Comments |
|---|---|---|
| page_number | 1 - N | String |
Response Body
| Response Parameters | Description | Comments |
|---|---|---|
| SessionId | Uniquely identifies an Upload request. | |
| fileName | Name of the file containing transactions to be searched. | |
| fileContentCount | Number of Transactions that should be searched. | |
| emailAddress | System automatically notifies the email address specified on Search Operation Completion | |
| UserName | who is triggering the search requests | |
| requestDateTime | timestamp on upload request | |
| UpdatedAt | timestamp for when an update occurs on the file in the system. | |
| successfulTransactionSearchCount | this give a summary count of how many transactions were found for all the searches. | |
| failedTransactionsearchCount | this gives a summary of invalid or failed transactions that could not complete processing. | |
| outputFileGenerationStatus | this status tells us whether a final report has been generated for the bulk search request. [PENDING, PROCESSING, COMPLETED] | |
| fileProcessingStatus | this status tells us the processing state of the bulk search request. can be [NEW, PROCESSING, COMPLETED] | |
| bankCode | this is an identifier or a code that represent the institution making this search. | |
| error | ||
| totalPages | ||
| totalElements | this is the total number of searches carried out by the user. |
Response Payload
{
"timeStamp": "2024-03-26T10:04:38.717+00:00",
"responseMessage": "Successful",
"responseCode": "202",
"data": [
{
"sessionId": "24482ef0-d0fd-4605-9b27-dccb7e8400c6",
"fileName": "bulk-search-template1709323537262.xlsx",
"fileContentCount": 6,
"emailAddress": "",
"userName": "",
"requestDateTime": "2024-03-26T11:01:41.876548",
"updatedAt": "2024-03-26T11:12:00.060239",
"successfulTransactionSearchCount": 13,
"failedTransactionSearchCount": 0,
"outputFileGenerationStatus": "COMPLETED",
"fileProcessingStatus": "COMPLETED",
"fileRetryCount": 0,
"bankCode": "ISW"
}
],
"errors": null,
"totalPages": 1,
"totalElements": 1
}
Check File Status
This endpoint is used to check the status of a particular file.
<https://switch-online-gateway-service.k9.isw.la/switch-online-gateway-service/api/v1/bulk/status
Request Params
| Key | Values | Comments |
|---|---|---|
| session_id | a2005d44-e559-4a33-8115-d0524db7f7be | UUID |
Response Body
| Response Parameters | Description | Comments |
|---|---|---|
| SessionId | Uniquely identifies an Upload request. | |
| fileName | Name of the file containing transactions to be searched. | |
| fileContentCount | Number of Transactions that should be searched. | |
| emailAddress | System automatically notifies the email address specified on Search Operation Completion | |
| UserName | who is triggering the search requests | |
| requestDateTime | timestamp on upload request | |
| UpdatedAt | timestamp for when an update occurs on the file in the system. | |
| successfulTransactionSearchCount | this give a summary count of how many transactions were found for all the searches. | |
| failedTransactionsearchCount | this gives a summary of invalid or failed transactions that could not complete processing. | |
| outputFileGenerationStatus | this status tells us whether a final report has been generated for the bulk search request. [PENDING, PROCESSING, COMPLETED] | |
| fileProcessingStatus | this status tells us the processing state of the bulk search request. can be [NEW, PROCESSING, COMPLETED] | |
| bankCode | this is an identifier or a code that represent the institution making this search. | |
| error | ||
| totalPages | ||
| totalElements | this is the total number of searches carried out by the user. |
Response Payload
{
"timeStamp": "2024-03-26T10:04:38.717+00:00",
"responseMessage": "Successful",
"responseCode": "202",
"data": [
{
"sessionId": "24482ef0-d0fd-4605-9b27-dccb7e8400c6",
"fileName": "bulk-search-template1709323537262.xlsx",
"fileContentCount": 6,
"emailAddress": "",
"userName": "",
"requestDateTime": "2024-03-26T11:01:41.876548",
"updatedAt": "2024-03-26T11:12:00.060239",
"successfulTransactionSearchCount": 13,
"failedTransactionSearchCount": 0,
"outputFileGenerationStatus": "COMPLETED",
"fileProcessingStatus": "COMPLETED",
"fileRetryCount": 0,
"bankCode": "ISW"
}
],
"errors": null,
}
Download Processed File
This endpoint is used to download the result of a bulk search.
<https://switch-online-gateway-service.k9.isw.la/switch-online-gateway-service/api/v1/bulk/download
Request Params
| Key | Values | Comments |
|---|---|---|
| session_id | a2005d44-e559-4a33-8115-d0524db7f7be | UUID |
Response Body
save the response both into a directory and input the transactions to be searched for.
Updated 7 months ago