Pular para o conteúdo principal
GET
Get volume statistics

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

date_from
string<date>

Start date (YYYY-MM-DD) Start date (YYYY-MM-DD), inclusive. Optional: defaults to 30 days before date_to. Window may not exceed 90 days.

date_to
string<date>

End date (YYYY-MM-DD) End date (YYYY-MM-DD), inclusive. Optional: defaults to tomorrow (UTC). Window may not exceed 90 days.

source_id
string<uuid>

Source ID filter

Resposta

Indicates that the request was successful and the response contains the expected data.

matchedAmount
string
obrigatório

Total monetary value of matched transactions, as a decimal string in the source currency.

Exemplo:

"1180000.00"

matchedTransactions
integer<int64>
obrigatório

Number of transactions that were successfully matched.

Exemplo:

11800

periodEnd
string<date-time>
obrigatório

Inclusive end of the reporting window (RFC 3339 timestamp, UTC).

Exemplo:

"2025-01-31T23:59:59Z"

periodStart
string<date-time>
obrigatório

Inclusive start of the reporting window (RFC 3339 timestamp, UTC).

Exemplo:

"2025-01-01T00:00:00Z"

totalAmount
string
obrigatório

Total monetary value of all transactions, as a decimal string in the source currency.

Exemplo:

"1250000.00"

totalTransactions
integer<int64>
obrigatório

Total number of transactions in the reporting window.

Exemplo:

12500

unmatchedAmount
string
obrigatório

Total monetary value of unmatched transactions, as a decimal string in the source currency.

Exemplo:

"70000.00"

unmatchedCount
integer<int64>
obrigatório

Number of transactions left unmatched.

Exemplo:

700