AccountBalances

Balance of the current account in one currency. The account has one balance per currency. All amounts are in the smallest currency unit (cents for EUR). The dashboard shows totalAmount as "Available balance in <currency>" in Settings > Payouts > Account balance.

type AccountBalances {
  accountId: ID!
  currency: String!
  clearedAmount: Int!
  outstandingAmount: Int!
  totalAmount: Int!
  createdAt: String!
  updatedAt: String
}

Fields

AccountBalances.accountId ● ID! non-null scalar

ID of the account the balance belongs to.

AccountBalances.currency ● String! non-null scalar

Three-letter ISO 4217 currency code of the balance.

AccountBalances.clearedAmount ● Int! non-null scalar

Cleared part of the balance, in the smallest currency unit.

AccountBalances.outstandingAmount ● Int! non-null scalar

Part of the balance that is not cleared yet, in the smallest currency unit. A payout (PAYOUT transaction) subtracts its amount here and from totalAmount, so this value can be negative. A payout that fails adds the amount back.

AccountBalances.totalAmount ● Int! non-null scalar

Whole balance: clearedAmount + outstandingAmount, in the smallest currency unit. A payout fails with the error Insufficient balance to process the payout when its amount is greater than this value. Shown as "Available balance in <currency>".

AccountBalances.createdAt ● String! non-null scalar

Time the balance was created, as an ISO 8601 date-time.

AccountBalances.updatedAt ● String scalar

Time of the last change to the balance, as an ISO 8601 date-time.

Member Of

AccountBalancesConnection object