Skip to main content
GET
/
api
/
v1
/
bko
/
reports
/
payments
/
insights
Get Payments Insights
curl --request GET \
  --url https://api.example.com/api/v1/bko/reports/payments/insights \
  --header 'Authorization: Bearer <token>'
{
  "received": 1500000,
  "pending": 300000,
  "refunded": 50000,
  "averageTicket": 7500
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
method
enum<string>

Payment method

Available options:
CASH,
PIX,
CREDIT_CARD,
DEBIT_CARD
Example:

"PIX"

​
organizationId
string<uuid>

Organization identifier

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Payments insights

​
received
integer
required

Received total in cents

Example:

1500000

​
pending
integer
required

Pending total in cents

Example:

300000

​
refunded
integer
required

Refunded total in cents

Example:

50000

​
averageTicket
integer
required

Average paid amount in cents

Example:

7500