stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostTransfers

Description

Contains the different functions to run the operation postTransfers

Synopsis

Documentation

postTransfers Source #

Arguments

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

The configuration to use in the request

-> PostTransfersRequestBody

The request body to send

-> m (Either HttpException (Response PostTransfersResponse))

Monad containing the result of the operation

POST /v1/transfers

<p>To send funds from your Stripe account to a connected account, you create a new transfer object. Your <a href="#balance">Stripe balance</a> must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.</p>

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

POST /v1/transfers

The same as postTransfers but returns the raw ByteString

data PostTransfersRequestBody Source #

Defines the data type for the schema postTransfersRequestBody

Constructors

PostTransfersRequestBody 

Fields

data PostTransfersRequestBodyMetadata' Source #

Defines the data type for the schema postTransfersRequestBodyMetadata'

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 PostTransfersRequestBodySourceType' Source #

Defines the enum schema postTransfersRequestBodySource_type'

The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.

data PostTransfersResponse Source #

Represents a response of the operation postTransfers.

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), PostTransfersResponseError is used.

Constructors

PostTransfersResponseError String

Means either no matching case available or a parse error

PostTransfersResponse200 Transfer

Successful response.

PostTransfersResponseDefault Error

Error response.