Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTransfers

Description

Contains the different functions to run the operation postTransfers

Synopsis

postTransfers :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTransfersRequestBody -> m (Either HttpException (Response PostTransfersResponse))
postTransfersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTransfersRequestBody -> m (Either HttpException (Response ByteString))
postTransfersM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTransfersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTransfersResponse))
postTransfersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTransfersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTransfersRequestBody = PostTransfersRequestBody {
}
data PostTransfersRequestBodyMetadata' = PostTransfersRequestBodyMetadata' {
}
data PostTransfersRequestBodySourceType'
data PostTransfersResponse

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

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

POST /v1/transfers

Monadic version of postTransfers (use with runWithConfiguration)

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

POST /v1/transfers

Monadic version of postTransfersRaw (use with runWithConfiguration)

data PostTransfersRequestBody Source #

Defines the data type for the schema postTransfersRequestBody

Constructors

PostTransfersRequestBody

Fields

postTransfersRequestBodyAmount :: Maybe Integer
amount: A positive integer in %s representing how much to transfer.
postTransfersRequestBodyCurrency :: String
currency: 3-letter ISO code for currency.
postTransfersRequestBodyDescription :: Maybe String
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 5000
postTransfersRequestBodyDestination :: String
destination: The ID of a connected Stripe account. <a href="/docs/connect/charges-transfers">See the Connect documentation</a> for details.
postTransfersRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postTransfersRequestBodyMetadata :: Maybe PostTransfersRequestBodyMetadata'
metadata: 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`.
postTransfersRequestBodySourceTransaction :: Maybe String
source_transaction: You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.
postTransfersRequestBodySourceType :: Maybe PostTransfersRequestBodySourceType'
source_type: The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
Constraints:
- Maximum length of 5000
postTransfersRequestBodyTransferGroup :: Maybe String
transfer_group: A string that identifies this transaction as part of a group. See the Connect documentation for details.

Instances

Eq PostTransfersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersRequestBody -> PostTransfersRequestBody -> Bool # (/=) :: PostTransfersRequestBody -> PostTransfersRequestBody -> Bool #
Show PostTransfersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersRequestBody -> ShowS # show :: PostTransfersRequestBody -> String # showList :: [PostTransfersRequestBody] -> ShowS #
ToJSON PostTransfersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods toJSON :: PostTransfersRequestBody -> Value # toEncoding :: PostTransfersRequestBody -> Encoding # toJSONList :: [PostTransfersRequestBody] -> Value # toEncodingList :: [PostTransfersRequestBody] -> Encoding #
FromJSON PostTransfersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods parseJSON :: Value -> Parser PostTransfersRequestBody # parseJSONList :: Value -> Parser [PostTransfersRequestBody] #

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

Constructors

PostTransfersRequestBodyMetadata'

Instances

Eq PostTransfersRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersRequestBodyMetadata' -> PostTransfersRequestBodyMetadata' -> Bool # (/=) :: PostTransfersRequestBodyMetadata' -> PostTransfersRequestBodyMetadata' -> Bool #
Show PostTransfersRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersRequestBodyMetadata' -> ShowS # show :: PostTransfersRequestBodyMetadata' -> String # showList :: [PostTransfersRequestBodyMetadata'] -> ShowS #
ToJSON PostTransfersRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods toJSON :: PostTransfersRequestBodyMetadata' -> Value # toEncoding :: PostTransfersRequestBodyMetadata' -> Encoding # toJSONList :: [PostTransfersRequestBodyMetadata'] -> Value # toEncodingList :: [PostTransfersRequestBodyMetadata'] -> Encoding #
FromJSON PostTransfersRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods parseJSON :: Value -> Parser PostTransfersRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostTransfersRequestBodyMetadata'] #

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

Constructors

PostTransfersRequestBodySourceType'EnumOther Value
PostTransfersRequestBodySourceType'EnumTyped String
PostTransfersRequestBodySourceType'EnumStringBankAccount
PostTransfersRequestBodySourceType'EnumStringCard
PostTransfersRequestBodySourceType'EnumStringFpx

Instances

Eq PostTransfersRequestBodySourceType' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersRequestBodySourceType' -> PostTransfersRequestBodySourceType' -> Bool # (/=) :: PostTransfersRequestBodySourceType' -> PostTransfersRequestBodySourceType' -> Bool #
Show PostTransfersRequestBodySourceType' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersRequestBodySourceType' -> ShowS # show :: PostTransfersRequestBodySourceType' -> String # showList :: [PostTransfersRequestBodySourceType'] -> ShowS #
ToJSON PostTransfersRequestBodySourceType' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods toJSON :: PostTransfersRequestBodySourceType' -> Value # toEncoding :: PostTransfersRequestBodySourceType' -> Encoding # toJSONList :: [PostTransfersRequestBodySourceType'] -> Value # toEncodingList :: [PostTransfersRequestBodySourceType'] -> Encoding #
FromJSON PostTransfersRequestBodySourceType' Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods parseJSON :: Value -> Parser PostTransfersRequestBodySourceType' # parseJSONList :: Value -> Parser [PostTransfersRequestBodySourceType'] #

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.

Instances

Eq PostTransfersResponse Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersResponse -> PostTransfersResponse -> Bool # (/=) :: PostTransfersResponse -> PostTransfersResponse -> Bool #
Show PostTransfersResponse Source #
Instance details Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersResponse -> ShowS # show :: PostTransfersResponse -> String # showList :: [PostTransfersResponse] -> ShowS #