Search SoftPOS Transactions — API
Searches SoftPOS transactions using optional pagination, sorting, and filters, including terminal identifiers, transaction amounts, payment status, transaction ID, RRN, and date/time ranges. Returns matching records with pagination metadata and documented validation and server-error responses.
1. Overview
Retrieves SoftPOS transaction records with optional pagination, sorting, and filtering criteria.
The endpoint supports filtering by terminal identifiers, transaction amount, payment status, transaction ID, Retrieval Reference Number (RRN), date range, and time range.
All search criteria fields are optional. If no filters are provided, transactions are returned without filtering. If pagination parameters are omitted, the service applies its default pagination configuration.
Access Level: Refer to the endpoint's configured access permissions in Swagger.
2. Endpoint Details
| Property | Value |
|---|---|
| HTTP Method | GET |
| Endpoint | /api/v1/transactions/softpos/details-with-receipt-info |
| Production Base URL | https://app-api.edfapay.com |
| Content-Type | Not required for a GET request without a body |
| Accept | */* |
3. Authentication
Include the API key in the request headers.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
4. Query Parameters
The endpoint accepts two query parameter objects: pageProperties and searchCriteria.
4.1 Pagination and Sorting — pageProperties
pagePropertiesConfigures pagination and sort direction.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
pageNumber | Integer | No | Zero-based page number. | 0 |
pageSize | Integer | No | Number of records per page. | 10 |
sortDirection | String | No | Sort direction: ASC or DESC. | DESC |
If omitted, the service uses its default pagination configuration.
Example object:
{
"pageNumber": 0,
"pageSize": 10,
"sortDirection": "DESC"
}4.2 Search Filters — searchCriteria
searchCriteriaAll fields are optional and can be combined to narrow the results.
| Field | Type | Description | Example |
|---|---|---|---|
providerTid | String | Provider terminal identifier. | 5134567890123456 |
trsm | String | Terminal Serial Number. | 4E0001 |
terminalId | UUID | Terminal identifier. | 5bcce22b-b933-4761-b562-8693327e89dd |
amountFrom | Number | Minimum transaction amount. | 10 |
amountTo | Number | Maximum transaction amount. | 100 |
paymentStatus | String | Payment status. Supported values shown in Swagger: APPROVED, DECLINED. | APPROVED |
transactionId | String | Unique transaction identifier. | d841bbe9-c1a4-4e21-aec9-ab8e96a54285 |
rrn | String | Retrieval Reference Number. | 123456789012 |
startDate | String | Start date for the transaction date range. | 2026-08-01 |
endDate | String | End date for the transaction date range. | 2026-08-13 |
startHour | String | Start time for time-based filtering. | 08:00 |
endHour | String | End time for time-based filtering. | 18:00 |
Filtering behavior
- Multiple search criteria can be supplied together.
- Date and time filters can be used independently or together.
- If no search filters are provided, transactions are returned without filtering.
- The documented payment status values are
APPROVEDandDECLINED; consult Swagger for any additional supported values.
5. Request Examples
5.1 cURL — Basic Request
The following illustrates the endpoint and authentication headers. The exact URL encoding for the two query objects must be confirmed using Swagger's Try it out feature.
curl --request GET \
--url 'https://app-api.edfapay.com/api/v1/transactions/softpos/details-with-receipt-info' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'5.2 Pagination Configuration
Example pageProperties object:
{
"pageNumber": 0,
"pageSize": 10,
"sortDirection": "DESC"
}5.3 Search Criteria Example
Example searchCriteria object:
{
"providerTid": "5134567890123456",
"trsm": "4E0001",
"terminalId": "5bcce22b-b933-4761-b562-8693327e89dd",
"amountFrom": 10,
"amountTo": 100,
"paymentStatus": "APPROVED",
"transactionId": "d841bbe9-c1a4-4e21-aec9-ab8e96a54285",
"rrn": "123456789012",
"startDate": "2026-08-01",
"endDate": "2026-08-13",
"startHour": "08:00",
"endHour": "18:00"
}Important implementation note: Swagger defines pageProperties and searchCriteria as query parameter objects. The precise serialization of these objects into the URL is not established by the supplied reference. Use Swagger's Try it out feature to generate the correct request URL rather than assuming a JSON body or a particular query parameter encoding.
6. Responses
6.1 HTTP 200 — Success
Description: SoftPOS transactions retrieved successfully.
The response uses a standard envelope with a paginated transaction result.
Example response schema:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {
"totalPages": 0,
"totalElements": 0,
"size": 0,
"content": [
{}
],
"number": 0,
"pageable": {
"offset": 0,
"paged": true,
"pageNumber": 0,
"pageSize": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"unpaged": true
},
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}
}Response fields
| Field | Description |
|---|---|
code | API response code. |
message | Response message. |
errorCode | Error identifier, where applicable. |
data.totalPages | Total number of result pages. |
data.totalElements | Total number of matching records. |
data.size | Page size reported by the response. |
data.content | Array containing the transaction records. The supplied schema does not specify the fields within each record. |
data.number | Current page number. |
data.pageable | Pagination configuration and metadata. |
data.sort | Sorting metadata. |
data.numberOfElements | Number of records in the current page. |
data.first | Indicates whether the current page is the first page. |
data.last | Indicates whether the current page is the last page. |
data.empty | Indicates whether the current page contains no records. |
6.2 HTTP 400 — Invalid Pagination or Search Criteria
Description: The supplied pagination settings or search criteria are invalid.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}The values shown are Swagger placeholders, not guaranteed runtime values.
6.3 HTTP 500 — Internal Server Error
Description: An internal server error occurred while processing the request.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}The supplied documentation shows a paginated response schema for this status as well. Confirm the actual error payload from the live API if implementing error handling.
7. Implementation Notes
- Use
pageNumber: 0for the first page when explicitly configuring pagination. - Choose an appropriate
pageSizeto control the number of records returned per request. - Use
sortDirectionwithASCorDESC. - Combine filters when searching for transactions with specific terminal, amount, status, identifier, date, or time attributes.
- Validate UUID and date formats before submitting requests.
- Use Swagger's Try it out feature to confirm query-object serialization.
- Handle HTTP
400and500responses separately from successful results. - The supplied response schema does not define the individual fields in
data.content; use the endpoint's detailed schema when available.
8. Summary
This endpoint provides a paginated and filterable search interface for SoftPOS transactions, supporting terminal-based searches, transaction identifiers, amount ranges, payment status, and date/time filters.
Updated 25 days ago