Search transactions
Use the search endpoint to retrieve transactions that match specific criteria.
GET /api/transactions/search
Provide query parameters in the request URL to filter the results.
For example, to search for transactions with an ExternalReference1 value of ABC-123:
GET /api/transactions/search?ExternalReference1=ABC-123
Query parameters
You can only use the following query parameters to filter transactions:
| Field | Type |
|---|---|
ExternalReference1 | String |
ExternalReference2 | String |
ExternalReference3 | String |
Merchant | String |
SendCurrency | String |
SendValue | Decimal |
ReceiveValue | Decimal |
Recipient.Name | String |
Recipient.RecipientReference | String |
Status | String |
TransactionCreatedUTC | DateTime |
All other fields in TransactionResponse are ignored when querying transactions.
Query rules
String fields
String fields use case-insensitive exact matching. You do not need to enclose strings in quotation marks.
The API does not support partial or wildcard searches.
Numeric and date fields
Numeric and date fields support range queries using the Min and Max suffix.
For example:
SendValueMinandSendValueMaxTransactionCreatedUTCMinandTransactionCreatedUTCMax
You must provide dates in UTC.
Search response
The API returns a paginated result set.
{
"HasMoreResults": true,
"ContinuationToken": "string",
"Results": [...]
}| Field | Description |
|---|---|
Results | Array of transactions matching the query |
HasMoreResults | Indicates whether additional results are available |
ContinuationToken | Token used to retrieve the next page of results |
Each transaction in Results uses the same format returned by the transaction retrieval endpoint.
For the full schema, see TransactionResponse.
Example queries
Search by external reference
Retrieve transactions using your own reference value.
GET /api/transactions/search?ExternalReference1=XXX-YYY
Search by transaction value
Retrieve transactions where the send value is greater than or equal to £500.
GET /api/transactions/search?SendCurrency=GBP&SendValueMin=500
To search for transactions between £500 and £1000:
GET /api/transactions/search?SendCurrency=GBP&SendValueMin=500&SendValueMax=1000
Search by date range
Each transaction includes a TransactionCreatedUTC timestamp.
Use this field to search within a time period.
GET /api/transactions/search?TransactionCreatedUTCMin=2025-12-15&TransactionCreatedUTCMax=2026-01-01
Pagination
The API returns results in pages.
By default, each response contains up to 100 transactions.
To retrieve additional results, include the ContinuationToken from the previous response as a header:
GET /api/transactions/search
ContinuationToken: <token>When using a continuation token:
- You do not need to resend the original query parameters
- The API returns the next page of results
- The response may contain a new continuation token
Updated 24 days ago