Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Transfer

Contains the types generated from the schema Transfer

6 types
2 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceTransfer.hs

datadata Transfer

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

A `Transfer` object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

Constructors

Transfer
- transferAmount :: Int
  amount: Amount in %s to be transferred.
- transferAmountReversed :: Int
  amount_reversed: Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
- transferBalanceTransaction :: Maybe (Nullable TransferBalanceTransaction'NonNullableVariants)
  balance_transaction: Balance transaction that describes the impact of this transfer on your account balance.
- transferCreated :: Int
  created: Time that this record of the transfer was first created.
- transferCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- transferDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- transferDestination :: Maybe (Nullable TransferDestination'NonNullableVariants)
  destination: ID of the Stripe account the transfer was sent to.
- transferDestinationPayment :: Maybe TransferDestinationPayment'Variants
  destination_payment: If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
- transferId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- transferLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- transferMetadata :: Object
  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- transferReversals :: TransferReversals'
  reversals: A list of reversals that have been applied to the transfer.
- transferReversed :: Bool
  reversed: Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
- transferSourceTransaction :: Maybe (Nullable TransferSourceTransaction'NonNullableVariants)
  source_transaction: ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
- transferSourceType :: Maybe (Nullable Text)
  source_type: The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
  Constraints:
  - Maximum length of 5000
- transferTransferGroup :: Maybe (Nullable Text)
  transfer_group: A string that identifies this transaction as part of a group. See the Connect documentation for details.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer

valuemkTransfer

:: Int
transferAmount
-> Int
transferAmountReversed
-> Int
transferCreated
-> Text
transferCurrency
-> Text
transferId
-> Bool
transferLivemode
-> Object
transferMetadata
-> TransferReversals'
transferReversals
-> Bool
transferReversed
-> Transfer

Create a new Transfer with all required fields.

datadata TransferBalanceTransaction'NonNullableVariants

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

Balance transaction that describes the impact of this transfer on your account balance.

Constructors

TransferBalanceTransaction'NonNullableText Text
TransferBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer

datadata TransferDestination'NonNullableVariants

Defines the oneOf schema located at components.schemas.transfer.properties.destination.anyOf in the specification.

ID of the Stripe account the transfer was sent to.

Constructors

TransferDestination'NonNullableText Text
TransferDestination'NonNullableAccount Account

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer

datadata TransferDestinationPayment'Variants

Defines the oneOf schema located at components.schemas.transfer.properties.destination_payment.anyOf in the specification.

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

Constructors

TransferDestinationPayment'Text Text
TransferDestinationPayment'Charge Charge

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferDestinationPayment'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferDestinationPayment'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferDestinationPayment'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferDestinationPayment'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer

datadata TransferReversals'

Defines the object schema located at components.schemas.transfer.properties.reversals in the specification.

A list of reversals that have been applied to the transfer.

Constructors

TransferReversals'
- transferReversals'Data :: [TransferReversal]
  data: Details about each object.
- transferReversals'HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- transferReversals'Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversals'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferReversals'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferReversals'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferReversals'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer

valuemkTransferReversals'

:: [TransferReversal]
transferReversals'Data
-> Bool
transferReversals'HasMore
-> Text
transferReversals'Url
-> TransferReversals'

Create a new TransferReversals' with all required fields.

datadata TransferSourceTransaction'NonNullableVariants

Defines the oneOf schema located at components.schemas.transfer.properties.source_transaction.anyOf in the specification.

ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

Constructors

TransferSourceTransaction'NonNullableText Text
TransferSourceTransaction'NonNullableCharge Charge

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferSourceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
Show TransferSourceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
FromJSON TransferSourceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer
ToJSON TransferSourceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Transfer