Skip to main content
GET
Get payment dashboard

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

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.

Ejemplo:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Ejemplo:

"2026-12-31"

type
enum<string>

Payment type filter.

Opciones disponibles:
BANKSLIP,
UTILITIES,
DARF
Ejemplo:

"BANKSLIP"

Respuesta

OK

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

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>
requerido
totalSettledAmount
string
requerido