Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Payout
Description
Contains the types generated from the schema Payout
Synopsis
- data Payout = Payout {
- payoutAmount :: Int
- payoutArrivalDate :: Int
- payoutAutomatic :: Bool
- payoutBalanceTransaction :: Maybe PayoutBalanceTransaction'Variants
- payoutCreated :: Int
- payoutCurrency :: Text
- payoutDescription :: Maybe Text
- payoutDestination :: Maybe PayoutDestination'Variants
- payoutFailureBalanceTransaction :: Maybe PayoutFailureBalanceTransaction'Variants
- payoutFailureCode :: Maybe Text
- payoutFailureMessage :: Maybe Text
- payoutId :: Text
- payoutLivemode :: Bool
- payoutMetadata :: Maybe Object
- payoutMethod :: Text
- payoutOriginalPayout :: Maybe PayoutOriginalPayout'Variants
- payoutReversedBy :: Maybe PayoutReversedBy'Variants
- payoutSourceType :: Text
- payoutStatementDescriptor :: Maybe Text
- payoutStatus :: Text
- payoutType :: PayoutType'
- mkPayout :: Int -> Int -> Bool -> Int -> Text -> Text -> Bool -> Text -> Text -> Text -> PayoutType' -> Payout
- data PayoutBalanceTransaction'Variants
- data PayoutDestination'Variants
- data PayoutFailureBalanceTransaction'Variants
- data PayoutOriginalPayout'Variants
- data PayoutReversedBy'Variants
- data PayoutType'
Documentation
Defines the object schema located at components.schemas.payout
in the specification.
A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your country and industry.
Related guide: Receiving Payouts.
Constructors
Payout | |
Fields
|
Create a new Payout
with all required fields.
data PayoutBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.payout.properties.balance_transaction.anyOf
in the specification.
ID of the balance transaction that describes the impact of this payout on your account balance.
Constructors
PayoutBalanceTransaction'Text Text | |
PayoutBalanceTransaction'BalanceTransaction BalanceTransaction |
Instances
Eq PayoutBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Payout | |
Show PayoutBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods showsPrec :: Int -> PayoutBalanceTransaction'Variants -> ShowS # | |
ToJSON PayoutBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Payout | |
FromJSON PayoutBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods parseJSON :: Value -> Parser PayoutBalanceTransaction'Variants # parseJSONList :: Value -> Parser [PayoutBalanceTransaction'Variants] # |
data PayoutDestination'Variants Source #
Defines the oneOf schema located at components.schemas.payout.properties.destination.anyOf
in the specification.
ID of the bank account or card the payout was sent to.
Constructors
PayoutDestination'Text Text | |
PayoutDestination'BankAccount BankAccount | |
PayoutDestination'Card Card | |
PayoutDestination'DeletedBankAccount DeletedBankAccount | |
PayoutDestination'DeletedCard DeletedCard |
Instances
Eq PayoutDestination'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods (==) :: PayoutDestination'Variants -> PayoutDestination'Variants -> Bool # (/=) :: PayoutDestination'Variants -> PayoutDestination'Variants -> Bool # | |
Show PayoutDestination'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods showsPrec :: Int -> PayoutDestination'Variants -> ShowS # show :: PayoutDestination'Variants -> String # showList :: [PayoutDestination'Variants] -> ShowS # | |
ToJSON PayoutDestination'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods toJSON :: PayoutDestination'Variants -> Value # toEncoding :: PayoutDestination'Variants -> Encoding # toJSONList :: [PayoutDestination'Variants] -> Value # toEncodingList :: [PayoutDestination'Variants] -> Encoding # | |
FromJSON PayoutDestination'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods parseJSON :: Value -> Parser PayoutDestination'Variants # parseJSONList :: Value -> Parser [PayoutDestination'Variants] # |
data PayoutFailureBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.payout.properties.failure_balance_transaction.anyOf
in the specification.
If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
Constructors
PayoutFailureBalanceTransaction'Text Text | |
PayoutFailureBalanceTransaction'BalanceTransaction BalanceTransaction |
Instances
data PayoutOriginalPayout'Variants Source #
Defines the oneOf schema located at components.schemas.payout.properties.original_payout.anyOf
in the specification.
If the payout reverses another, this is the ID of the original payout.
Instances
Eq PayoutOriginalPayout'Variants Source # | |
Defined in StripeAPI.Types.Payout | |
Show PayoutOriginalPayout'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods showsPrec :: Int -> PayoutOriginalPayout'Variants -> ShowS # show :: PayoutOriginalPayout'Variants -> String # showList :: [PayoutOriginalPayout'Variants] -> ShowS # | |
ToJSON PayoutOriginalPayout'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods toJSON :: PayoutOriginalPayout'Variants -> Value # toEncoding :: PayoutOriginalPayout'Variants -> Encoding # toJSONList :: [PayoutOriginalPayout'Variants] -> Value # toEncodingList :: [PayoutOriginalPayout'Variants] -> Encoding # | |
FromJSON PayoutOriginalPayout'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods parseJSON :: Value -> Parser PayoutOriginalPayout'Variants # parseJSONList :: Value -> Parser [PayoutOriginalPayout'Variants] # |
data PayoutReversedBy'Variants Source #
Defines the oneOf schema located at components.schemas.payout.properties.reversed_by.anyOf
in the specification.
If the payout was reversed, this is the ID of the payout that reverses this payout.
Constructors
PayoutReversedBy'Text Text | |
PayoutReversedBy'Payout Payout |
Instances
Eq PayoutReversedBy'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods (==) :: PayoutReversedBy'Variants -> PayoutReversedBy'Variants -> Bool # (/=) :: PayoutReversedBy'Variants -> PayoutReversedBy'Variants -> Bool # | |
Show PayoutReversedBy'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods showsPrec :: Int -> PayoutReversedBy'Variants -> ShowS # show :: PayoutReversedBy'Variants -> String # showList :: [PayoutReversedBy'Variants] -> ShowS # | |
ToJSON PayoutReversedBy'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods toJSON :: PayoutReversedBy'Variants -> Value # toEncoding :: PayoutReversedBy'Variants -> Encoding # toJSONList :: [PayoutReversedBy'Variants] -> Value # | |
FromJSON PayoutReversedBy'Variants Source # | |
Defined in StripeAPI.Types.Payout Methods parseJSON :: Value -> Parser PayoutReversedBy'Variants # parseJSONList :: Value -> Parser [PayoutReversedBy'Variants] # |
data PayoutType' Source #
Defines the enum schema located at components.schemas.payout.properties.type
in the specification.
Can be `bank_account` or `card`.
Constructors
PayoutType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PayoutType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PayoutType'EnumBankAccount | Represents the JSON value |
PayoutType'EnumCard | Represents the JSON value |
Instances
Eq PayoutType' Source # | |
Defined in StripeAPI.Types.Payout | |
Show PayoutType' Source # | |
Defined in StripeAPI.Types.Payout Methods showsPrec :: Int -> PayoutType' -> ShowS # show :: PayoutType' -> String # showList :: [PayoutType'] -> ShowS # | |
ToJSON PayoutType' Source # | |
Defined in StripeAPI.Types.Payout Methods toJSON :: PayoutType' -> Value # toEncoding :: PayoutType' -> Encoding # toJSONList :: [PayoutType'] -> Value # toEncodingList :: [PayoutType'] -> Encoding # | |
FromJSON PayoutType' Source # | |
Defined in StripeAPI.Types.Payout |