Get Payments Insights - Documentação DEVMOB

Authorizations

Authorization

string

header

required

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

Query Parameters

amount

string

Amount range

Example:

">=10;<=50"

createdAt

string

Created at range

Example:

">=2024-01-01;<=2024-12-31"

dueDate

string

Due date range

Example:

">=2024-01-01;<=2024-12-31"

filter

string

Generic filter that matches against

description
customer.name
customer.email

Example:

"Maria"

method

enum<string>

Payment method

Available options:

CASH,

PIX,

CREDIT_CARD,

DEBIT_CARD

Example:

"PIX"

paidAt

string

Paid at range

Example:

">=2024-01-01;<=2024-12-31"

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

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