Skip to main content
GET
Get payment dashboard

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

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.

Query Parameters

from
string<date>

Created-from date, inclusive.

Example:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Example:

"2026-12-31"

type
enum<string>

Payment type filter.

Available options:
BANKSLIP,
UTILITIES,
DARF
Example:

"BANKSLIP"

Response

OK

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

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