The Balance object

Core Resources

Balance

The Balance object

Attributes

availablearray of objects
Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property.
- available.amountinteger
  Balance amount.
- available.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- available.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  available.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  available.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  available.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

pendingarray of objects
Funds that aren’t available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property.
- pending.amountinteger
  Balance amount.
- pending.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- pending.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  pending.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  pending.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  pending.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

More attributes

objectstring
String representing the object’s type. Objects of the same type share the same value.

connect_reservednullable array of objectsConnect only
Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property.
- connect_reserved.amountinteger
  Balance amount.
- connect_reserved.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- connect_reserved.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  connect_reserved.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  connect_reserved.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  connect_reserved.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

instant_availablenullable array of objects
Funds that you can pay out using Instant Payouts.
- instant_available.amountinteger
  Balance amount.
- instant_available.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- instant_available.net_availablenullable array of objectsExpandableConnect only
  Breakdown of balance by destination.
  instant_available.net_available.amountinteger
  Net balance amount, subtracting fees from platform-set pricing.
  instant_available.net_available.destinationstring
  ID of the external account for this net balance (not expandable).
  instant_available.net_available.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  instant_available.net_available.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  instant_available.net_available.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  instant_available.net_available.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.
- instant_available.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  instant_available.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  instant_available.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  instant_available.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

issuingnullable object
Funds that you can spend on your Issued Cards.
- issuing.availablearray of objects
  Funds that are available for use.
  issuing.available.amountinteger
  Balance amount.
  issuing.available.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
  issuing.available.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  issuing.available.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  issuing.available.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  issuing.available.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

refund_and_dispute_prefundingnullable object
Funds to cover future refunds, disputes, or a negative balance. See the Add funds to your Stripe balance guide for more information.
- refund_and_dispute_prefunding.availablearray of objects
  Funds that are available for use.
  refund_and_dispute_prefunding.available.amountinteger
  Balance amount.
  refund_and_dispute_prefunding.available.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
  refund_and_dispute_prefunding.available.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  refund_and_dispute_prefunding.available.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  refund_and_dispute_prefunding.available.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  refund_and_dispute_prefunding.available.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.
- refund_and_dispute_prefunding.pendingarray of objects
  Funds that are pending
  refund_and_dispute_prefunding.pending.amountinteger
  Balance amount.
  refund_and_dispute_prefunding.pending.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
  refund_and_dispute_prefunding.pending.source_typesnullable object
  Breakdown of balance by source types. Funds coming from certain source / payment method types must be shown separately. All payment methods that do not have this restriction will be combined with the card source type balance.
  refund_and_dispute_prefunding.pending.source_types.bank_accountnullable integer
  Amount coming from legacy US ACH payments.
  refund_and_dispute_prefunding.pending.source_types.cardnullable integer
  Amount coming from most payment methods, including cards as well as non-legacy bank debits.
  refund_and_dispute_prefunding.pending.source_types.fpxnullable integer
  Amount coming from FPX, a Malaysian payment method.

The Balance object

{
  "object": "balance",
  "available": [
    {
      "amount": 666670,
      "currency": "usd",
      "source_types": {
        "card": 666670
      }
    }
  ],
  "connect_reserved": [
    {
      "amount": 0,
      "currency": "usd"
    }
  ],
  "livemode": false,
  "pending": [
    {
      "amount": 61414,
      "currency": "usd",
      "source_types": {
        "card": 61414
      }
    }
  ]
}

The Balance object

Attributes

availablearray of objects

available.amountinteger

available.currencyenum

available.source_typesnullable object

available.source_types.bank_accountnullable integer

available.source_types.cardnullable integer

available.source_types.fpxnullable integer

pendingarray of objects

pending.amountinteger

pending.currencyenum

pending.source_typesnullable object

pending.source_types.bank_accountnullable integer

pending.source_types.cardnullable integer

pending.source_types.fpxnullable integer

More attributesCollapse all

objectstring

connect_reservednullable array of objectsConnect only

connect_reserved.amountinteger

connect_reserved.currencyenum

connect_reserved.source_typesnullable object

connect_reserved.source_types.bank_accountnullable integer

connect_reserved.source_types.cardnullable integer

connect_reserved.source_types.fpxnullable integer

instant_availablenullable array of objects

instant_available.amountinteger

instant_available.currencyenum

instant_available.net_availablenullable array of objectsExpandableConnect only

instant_available.net_available.amountinteger

instant_available.net_available.destinationstring

instant_available.net_available.source_typesnullable object

instant_available.net_available.source_types.bank_accountnullable integer

instant_available.net_available.source_types.cardnullable integer

instant_available.net_available.source_types.fpxnullable integer

instant_available.source_typesnullable object

instant_available.source_types.bank_accountnullable integer

instant_available.source_types.cardnullable integer

instant_available.source_types.fpxnullable integer

issuingnullable object

issuing.availablearray of objects

issuing.available.amountinteger

issuing.available.currencyenum

issuing.available.source_typesnullable object

issuing.available.source_types.bank_accountnullable integer

issuing.available.source_types.cardnullable integer

issuing.available.source_types.fpxnullable integer

livemodeboolean

refund_and_dispute_prefundingnullable object

refund_and_dispute_prefunding.availablearray of objects

refund_and_dispute_prefunding.available.amountinteger

refund_and_dispute_prefunding.available.currencyenum

refund_and_dispute_prefunding.available.source_typesnullable object

refund_and_dispute_prefunding.available.source_types.bank_accountnullable integer

refund_and_dispute_prefunding.available.source_types.cardnullable integer

refund_and_dispute_prefunding.available.source_types.fpxnullable integer

refund_and_dispute_prefunding.pendingarray of objects

refund_and_dispute_prefunding.pending.amountinteger

refund_and_dispute_prefunding.pending.currencyenum

refund_and_dispute_prefunding.pending.source_typesnullable object

refund_and_dispute_prefunding.pending.source_types.bank_accountnullable integer

refund_and_dispute_prefunding.pending.source_types.cardnullable integer

refund_and_dispute_prefunding.pending.source_types.fpxnullable integer

More attributes