Pular para o conteúdo principal
GET
Search transactions

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

contextId
string<uuid>
obrigatório

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

Opções disponíveis:
UNMATCHED,
MATCHED,
IGNORED,
PENDING_REVIEW
limit
integer<int64>
padrão:20

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

Intervalo obrigatório: 1 <= x <= 50
offset
integer<int64>
padrão:0

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

Intervalo obrigatório: x >= 0

Resposta

Search results with offset pagination

items
object[] | null
obrigatório

Matching transactions on this page

limit
integer<int64>
obrigatório

Maximum results per page

Exemplo:

20

offset
integer<int64>
obrigatório

Current offset into the result set

Exemplo:

0

total
integer<int64>
obrigatório

Total number of matching transactions across all pages

Exemplo:

42