Pular para o conteúdo principal
GET
Get payment dashboard

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Organization-Id
string

Midaz organization whose payments are aggregated. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Only payments of this organization are counted and summed.

Parâmetros de consulta

from
string

Created-from bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and starts at its first instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T00:00:00-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
Exemplo:

"2026-01-01"

to
string

Created-to bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and covers it to its last instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T23:59:59.999999-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
Exemplo:

"2026-12-31"

type
enum<string>

Payment type filter.

Opções disponíveis:
BANKSLIP,
UTILITIES,
DARF
Exemplo:

"BANKSLIP"

Resposta

OK

byStatus
object
obrigatório
byType
object
obrigatório
totalAmount
string
obrigatório
totalApproved
integer<int64>
obrigatório
totalCanceled
integer<int64>
obrigatório
totalCreated
integer<int64>
obrigatório
totalExecuted
integer<int64>
obrigatório
totalFailed
integer<int64>
obrigatório
totalPendingApproval
integer<int64>
obrigatório
totalRejected
integer<int64>
obrigatório
totalScheduled
integer<int64>
obrigatório

Number of payments in the SCHEDULED state. Payments initiated through this API execute immediately and are not created in this state, so a non-zero value reflects a SCHEDULED state reported by the payment provider. These payments are also counted under byStatus.SCHEDULED.

totalSettled
integer<int64>
obrigatório
totalSettledAmount
string
obrigatório
totalUnconfirmed
integer<int64>
obrigatório

Payments in the UNCONFIRMED state: the outcome at the payment provider is not known yet. A payment whose initiation was answered 202 is counted here until it resolves. The same rows are also counted under byStatus.UNCONFIRMED.