The Cash Balance Transaction object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• adjusted_for_overdraftnullable object

  If this is a type=adjusted_for_overdraft transaction, contains information about what caused the overdraft, which triggered this transaction.

  Hide child attributes

  • adjusted_for_overdraft.balance_transactionstringExpandable

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

  • adjusted_for_overdraft.linked_transactionstringExpandable

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

• applied_to_paymentnullable object

  If this is a type=applied_to_payment transaction, contains information about how funds were applied.

  Hide child attributes

  • applied_to_payment.payment_intentstringExpandable

    The Payment Intent that funds were applied to.

• createdtimestamp

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

• currencystring

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

• customerstringExpandable

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

• ending_balanceinteger

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

• fundednullable object

  If this is a type=funded transaction, contains information about the funding.

  Hide child attributes

  • funded.bank_transferobject

    Information about the bank transfer that funded the customer’s cash balance.

    Hide child attributes

    • funded.bank_transfer.eu_bank_transfernullable object

      EU-specific details of the bank transfer.

      Hide child attributes

      • funded.bank_transfer.eu_bank_transfer.bicnullable string

        The BIC of the bank of the sender of the funding.

      • funded.bank_transfer.eu_bank_transfer.iban_last4nullable string

        The last 4 digits of the IBAN of the sender of the funding.

      • funded.bank_transfer.eu_bank_transfer.sender_namenullable string

        The full name of the sender, as supplied by the sending bank.

    • funded.bank_transfer.gb_bank_transfernullable object

      UK-specific details of the bank transfer.

      Hide child attributes

      • funded.bank_transfer.gb_bank_transfer.account_number_last4nullable string

        The last 4 digits of the account number of the sender of the funding.

      • funded.bank_transfer.gb_bank_transfer.sender_namenullable string

        The full name of the sender, as supplied by the sending bank.

      • funded.bank_transfer.gb_bank_transfer.sort_codenullable string

        The sort code of the bank of the sender of the funding

    • funded.bank_transfer.jp_bank_transfernullable object

      Japan-specific details of the bank transfer.

      Hide child attributes

      • funded.bank_transfer.jp_bank_transfer.sender_banknullable string

        The name of the bank of the sender of the funding.

      • funded.bank_transfer.jp_bank_transfer.sender_branchnullable string

        The name of the bank branch of the sender of the funding.

      • funded.bank_transfer.jp_bank_transfer.sender_namenullable string

        The full name of the sender, as supplied by the sending bank.

    • funded.bank_transfer.referencenullable string

      The user-supplied reference field on the bank transfer.

    • funded.bank_transfer.typeenum

      The funding method type used to fund the customer balance. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

      Possible enum values

      eu_bank_transfer A bank transfer of type eu_bank_transfer

      gb_bank_transfer A bank transfer of type gb_bank_transfer

      jp_bank_transfer A bank transfer of type jp_bank_transfer

      mx_bank_transfer A bank transfer of type mx_bank_transfer

      us_bank_transfer A bank transfer of type us_bank_transfer

    • funded.bank_transfer.us_bank_transfernullable object

      US-specific details of the bank transfer.

      Hide child attributes

      • funded.bank_transfer.us_bank_transfer.networknullable enum

        The banking network used for this funding.

        Possible enum values

        ach Banking network is ACH

        domestic_wire_us Banking network is US Domestic Wire

        swift Banking network is SWIFT

      • funded.bank_transfer.us_bank_transfer.sender_namenullable string

        The full name of the sender, as supplied by the sending bank.

• livemodeboolean

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

• net_amountinteger

  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_paymentnullable object

  If this is a type=refunded_from_payment transaction, contains information about the source of the refund.

  Hide child attributes

  • refunded_from_payment.refundstringExpandable

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

• transferred_to_balancenullable object

  If this is a type=transferred_to_balance transaction, contains the balance transaction linked to the transfer.

  Hide child attributes

  • transferred_to_balance.balance_transactionstringExpandable

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

• typeenum

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

  Possible enum values

  adjusted_for_overdraft A cash balance transaction type: adjusted_for_overdraft

  applied_to_payment A cash balance transaction type: applied_to_payment

  funded A cash balance transaction type: funded

  funding_reversed A cash balance transaction type: funding_reversed

  refunded_from_payment A cash balance transaction type: refunded_from_payment

  return_canceled A cash balance transaction type: return_canceled

  return_initiated A cash balance transaction type: return_initiated

  transferred_to_balance A cash balance transaction type: transferred_to_balance

  unapplied_from_payment A cash balance transaction type: unapplied_from_payment

• unapplied_from_paymentnullable object

  If this is a type=unapplied_from_payment transaction, contains information about how funds were unapplied.

  Hide child attributes

  • unapplied_from_payment.payment_intentstringExpandable

    The Payment Intent that funds were unapplied from.