| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Types.TransferReversal
Description
Contains the types generated from the schema TransferReversal
Synopsis
- data TransferReversal = TransferReversal {
- transferReversalAmount :: Int
- transferReversalBalanceTransaction :: Maybe TransferReversalBalanceTransaction'Variants
- transferReversalCreated :: Int
- transferReversalCurrency :: Text
- transferReversalDestinationPaymentRefund :: Maybe TransferReversalDestinationPaymentRefund'Variants
- transferReversalId :: Text
- transferReversalMetadata :: Maybe Object
- transferReversalSourceRefund :: Maybe TransferReversalSourceRefund'Variants
- transferReversalTransfer :: TransferReversalTransfer'Variants
- mkTransferReversal :: Int -> Int -> Text -> Text -> TransferReversalTransfer'Variants -> TransferReversal
- data TransferReversalBalanceTransaction'Variants
- data TransferReversalDestinationPaymentRefund'Variants
- data TransferReversalSourceRefund'Variants
- data TransferReversalTransfer'Variants
Documentation
data TransferReversal Source #
Defines the object schema located at components.schemas.transfer_reversal in the specification.
Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance.
Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.
Related guide: Reversing Transfers.
Constructors
| TransferReversal | |
Fields
| |
Instances
| Eq TransferReversal Source # | |
Defined in StripeAPI.Types.TransferReversal Methods (==) :: TransferReversal -> TransferReversal -> Bool # (/=) :: TransferReversal -> TransferReversal -> Bool # | |
| Show TransferReversal Source # | |
Defined in StripeAPI.Types.TransferReversal Methods showsPrec :: Int -> TransferReversal -> ShowS # show :: TransferReversal -> String # showList :: [TransferReversal] -> ShowS # | |
| ToJSON TransferReversal Source # | |
Defined in StripeAPI.Types.TransferReversal Methods toJSON :: TransferReversal -> Value # toEncoding :: TransferReversal -> Encoding # toJSONList :: [TransferReversal] -> Value # toEncodingList :: [TransferReversal] -> Encoding # | |
| FromJSON TransferReversal Source # | |
Defined in StripeAPI.Types.TransferReversal Methods parseJSON :: Value -> Parser TransferReversal # parseJSONList :: Value -> Parser [TransferReversal] # | |
Arguments
| :: Int | |
| -> Int | |
| -> Text | |
| -> Text | |
| -> TransferReversalTransfer'Variants | |
| -> TransferReversal |
Create a new TransferReversal with all required fields.
data TransferReversalBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.transfer_reversal.properties.balance_transaction.anyOf in the specification.
Balance transaction that describes the impact on your account balance.
Constructors
| TransferReversalBalanceTransaction'Text Text | |
| TransferReversalBalanceTransaction'BalanceTransaction BalanceTransaction |
Instances
data TransferReversalDestinationPaymentRefund'Variants Source #
Defines the oneOf schema located at components.schemas.transfer_reversal.properties.destination_payment_refund.anyOf in the specification.
Linked payment refund for the transfer reversal.
Constructors
| TransferReversalDestinationPaymentRefund'Text Text | |
| TransferReversalDestinationPaymentRefund'Refund Refund |
Instances
data TransferReversalSourceRefund'Variants Source #
Defines the oneOf schema located at components.schemas.transfer_reversal.properties.source_refund.anyOf in the specification.
ID of the refund responsible for the transfer reversal.
Instances
data TransferReversalTransfer'Variants Source #
Defines the oneOf schema located at components.schemas.transfer_reversal.properties.transfer.anyOf in the specification.
ID of the transfer that was reversed.