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

Retrieve a cash balance transaction

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

Path parameters

NameDescription
customer*
transaction*

Query parameters

NameDescription
expandSpecifies which fields in the response should be expanded.

Request body

object (no properties in spec)

Response

FieldTypeDescription
adjusted_for_overdraftcustomer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft
2 nested fields
FieldTypeDescription
balance_transaction*string | balance_transaction

The Balance Transaction that corresponds to funds taken out of your Stripe balance.

linked_transaction*string | customer_cash_balance_transaction

The Cash Balance Transaction that brought the customer balance negative, triggering the clawback of funds.

applied_to_paymentcustomer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction
1 nested field
FieldTypeDescription
payment_intent*string | payment_intent

The Payment Intent that funds were applied to.

created*integer (unix-time)

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

currency*string

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

customer*string | customer

The customer whose available cash balance changed as a result of this transaction.

customer_accountstring

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

ending_balance*integer

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

fundedcustomer_balance_resource_cash_balance_transaction_resource_funded_transaction
1 nested field
FieldTypeDescription
bank_transfer*customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer
id*string

Unique identifier for the object.

livemode*boolean

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

net_amount*integer

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*string

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

refunded_from_paymentcustomer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction
1 nested field
FieldTypeDescription
refund*string | refund

The Refund that moved these funds into the customer's cash balance.

transferred_to_balancecustomer_balance_resource_cash_balance_transaction_resource_transferred_to_balance
1 nested field
FieldTypeDescription
balance_transaction*string | balance_transaction

The Balance Transaction that corresponds to funds transferred to your Stripe balance.

type*string

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

unapplied_from_paymentcustomer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction
1 nested field
FieldTypeDescription
payment_intent*string | payment_intent

The Payment Intent that funds were unapplied from.