Cash Balances
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.
Was this section helpful? Yes No
Update a cash balance's settings
POST / v1 / customers /:id / cash_balance
Retrieve a cash balance
GET / v1 / customers /:id / cash_balance
The Cash balance object
Attributes
- object string, value is "cash_balance" String representing the object’s type. Objects of the same type share the same value.
- available nullable map 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.
- customer string The ID of the customer whose cash balance this object represents.
- customer _ account nullable string The ID of an Account representing a customer whose cash balance this object represents.
- livemode boolean If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - settings object 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
POST / v1 / customers /:id / cash_balance
Changes the settings on a customer’s cash balance.
Parameters
- settings object A hash of settings for this cash balance.
Returns
The customer’s cash balance, with the updated settings.
Response
{ "object": "cash_balance", "available": null, "customer": "cus_Ob4Xiw8KXOqcvM", "livemode": false, "settings": { "reconciliation_mode": "manual", "using_merchant_default": false }}