HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.BalanceTransaction

Contains the types generated from the schema BalanceTransaction

  • 3 types
  • 1 value
  • Packagestripeapi-3.0.0.0
  • Exports4
  • LanguageHaskell2010
  • LicenceMIT
  • SourceBalanceTransaction.hs
datadata BalanceTransaction
#

Defines the object schema located at components.schemas.balance_transaction in the specification.

Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance.

Related guide: Balance Transaction Types.

Constructors

  • BalanceTransaction
    • balanceTransactionAmount :: Int

      amount: Gross amount of the transaction, in %s.

    • balanceTransactionAvailableOn :: Int

      available_on: The date the transaction's net funds will become available in the Stripe balance.

    • balanceTransactionCreated :: Int

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

    • balanceTransactionCurrency :: Text

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

    • balanceTransactionDescription :: Maybe (Nullable Text)

      description: An arbitrary string attached to the object. Often useful for displaying to users.

      Constraints:

      • Maximum length of 5000

    • balanceTransactionExchangeRate :: Maybe (Nullable Double)

      exchange_rate: 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`.

    • balanceTransactionFee :: Int

      fee: Fees (in %s) paid for this transaction.

    • balanceTransactionFeeDetails :: [Fee]

      fee_details: Detailed breakdown of fees (in %s) paid for this transaction.

    • balanceTransactionId :: Text

      id: Unique identifier for the object.

      Constraints:

      • Maximum length of 5000

    • balanceTransactionNet :: Int

      net: Net amount of the transaction, in %s.

    • balanceTransactionReportingCategory :: Text

      reporting_category: Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

      Constraints:

      • Maximum length of 5000

    • balanceTransactionSource :: Maybe (Nullable BalanceTransactionSource'NonNullableVariants)

      source: The Stripe object to which this transaction is related.

    • balanceTransactionStatus :: Text

      status: If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.

      Constraints:

      • Maximum length of 5000

    • balanceTransactionType :: BalanceTransactionType'

      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.

Instances4Eq, Show, FromJSON, ToJSON
datadata BalanceTransactionSource'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.balance_transaction.properties.source.anyOf in the specification.

The Stripe object to which this transaction is related.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata BalanceTransactionType'
#

Defines the enum schema located at components.schemas.balance_transaction.properties.type in the specification.

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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON