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

The Cash balance object 

Payment Methods
Cash Balance
The Cash balance object

Attributes

  • objectstring

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

  • availablenullable associative array

    A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.

  • customerstring

    The ID of the customer whose cash balance this object represents.

  • livemodeboolean

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

  • settingsassociative array

    A hash of settings for this cash balance.

    • settings.reconciliation_modeenum

      The configuration for how funds that land in the customer cash balance are reconciled.

      Possible enum values
      automatic
      manual

    • settings.using_merchant_defaultboolean

      A flag to indicate if reconciliation mode returned is the user’s default or is specific to this customer cash balance

The Cash balance object
{
  "object": "cash_balance",
  "available": {
    "eur": 10000
  },
  "customer": "cus_OaCLf8Fi1nbFpJ",
  "livemode": false,
  "settings": {
    "reconciliation_mode": "automatic",
    "using_merchant_default": true
  }
}