Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_Transaction

Contains the types generated from the schema Treasury_Transaction

Synopsis

data Treasury'transaction
value mkTreasury'transaction
data Treasury'transactionEntries'NonNullable
value mkTreasury'transactionEntries'NonNullable
data Treasury'transactionFlowDetails'NonNullable
value mkTreasury'transactionFlowDetails'NonNullable
data Treasury'transactionFlowDetails'NonNullableType'
data Treasury'transactionFlowType'
data Treasury'transactionStatus'

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceTreasury_Transaction.hs

datadata Treasury'transaction

Source#

Defines the object schema located at components.schemas.treasury.transaction in the specification.

Transactions represent changes to a FinancialAccount's balance.

Constructors

Treasury'transaction
- treasury'transactionAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'transactionBalanceImpact :: TreasuryTransactionsResourceBalanceImpact
  balance_impact: Change to a FinancialAccount's balance
- treasury'transactionCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- treasury'transactionCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'transactionDescription :: Text
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- treasury'transactionEntries :: Maybe (Nullable Treasury'transactionEntries'NonNullable)
  entries: A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
- treasury'transactionFinancialAccount :: Text
  financial_account: The FinancialAccount associated with this object.
  Constraints:
  - Maximum length of 5000
- treasury'transactionFlow :: Maybe (Nullable Text)
  flow: ID of the flow that created the Transaction.
  Constraints:
  - Maximum length of 5000
- treasury'transactionFlowDetails :: Maybe (Nullable Treasury'transactionFlowDetails'NonNullable)
  flow_details: Details of the flow that created the Transaction.
- treasury'transactionFlowType :: Treasury'transactionFlowType'
  flow_type: Type of the flow that created the Transaction.
- treasury'transactionId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'transactionLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- treasury'transactionStatus :: Treasury'transactionStatus'
  status: Status of the Transaction.
- treasury'transactionStatusTransitions :: TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions
  status_transitions:

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction

datadata Treasury'transactionEntries'NonNullable

Source#

Defines the object schema located at components.schemas.treasury.transaction.properties.entries in the specification.

A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.

Constructors

