StripeAPI.Types.Balance

Contains the types generated from the schema Balance

Documentation

data Balance

Defines the object schema located at components.schemas.balance in the specification.

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).

The available and pending amounts for each currency are broken down further by payment source types.

Related guide: Understanding Connect Account Balances.

Constructors

Balance

Fields

• balanceAvailable :: [BalanceAmount]

  available: Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the `source_types` property.

• balanceConnectReserved :: Maybe [BalanceAmount]

  connect_reserved: Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.

• balanceInstantAvailable :: Maybe [BalanceAmount]

  instant_available: Funds that can be paid out using Instant Payouts.

• balanceIssuing :: Maybe BalanceDetail

  issuing:

• balanceLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• balancePending :: [BalanceAmount]

  pending: Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property.

Instances

Eq Balance

Defined in StripeAPI.Types.Balance

Methods

(==) :: Balance -> Balance -> Bool

(/=) :: Balance -> Balance -> Bool

Show Balance

Defined in StripeAPI.Types.Balance

Methods

showsPrec :: Int -> Balance -> ShowS

show :: Balance -> String

showList :: [Balance] -> ShowS

ToJSON Balance

Defined in StripeAPI.Types.Balance

Methods

toJSON :: Balance -> Value

toEncoding :: Balance -> Encoding

toJSONList :: [Balance] -> Value

toEncodingList :: [Balance] -> Encoding

FromJSON Balance

Defined in StripeAPI.Types.Balance

Methods

parseJSON :: Value -> Parser Balance

parseJSONList :: Value -> Parser [Balance]

mkBalance

Arguments

:: [BalanceAmount]

balanceAvailable

-> Bool

balanceLivemode

-> [BalanceAmount]

balancePending

-> Balance

Create a new Balance with all required fields.