StripeAPI.Types.BalanceTransaction

Contains the types generated from the schema BalanceTransaction

Documentation

data 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

Fields

• 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 Text

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

  Constraints:

  • Maximum length of 5000
• balanceTransactionExchangeRate :: Maybe 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 BalanceTransactionSource'Variants

  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.

Instances

Eq BalanceTransaction

Defined in StripeAPI.Types.BalanceTransaction

Methods

(==) :: BalanceTransaction -> BalanceTransaction -> Bool

(/=) :: BalanceTransaction -> BalanceTransaction -> Bool

Show BalanceTransaction

Defined in StripeAPI.Types.BalanceTransaction

Methods

showsPrec :: Int -> BalanceTransaction -> ShowS

show :: BalanceTransaction -> String

showList :: [BalanceTransaction] -> ShowS

ToJSON BalanceTransaction

Defined in StripeAPI.Types.BalanceTransaction

Methods

toJSON :: BalanceTransaction -> Value

toEncoding :: BalanceTransaction -> Encoding

toJSONList :: [BalanceTransaction] -> Value

toEncodingList :: [BalanceTransaction] -> Encoding

FromJSON BalanceTransaction

Defined in StripeAPI.Types.BalanceTransaction

Methods

parseJSON :: Value -> Parser BalanceTransaction

parseJSONList :: Value -> Parser [BalanceTransaction]

mkBalanceTransaction

Arguments

:: Int

balanceTransactionAmount

-> Int

balanceTransactionAvailableOn

-> Int

balanceTransactionCreated

-> Text

balanceTransactionCurrency

-> Int

balanceTransactionFee

-> [Fee]

balanceTransactionFeeDetails

-> Text

balanceTransactionId

-> Int

balanceTransactionNet

-> Text

balanceTransactionReportingCategory

-> Text

balanceTransactionStatus

-> BalanceTransactionType'

balanceTransactionType

-> BalanceTransaction

Create a new BalanceTransaction with all required fields.

data BalanceTransactionSource'Variants

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

BalanceTransactionSource'Text Text

BalanceTransactionSource'ApplicationFee ApplicationFee

BalanceTransactionSource'Charge Charge

BalanceTransactionSource'ConnectCollectionTransfer ConnectCollectionTransfer

BalanceTransactionSource'Dispute Dispute

BalanceTransactionSource'FeeRefund FeeRefund

BalanceTransactionSource'Issuing'authorization Issuing'authorization

BalanceTransactionSource'Issuing'dispute Issuing'dispute

BalanceTransactionSource'Issuing'transaction Issuing'transaction

BalanceTransactionSource'Payout Payout

BalanceTransactionSource'PlatformTaxFee PlatformTaxFee

BalanceTransactionSource'Refund Refund

BalanceTransactionSource'ReserveTransaction ReserveTransaction

BalanceTransactionSource'TaxDeductedAtSource TaxDeductedAtSource

BalanceTransactionSource'Topup Topup

BalanceTransactionSource'Transfer Transfer

BalanceTransactionSource'TransferReversal TransferReversal

Instances

Eq BalanceTransactionSource'Variants

Defined in StripeAPI.Types.BalanceTransaction

Methods

(==) :: BalanceTransactionSource'Variants -> BalanceTransactionSource'Variants -> Bool

(/=) :: BalanceTransactionSource'Variants -> BalanceTransactionSource'Variants -> Bool

Show BalanceTransactionSource'Variants

Defined in StripeAPI.Types.BalanceTransaction

Methods

showsPrec :: Int -> BalanceTransactionSource'Variants -> ShowS

show :: BalanceTransactionSource'Variants -> String

