Skip to main content
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

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Parâmetros de consulta

from
string<date>

Created-from date, inclusive.

Exemplo:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

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

Payments in the SCHEDULED state. This API version never creates one: payment scheduling is out of scope and no payment endpoint accepts a scheduling date, so a non-zero value can only be a scheduled payment reported by the provider — never one you requested. The same rows are also counted under byStatus.SCHEDULED.

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