Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.PostPayouts
Description
Contains the different functions to run the operation postPayouts
Synopsis
- postPayouts :: forall m. MonadHTTP m => PostPayoutsRequestBody -> ClientT m (Response PostPayoutsResponse)
- data PostPayoutsRequestBody = PostPayoutsRequestBody {
- postPayoutsRequestBodyAmount :: Int
- postPayoutsRequestBodyCurrency :: Text
- postPayoutsRequestBodyDescription :: Maybe Text
- postPayoutsRequestBodyDestination :: Maybe Text
- postPayoutsRequestBodyExpand :: Maybe [Text]
- postPayoutsRequestBodyMetadata :: Maybe Object
- postPayoutsRequestBodyMethod :: Maybe PostPayoutsRequestBodyMethod'
- postPayoutsRequestBodySourceType :: Maybe PostPayoutsRequestBodySourceType'
- postPayoutsRequestBodyStatementDescriptor :: Maybe Text
- mkPostPayoutsRequestBody :: Int -> Text -> PostPayoutsRequestBody
- data PostPayoutsRequestBodyMethod'
- data PostPayoutsRequestBodySourceType'
- data PostPayoutsResponse
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> PostPayoutsRequestBody | The request body to send |
-> ClientT m (Response PostPayoutsResponse) | Monadic computation which returns the result of the operation |
POST /v1/payouts
<p>To send funds to your own bank account, you create a new payout object. Your <a href="#balance">Stripe balance</a> must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.</p>
<p>If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.</p>
<p>If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The <a href="#balance_object">balance object</a> details available and pending amounts by source type.</p>
data PostPayoutsRequestBody Source #
Defines the object schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
Constructors
PostPayoutsRequestBody | |
Fields
|
Instances
Eq PostPayoutsRequestBody Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods (==) :: PostPayoutsRequestBody -> PostPayoutsRequestBody -> Bool # (/=) :: PostPayoutsRequestBody -> PostPayoutsRequestBody -> Bool # | |
Show PostPayoutsRequestBody Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods showsPrec :: Int -> PostPayoutsRequestBody -> ShowS # show :: PostPayoutsRequestBody -> String # showList :: [PostPayoutsRequestBody] -> ShowS # | |
ToJSON PostPayoutsRequestBody Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods toJSON :: PostPayoutsRequestBody -> Value # toEncoding :: PostPayoutsRequestBody -> Encoding # toJSONList :: [PostPayoutsRequestBody] -> Value # | |
FromJSON PostPayoutsRequestBody Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods parseJSON :: Value -> Parser PostPayoutsRequestBody # parseJSONList :: Value -> Parser [PostPayoutsRequestBody] # |
mkPostPayoutsRequestBody Source #
Arguments
:: Int | |
-> Text | |
-> PostPayoutsRequestBody |
Create a new PostPayoutsRequestBody
with all required fields.
data PostPayoutsRequestBodyMethod' Source #
Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.method
in the specification.
The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
Constructors
PostPayoutsRequestBodyMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostPayoutsRequestBodyMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostPayoutsRequestBodyMethod'EnumInstant | Represents the JSON value |
PostPayoutsRequestBodyMethod'EnumStandard | Represents the JSON value |
Instances
Eq PostPayoutsRequestBodyMethod' Source # | |
Defined in StripeAPI.Operations.PostPayouts | |
Show PostPayoutsRequestBodyMethod' Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods showsPrec :: Int -> PostPayoutsRequestBodyMethod' -> ShowS # show :: PostPayoutsRequestBodyMethod' -> String # showList :: [PostPayoutsRequestBodyMethod'] -> ShowS # | |
ToJSON PostPayoutsRequestBodyMethod' Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods toJSON :: PostPayoutsRequestBodyMethod' -> Value # toEncoding :: PostPayoutsRequestBodyMethod' -> Encoding # toJSONList :: [PostPayoutsRequestBodyMethod'] -> Value # toEncodingList :: [PostPayoutsRequestBodyMethod'] -> Encoding # | |
FromJSON PostPayoutsRequestBodyMethod' Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods parseJSON :: Value -> Parser PostPayoutsRequestBodyMethod' # parseJSONList :: Value -> Parser [PostPayoutsRequestBodyMethod'] # |
data PostPayoutsRequestBodySourceType' Source #
Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_type
in the specification.
The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`.
Constructors
PostPayoutsRequestBodySourceType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostPayoutsRequestBodySourceType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostPayoutsRequestBodySourceType'EnumBankAccount | Represents the JSON value |
PostPayoutsRequestBodySourceType'EnumCard | Represents the JSON value |
PostPayoutsRequestBodySourceType'EnumFpx | Represents the JSON value |
Instances
data PostPayoutsResponse Source #
Represents a response of the operation postPayouts
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostPayoutsResponseError
is used.
Constructors
PostPayoutsResponseError String | Means either no matching case available or a parse error |
PostPayoutsResponse200 Payout | Successful response. |
PostPayoutsResponseDefault Error | Error response. |
Instances
Eq PostPayoutsResponse Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods (==) :: PostPayoutsResponse -> PostPayoutsResponse -> Bool # (/=) :: PostPayoutsResponse -> PostPayoutsResponse -> Bool # | |
Show PostPayoutsResponse Source # | |
Defined in StripeAPI.Operations.PostPayouts Methods showsPrec :: Int -> PostPayoutsResponse -> ShowS # show :: PostPayoutsResponse -> String # showList :: [PostPayoutsResponse] -> ShowS # |