Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

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.

      • available.source_types.bank_accountnullable integer

        Amount for bank account.

      • available.source_types.cardnullable integer

        Amount for card.

      • available.source_types.fpxnullable integer

        Amount for FPX.

  • 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.

      • pending.source_types.bank_accountnullable integer

        Amount for bank account.

      • pending.source_types.cardnullable integer

        Amount for card.

      • pending.source_types.fpxnullable integer

        Amount for FPX.

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.

      • connect_reserved.source_types.bank_accountnullable integer

        Amount for bank account.

      • connect_reserved.source_types.cardnullable integer

        Amount for card.

      • connect_reserved.source_types.fpxnullable integer

        Amount for FPX.

  • 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 net balance by source types.

        • instant_available.net_available.source_types.bank_accountnullable integer

          Amount for bank account.

        • instant_available.net_available.source_types.cardnullable integer

          Amount for card.

        • instant_available.net_available.source_types.fpxnullable integer

          Amount for FPX.

    • instant_available.source_typesnullable object

      Breakdown of balance by source types.

      • instant_available.source_types.bank_accountnullable integer

        Amount for bank account.

      • instant_available.source_types.cardnullable integer

        Amount for card.

      • instant_available.source_types.fpxnullable integer

        Amount for FPX.

  • 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.

        • issuing.available.source_types.bank_accountnullable integer

          Amount for bank account.

        • issuing.available.source_types.cardnullable integer

          Amount for card.

        • issuing.available.source_types.fpxnullable integer

          Amount for FPX.

  • livemodeboolean

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

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
      }
    }
  ]
}