Mayson Monorepo Documentation
    Preparing search index...

    Interface CustomerCashBalanceTransaction

    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.

    interface CustomerCashBalanceTransaction {
        id: string;
        object: "customer_cash_balance_transaction";
        adjusted_for_overdraft?: AdjustedForOverdraft;
        applied_to_payment?: AppliedToPayment;
        created: number;
        currency: string;
        customer: string | Stripe.Customer;
        customer_account: string;
        ending_balance: number;
        funded?: Stripe.CustomerCashBalanceTransaction.Funded;
        livemode: boolean;
        net_amount: number;
        refunded_from_payment?: RefundedFromPayment;
        transferred_to_balance?: TransferredToBalance;
        type: Stripe.CustomerCashBalanceTransaction.Type;
        unapplied_from_payment?: UnappliedFromPayment;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "customer_cash_balance_transaction"

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

    adjusted_for_overdraft?: AdjustedForOverdraft
    applied_to_payment?: AppliedToPayment
    created: number

    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 | Stripe.Customer

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

    customer_account: string

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

    ending_balance: number

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

    livemode: boolean

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

    net_amount: number

    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.

    refunded_from_payment?: RefundedFromPayment
    transferred_to_balance?: TransferredToBalance

    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_payment?: UnappliedFromPayment