Package com.stripe.model

Class BalanceTransaction

    • Constructor Detail

      • BalanceTransaction

        public BalanceTransaction()

    • Method Detail

      • getSource

        public java.lang.String getSource()
        Get ID of expandable source object.

      • setSource

        public void setSource​(java.lang.String id)

      • list

        public static BalanceTransactionCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                                         throws StripeException
        Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

        Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

        Throws:
        StripeException

      • list

        public static BalanceTransactionCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                                RequestOptions options)
                                         throws StripeException
        Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

        Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

        Throws:
        StripeException

      • list

        public static BalanceTransactionCollection list​(BalanceTransactionListParams params)
                                         throws StripeException
        Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

        Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

        Throws:
        StripeException

      • retrieve

        public static BalanceTransaction retrieve​(java.lang.String id)
                                   throws StripeException
        Retrieves the balance transaction with the given ID.

        Note that this endpoint previously used the path /v1/balance/history/:id.

        Throws:
        StripeException

      • retrieve

        public static BalanceTransaction retrieve​(java.lang.String id,
                                          java.util.Map<java.lang.String,​java.lang.Object> params,
                                          RequestOptions options)
                                   throws StripeException
        Retrieves the balance transaction with the given ID.

        Note that this endpoint previously used the path /v1/balance/history/:id.

        Throws:
        StripeException

      • getAmount

        public java.lang.Long getAmount()
        Gross amount of the transaction, in %s.

      • getAvailableOn

        public java.lang.Long getAvailableOn()
        The date the transaction's net funds will become available in the Stripe balance.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDescription

        public java.lang.String getDescription()
        An arbitrary string attached to the object. Often useful for displaying to users.

      • getExchangeRate

        public java.math.BigDecimal getExchangeRate()
        The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.

      • getFee

        public java.lang.Long getFee()
        Fees (in %s) paid for this transaction.

      • getFeeDetails

        public java.util.List<BalanceTransaction.Fee> getFeeDetails()
        Detailed breakdown of fees (in %s) paid for this transaction.

      • getNet

        public java.lang.Long getNet()
        Net amount of the transaction, in %s.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to balance_transaction.

      • getReportingCategory

        public java.lang.String getReportingCategory()
        Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

      • getStatus

        public java.lang.String getStatus()
        If the transaction's net funds are available in the Stripe balance yet. Either available or pending.

      • getType

        public java.lang.String getType()
        Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider reporting_category instead.

        One of adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund.

      • setAmount

        public void setAmount​(java.lang.Long amount)
        Gross amount of the transaction, in %s.

      • setAvailableOn

        public void setAvailableOn​(java.lang.Long availableOn)
        The date the transaction's net funds will become available in the Stripe balance.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDescription

        public void setDescription​(java.lang.String description)
        An arbitrary string attached to the object. Often useful for displaying to users.

      • setExchangeRate

        public void setExchangeRate​(java.math.BigDecimal exchangeRate)
        The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.

      • setFee

        public void setFee​(java.lang.Long fee)
        Fees (in %s) paid for this transaction.

      • setFeeDetails

        public void setFeeDetails​(java.util.List<BalanceTransaction.Fee> feeDetails)
        Detailed breakdown of fees (in %s) paid for this transaction.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setNet

        public void setNet​(java.lang.Long net)
        Net amount of the transaction, in %s.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to balance_transaction.

      • setReportingCategory

        public void setReportingCategory​(java.lang.String reportingCategory)
        Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

      • setStatus

        public void setStatus​(java.lang.String status)
        If the transaction's net funds are available in the Stripe balance yet. Either available or pending.

      • setType

        public void setType​(java.lang.String type)
        Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider reporting_category instead.

        One of adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId