stripeapi-0.1.0.2: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPayouts

Description

Contains the different functions to run the operation postPayouts

Synopsis

Documentation

postPayouts Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> PostPayoutsRequestBody

The request body to send

-> m (Either HttpException (Response PostPayoutsResponse))

Monad containing 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>

postPayoutsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostPayoutsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/payouts

The same as postPayouts but returns the raw ByteString

data PostPayoutsRequestBody Source #

Defines the data type for the schema postPayoutsRequestBody

Constructors

PostPayoutsRequestBody 

Fields

data PostPayoutsRequestBodyMetadata' Source #

Defines the data type for the schema postPayoutsRequestBodyMetadata'

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data PostPayoutsRequestBodyMethod' Source #

Defines the enum schema postPayoutsRequestBodyMethod'

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.)

data PostPayoutsRequestBodySourceType' Source #

Defines the enum schema postPayoutsRequestBodySource_type'

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`.

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.