Cash Balance 

A customer’s Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.

The Cash balance object 

Attributes

  • objectstring

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

  • availablenullable object

    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.

  • settingsobject

    A hash of settings for this 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
}
}

Update a cash balance's settings 

Changes the settings on a customer’s cash balance.

Parameters

  • settingsobject

    A hash of settings for this cash balance.

Returns

The customer’s cash balance, with the updated settings.

POST /v1/customers/:id/cash_balance
curl https://api.stripe.com/v1/customers/cus_Ob4Xiw8KXOqcvM/cash_balance \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d "settings[reconciliation_mode]"=manual
Response
{
"object": "cash_balance",
"available": null,
"customer": "cus_Ob4Xiw8KXOqcvM",
"livemode": false,
"settings": {
"reconciliation_mode": "manual",
"using_merchant_default": false
}
}

Retrieve a cash balance 

Retrieves a customer’s cash balance.

Parameters

No parameters.

Returns

The Cash Balance object for a given customer.

GET /v1/customers/:id/cash_balance
curl https://api.stripe.com/v1/customers/cus_OaCLf8Fi1nbFpJ/cash_balance \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"object": "cash_balance",
"available": {
"eur": 10000
},
"customer": "cus_OaCLf8Fi1nbFpJ",
"livemode": false,
"settings": {
"reconciliation_mode": "automatic",
"using_merchant_default": true
}
}

Cash Balance Transaction 

Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.