Skip to main content
GET
Get Financial Report Breakdown

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-15"

Query Parameters

account_id
string
required

The owning account ID (a biz_ identifier).

bucket
enum<string>
required

The high-level report bucket to explain.

Available options:
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>
required

Whether to explain money received or money sent.

Available options:
money_in,
money_out
currency
string
required

The report currency to explain.

from
string<date-time>
required

Start of the report window as an ISO 8601 timestamp.

to
string<date-time>
required

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

group_by
enum<string>
default:month

Period grouping used by the parent report.

Available options:
hour,
day,
week,
month
timezone
string

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

Response

breakdown returned

activity_filters
object
required
bucket
enum<string>
required
Available options:
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
Example:

"transfers"

currency
string
required
Example:

"usd"

direction
enum<string>
required
Available options:
money_in,
money_out
Example:

"money_out"

items
object[]
required
Maximum array length: 5
other_amount
object | null
required
other_name
string
required
Example:

"Other"