showList :: [BalanceTransactionSource'Variants] -> ShowS

ToJSON BalanceTransactionSource'Variants

Defined in StripeAPI.Types.BalanceTransaction

Methods

toJSON :: BalanceTransactionSource'Variants -> Value

toEncoding :: BalanceTransactionSource'Variants -> Encoding

toJSONList :: [BalanceTransactionSource'Variants] -> Value

toEncodingList :: [BalanceTransactionSource'Variants] -> Encoding

FromJSON BalanceTransactionSource'Variants

Defined in StripeAPI.Types.BalanceTransaction

Methods

parseJSON :: Value -> Parser BalanceTransactionSource'Variants

parseJSONList :: Value -> Parser [BalanceTransactionSource'Variants]

data 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

BalanceTransactionType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

BalanceTransactionType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

BalanceTransactionType'EnumAdjustment

Represents the JSON value "adjustment"

BalanceTransactionType'EnumAdvance

Represents the JSON value "advance"

BalanceTransactionType'EnumAdvanceFunding

Represents the JSON value "advance_funding"

BalanceTransactionType'EnumAnticipationRepayment

Represents the JSON value "anticipation_repayment"

BalanceTransactionType'EnumApplicationFee

Represents the JSON value "application_fee"

BalanceTransactionType'EnumApplicationFeeRefund

Represents the JSON value "application_fee_refund"

BalanceTransactionType'EnumCharge

Represents the JSON value "charge"

BalanceTransactionType'EnumConnectCollectionTransfer

Represents the JSON value "connect_collection_transfer"

BalanceTransactionType'EnumContribution

Represents the JSON value "contribution"

BalanceTransactionType'EnumIssuingAuthorizationHold

Represents the JSON value "issuing_authorization_hold"

BalanceTransactionType'EnumIssuingAuthorizationRelease

Represents the JSON value "issuing_authorization_release"

BalanceTransactionType'EnumIssuingDispute

Represents the JSON value "issuing_dispute"

BalanceTransactionType'EnumIssuingTransaction

Represents the JSON value "issuing_transaction"

BalanceTransactionType'EnumPayment

Represents the JSON value "payment"

BalanceTransactionType'EnumPaymentFailureRefund

Represents the JSON value "payment_failure_refund"

BalanceTransactionType'EnumPaymentRefund

Represents the JSON value "payment_refund"

BalanceTransactionType'EnumPayout

Represents the JSON value "payout"

BalanceTransactionType'EnumPayoutCancel

Represents the JSON value "payout_cancel"

BalanceTransactionType'EnumPayoutFailure

Represents the JSON value "payout_failure"

BalanceTransactionType'EnumRefund

Represents the JSON value "refund"

BalanceTransactionType'EnumRefundFailure

Represents the JSON value "refund_failure"

BalanceTransactionType'EnumReserveTransaction

Represents the JSON value "reserve_transaction"

BalanceTransactionType'EnumReservedFunds

Represents the JSON value "reserved_funds"

BalanceTransactionType'EnumStripeFee

Represents the JSON value "stripe_fee"

BalanceTransactionType'EnumStripeFxFee

Represents the JSON value "stripe_fx_fee"

BalanceTransactionType'EnumTaxFee

Represents the JSON value "tax_fee"

BalanceTransactionType'EnumTopup

Represents the JSON value "topup"

BalanceTransactionType'EnumTopupReversal

Represents the JSON value "topup_reversal"

BalanceTransactionType'EnumTransfer

Represents the JSON value "transfer"

BalanceTransactionType'EnumTransferCancel

Represents the JSON value "transfer_cancel"

BalanceTransactionType'EnumTransferFailure

Represents the JSON value "transfer_failure"

BalanceTransactionType'EnumTransferRefund

Represents the JSON value "transfer_refund"

Instances

Eq BalanceTransactionType'

Defined in StripeAPI.Types.BalanceTransaction

Methods

(==) :: BalanceTransactionType' -> BalanceTransactionType' -> Bool

(/=) :: BalanceTransactionType' -> BalanceTransactionType' -> Bool

Show BalanceTransactionType'

Defined in StripeAPI.Types.BalanceTransaction

Methods

showsPrec :: Int -> BalanceTransactionType' -> ShowS

show :: BalanceTransactionType' -> String

showList :: [BalanceTransactionType'] -> ShowS

ToJSON BalanceTransactionType'

Defined in StripeAPI.Types.BalanceTransaction

Methods

toJSON :: BalanceTransactionType' -> Value

toEncoding :: BalanceTransactionType' -> Encoding

toJSONList :: [BalanceTransactionType'] -> Value

toEncodingList :: [BalanceTransactionType'] -> Encoding

FromJSON BalanceTransactionType'

Defined in StripeAPI.Types.BalanceTransaction

Methods

parseJSON :: Value -> Parser BalanceTransactionType'

parseJSONList :: Value -> Parser [BalanceTransactionType']