Search transactions

Retrieve transactions that match specified criteria.

GET /api/transactions/search

For full request and response details, see Search transactions.

Search criteria

Use query parameters to filter transactions.

Query rules

• Match string fields using case-insensitive exact matching.
• Enter string values without quotation marks.
• Use the Min and Max suffix to search numeric and date ranges.
• Provide all dates in UTC.
• Do not use partial or wildcard searches.

For example:

• SendValueMin and SendValueMax
• ReceiveValueMin and ReceiveValueMax
• TransactionCreatedUTCMin and TransactionCreatedUTCMax

Common search criteria

Common search criteria include:

Example request

For an initial call:

GET /api/transactions/search?ExternalReference1=CLM-5838386

The API returns a paginated result set.

A subsequent call may look like the following:

GET /api/transactions/search
ContinuationToken: eyJvZmZzZXQiOjEwMH0=

Example response (truncated)

{
  "HasMoreResults": true,
  "ContinuationToken": "eyJvZmZzZXQiOjEwMH0=",
  "Results": [
    {
      "TransactionId": "747101ce-2d0c-41bd-ae4a-ba5a0c267c70",
      "Status": "Succeeded",
      "ExternalReference1": "CLM-5838386",
      "SendCurrency": "USD",
      "SendValue": 2942.00,
      "Merchant": "Blue Plain Insurance",
      "Recipient": {
        "Country": "US",
        "Currency": "USD",
        "Name": "Victoria Lau",
        "RecipientReference": "Claim payment"
      }
    }
  ]
}

Understanding the response

The response includes:

• HasMoreResults – indicates whether additional results are available
• ContinuationToken – token used to retrieve the next page of results
• Results – matching transactions returned as ExternalTransaction objects

Use the returned TransactionId to retrieve the full transaction details.

For more information, see Retrieve a transaction.

Pagination

Transactions are returned in pages.

By default, each response contains up to 100 transactions.

If additional results are available, the response includes a ContinuationToken.

Use the continuation token to retrieve the next page of results.

Example request

GET /api/transactions/search ContinuationToken: eyJvZmZzZXQiOjEwMH0=

When using a continuation token:

• Do not resend the original query parameters
• The API returns the next page of results
• The response may contain a new continuation token