v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Ingestion

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

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Query parameters

qstring

Free-text search query

amount_minstring

Minimum transaction amount

amount_maxstring

Maximum transaction amount

date_fromstring date-time

Start date filter (RFC 3339 format)

date_tostring date-time

End date filter (RFC 3339 format)

referencestring

Transaction reference (exact match)

currencystring

Currency code filter

source_idstring

Source ID filter

status'UNMATCHED' | 'MATCHED' | 'IGNORED' | 'PENDING_REVIEW'

Transaction status filter

limitinteger

The maximum number of items to include in the response.

offsetinteger

The number of items to skip before returning results.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Search results with offset pagination

totalinteger

Total number of matching transactions

limitinteger

Maximum items per page

offsetinteger

Number of items skipped

Example response

{
  "items": [
    {
      "amount": "1000.50",
      "contextId": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "currency": "BRL",
      "date": "2025-01-15T00:00:00.000Z",
      "description": "Wire transfer from ABC Corp",
      "externalId": "TXN-12345",
      "extractionStatus": "EXTRACTED",
      "id": "019c96a0-10ce-75fc-a273-dc799079a99c",
      "jobId": "019c96a0-10ce-75fc-a273-dc799079a99c",
      "sourceId": "019c96a0-108c-7a74-8e31-3789daffe1ed",
      "status": "PENDING"
    }
  ],
  "limit": 20
}