Search transactions

Use this endpoint to search transactions within a reconciliation context. Supports free-text search, amount range filters, date filters, and status filters with offset-based pagination.

GET /v1/imports/contexts/{contextId}/transactions/search

Search transactions

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/imports/contexts/{contextId}/transactions/search \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "items": [
    {
      "amount": "1000.50",
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "currency": "USD",
      "date": "2025-01-15T00:00:00Z",
      "dedupeKey": "v1|external_id=9:TXN-12345",
      "externalId": "TXN-12345",
      "extractionStatus": "COMPLETE",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "sourceId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "UNMATCHED",
      "description": "Wire transfer from ABC Corp",
      "metadata": {}
    }
  ],
  "limit": 20,
  "offset": 0,
  "total": 42
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

Parámetros de consulta

q · string

Free-text search query Free text search across external ID and description

amount_min · string

Minimum transaction amount

amount_max · string

Maximum transaction amount

date_from · string<date-time>

Start date filter (RFC 3339 format) Start date filter (RFC3339)

date_to · string<date-time>

End date filter (RFC 3339 format) End date filter (RFC3339)

reference · string

Transaction reference (exact match) Exact external ID match

currency · string

Currency code filter

source_id · string

Source ID filter Source ID filter (UUID)

status · enum<string>

Transaction status filter

Opciones disponibles: UNMATCHED, MATCHED, IGNORED, PENDING_REVIEW

limit · integer<int64> · predeterminado: 20

The maximum number of items to include in the response. Maximum number of records to return

Rango requerido: 1 <= x <= 50

offset · integer<int64> · predeterminado: 0

The number of items to skip before returning results. Number of records to skip

Rango requerido: x >= 0

Respuesta

200

application/json

Search results with offset pagination

items · object[] | null · requerido

Matching transactions on this page

Show child attributes

limit · integer<int64> · requerido

Maximum results per page

Ejemplo:

20

offset · integer<int64> · requerido

Current offset into the result set

Ejemplo:

0

total · integer<int64> · requerido

Total number of matching transactions across all pages

Ejemplo:

42