Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a cash balance transaction

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

get/v1/customers/{customer}/cash_balance_transactions/{transaction}

Path parameters

customerstring required
transactionstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_accountstring nullable

The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.

ending_balanceinteger required

The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

net_amountinteger required

The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.

object'customer_cash_balance_transaction' required

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

type'adjusted_for_overdraft' | 'applied_to_payment' | 'funded' | 'funding_reversed' | 'refunded_from_payment' | 'return_canceled' | 'return_initiated' | 'transferred_to_balance' | 'unapplied_from_payment' required

The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.