Skip to main content
GET
Payout balances

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Response

Successful response

currency
string
required
manualPayoutPendingDays
number
required
maxPayoutSumm
number
required
minPayoutSumm
number
required
payoutAvailable
number
required
payoutPending
number
required
withdrawalPeriod
string
required
withdrawalPeriodOptions
object[]
required