Skip to main content
GET
Get Financial Report Breakdown

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:balance:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de consulta

account_id
string
requerido

The owning account ID (a biz_ identifier).

bucket
enum<string>
requerido

The high-level report bucket to explain.

Opciones disponibles:
transfers,
payments,
refunds,
ads,
application_fees,
card_spend,
card_authorization_releases,
withdrawals,
withdrawal_markup,
platform_markup,
clawbacks,
disputes,
affiliate_earnings,
affiliate_payouts,
revenue_share,
swaps,
card_loads
direction
enum<string>
requerido

Whether to explain money received or money sent.

Opciones disponibles:
money_in,
money_out
currency
string
requerido

The report currency to explain.

from
string<date-time>
requerido

Start of the report window as an ISO 8601 timestamp.

to
string<date-time>
requerido

Exclusive end of the report window as an ISO 8601 timestamp.

group_by
enum<string>
predeterminado:month

Period grouping used by the parent report.

Opciones disponibles:
hour,
day,
week,
month
timezone
string

IANA timezone used by the parent report to bucket periods. Defaults to UTC.

Respuesta

breakdown returned

activity_filters
object
requerido
bucket
enum<string>
requerido
Opciones disponibles:
transfers,
payments,
refunds,
ads,
application_fees,
card_spend,
card_authorization_releases,
withdrawals,
withdrawal_markup,
platform_markup,
clawbacks,
disputes,
affiliate_earnings,
affiliate_payouts,
revenue_share,
swaps,
card_loads
Ejemplo:

"transfers"

currency
string
requerido
Ejemplo:

"usd"

direction
enum<string>
requerido
Opciones disponibles:
money_in,
money_out
Ejemplo:

"money_out"

items
object[]
requerido
Maximum array length: 5
other_amount
object | null
requerido
other_name
string
requerido
Ejemplo:

"Other"