Saltar al contenido principal
GET
Search transactions

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

Search results with offset pagination

items
object[] | null
requerido

Matching transactions on this page

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