Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Transfer
Description
Contains the types generated from the schema Transfer
Synopsis
- data Transfer = Transfer {
- transferAmount :: Int
- transferAmountReversed :: Int
- transferBalanceTransaction :: Maybe TransferBalanceTransaction'Variants
- transferCreated :: Int
- transferCurrency :: Text
- transferDescription :: Maybe Text
- transferDestination :: Maybe TransferDestination'Variants
- transferDestinationPayment :: Maybe TransferDestinationPayment'Variants
- transferId :: Text
- transferLivemode :: Bool
- transferMetadata :: Object
- transferReversals :: TransferReversals'
- transferReversed :: Bool
- transferSourceTransaction :: Maybe TransferSourceTransaction'Variants
- transferSourceType :: Maybe Text
- transferTransferGroup :: Maybe Text
- mkTransfer :: Int -> Int -> Int -> Text -> Text -> Bool -> Object -> TransferReversals' -> Bool -> Transfer
- data TransferBalanceTransaction'Variants
- data TransferDestination'Variants
- data TransferDestinationPayment'Variants
- data TransferReversals' = TransferReversals' {}
- mkTransferReversals' :: [TransferReversal] -> Bool -> Text -> TransferReversals'
- data TransferSourceTransaction'Variants
Documentation
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.
Related guide: Creating Separate Charges and Transfers.
Constructors
Transfer | |
Fields
|
Create a new Transfer
with all required fields.
data TransferBalanceTransaction'Variants Source #
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'Text Text | |
TransferBalanceTransaction'BalanceTransaction BalanceTransaction |
Instances
data TransferDestination'Variants Source #
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.
Instances
data TransferDestinationPayment'Variants Source #
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.
Instances
data TransferReversals' Source #
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' | |
Fields
|
Instances
Eq TransferReversals' Source # | |
Defined in StripeAPI.Types.Transfer Methods (==) :: TransferReversals' -> TransferReversals' -> Bool # (/=) :: TransferReversals' -> TransferReversals' -> Bool # | |
Show TransferReversals' Source # | |
Defined in StripeAPI.Types.Transfer Methods showsPrec :: Int -> TransferReversals' -> ShowS # show :: TransferReversals' -> String # showList :: [TransferReversals'] -> ShowS # | |
ToJSON TransferReversals' Source # | |
Defined in StripeAPI.Types.Transfer Methods toJSON :: TransferReversals' -> Value # toEncoding :: TransferReversals' -> Encoding # toJSONList :: [TransferReversals'] -> Value # toEncodingList :: [TransferReversals'] -> Encoding # | |
FromJSON TransferReversals' Source # | |
Defined in StripeAPI.Types.Transfer Methods parseJSON :: Value -> Parser TransferReversals' # parseJSONList :: Value -> Parser [TransferReversals'] # |
Arguments
:: [TransferReversal] | |
-> Bool | |
-> Text | |
-> TransferReversals' |
Create a new TransferReversals'
with all required fields.
data TransferSourceTransaction'Variants Source #
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.
Instances
Eq TransferSourceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Transfer | |
Show TransferSourceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Transfer Methods showsPrec :: Int -> TransferSourceTransaction'Variants -> ShowS # | |
ToJSON TransferSourceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Transfer | |
FromJSON TransferSourceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Transfer Methods parseJSON :: Value -> Parser TransferSourceTransaction'Variants # parseJSONList :: Value -> Parser [TransferSourceTransaction'Variants] # |