Treasury'transactionEntries'NonNullable
- treasury'transactionEntries'NonNullableData :: [Treasury'transactionEntry]
  data: Details about each object.
- treasury'transactionEntries'NonNullableHasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- treasury'transactionEntries'NonNullableUrl :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/treasury/transaction_entries'

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionEntries'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionEntries'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionEntries'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionEntries'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction

valuemkTreasury'transactionEntries'NonNullable

:: [Treasury'transactionEntry]
treasury'transactionEntries'NonNullableData
-> Bool
treasury'transactionEntries'NonNullableHasMore
-> Text
treasury'transactionEntries'NonNullableUrl
-> Treasury'transactionEntries'NonNullable

Source#

Create a new Treasury'transactionEntries'NonNullable with all required fields.

datadata Treasury'transactionFlowDetails'NonNullable

Source#

Defines the object schema located at components.schemas.treasury.transaction.properties.flow_details.anyOf in the specification.

Details of the flow that created the Transaction.

Constructors

Treasury'transactionFlowDetails'NonNullable
- treasury'transactionFlowDetails'NonNullableCreditReversal :: Maybe Treasury'creditReversal
  credit_reversal: You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
- treasury'transactionFlowDetails'NonNullableDebitReversal :: Maybe Treasury'debitReversal
  debit_reversal: You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
- treasury'transactionFlowDetails'NonNullableInboundTransfer :: Maybe Treasury'inboundTransfer
  inbound_transfer: Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
- treasury'transactionFlowDetails'NonNullableIssuingAuthorization :: Maybe Issuing'authorization
  issuing_authorization: When an issued card is used to make a purchase, an Issuing `Authorization` object is created. Authorizations must be approved for the purchase to be completed successfully.
  Related guide: Issued Card Authorizations.
- treasury'transactionFlowDetails'NonNullableOutboundPayment :: Maybe Treasury'outboundPayment
  outbound_payment: Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.
  Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
- treasury'transactionFlowDetails'NonNullableOutboundTransfer :: Maybe Treasury'outboundTransfer
  outbound_transfer: Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
  Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
- treasury'transactionFlowDetails'NonNullableReceivedCredit :: Maybe Treasury'receivedCredit
  received_credit: ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
- treasury'transactionFlowDetails'NonNullableReceivedDebit :: Maybe Treasury'receivedDebit
  received_debit: ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.
- treasury'transactionFlowDetails'NonNullableType :: Maybe Treasury'transactionFlowDetails'NonNullableType'
  type: Type of the flow that created the Transaction. Set to the same value as `flow_type`.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionFlowDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionFlowDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionFlowDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionFlowDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction

valuemkTreasury'transactionFlowDetails'NonNullable :: Treasury'transactionFlowDetails'NonNullable

Source#

Create a new Treasury'transactionFlowDetails'NonNullable with all required fields.

datadata Treasury'transactionFlowDetails'NonNullableType'

Source#

Defines the enum schema located at components.schemas.treasury.transaction.properties.flow_details.anyOf.properties.type in the specification.

Type of the flow that created the Transaction. Set to the same value as `flow_type`.

Constructors

Treasury'transactionFlowDetails'NonNullableType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'transactionFlowDetails'NonNullableType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'transactionFlowDetails'NonNullableType'EnumCreditReversal
Represents the JSON value "credit_reversal"
Treasury'transactionFlowDetails'NonNullableType'EnumDebitReversal
Represents the JSON value "debit_reversal"
Treasury'transactionFlowDetails'NonNullableType'EnumInboundTransfer
Represents the JSON value "inbound_transfer"
Treasury'transactionFlowDetails'NonNullableType'EnumIssuingAuthorization
Represents the JSON value "issuing_authorization"
Treasury'transactionFlowDetails'NonNullableType'EnumOther
Represents the JSON value "other"
Treasury'transactionFlowDetails'NonNullableType'EnumOutboundPayment
Represents the JSON value "outbound_payment"
Treasury'transactionFlowDetails'NonNullableType'EnumOutboundTransfer
Represents the JSON value "outbound_transfer"
Treasury'transactionFlowDetails'NonNullableType'EnumReceivedCredit
Represents the JSON value "received_credit"
Treasury'transactionFlowDetails'NonNullableType'EnumReceivedDebit
Represents the JSON value "received_debit"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionFlowDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionFlowDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionFlowDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionFlowDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction

datadata Treasury'transactionFlowType'

Source#

Defines the enum schema located at components.schemas.treasury.transaction.properties.flow_type in the specification.

Type of the flow that created the Transaction.

Constructors

Treasury'transactionFlowType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'transactionFlowType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'transactionFlowType'EnumCreditReversal
Represents the JSON value "credit_reversal"
Treasury'transactionFlowType'EnumDebitReversal
Represents the JSON value "debit_reversal"
Treasury'transactionFlowType'EnumInboundTransfer
Represents the JSON value "inbound_transfer"
Treasury'transactionFlowType'EnumIssuingAuthorization
Represents the JSON value "issuing_authorization"
Treasury'transactionFlowType'EnumOther
Represents the JSON value "other"
Treasury'transactionFlowType'EnumOutboundPayment
Represents the JSON value "outbound_payment"
Treasury'transactionFlowType'EnumOutboundTransfer
Represents the JSON value "outbound_transfer"
Treasury'transactionFlowType'EnumReceivedCredit
Represents the JSON value "received_credit"
Treasury'transactionFlowType'EnumReceivedDebit
Represents the JSON value "received_debit"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction

datadata Treasury'transactionStatus'

Source#

Defines the enum schema located at components.schemas.treasury.transaction.properties.status in the specification.

Status of the Transaction.

Constructors

Treasury'transactionStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'transactionStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'transactionStatus'EnumOpen
Represents the JSON value "open"
Treasury'transactionStatus'EnumPosted
Represents the JSON value "posted"
Treasury'transactionStatus'EnumVoid
Represents the JSON value "void"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'transactionStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
Show Treasury'transactionStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
FromJSON Treasury'transactionStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction
ToJSON Treasury'transactionStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_Transaction