Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTransfers

Description

Contains the different functions to run the operation postTransfers

Synopsis

postTransfers :: forall m. MonadHTTP m => PostTransfersRequestBody -> StripeT m (Response PostTransfersResponse)
data PostTransfersRequestBody = PostTransfersRequestBody {
}
mkPostTransfersRequestBody :: Text -> Text -> PostTransfersRequestBody
data PostTransfersRequestBodySourceType'
data PostTransfersResponse

Documentation

postTransfers Source #

Arguments

:: forall m. MonadHTTP m
=> PostTransfersRequestBody	The request body to send
-> StripeT m (Response PostTransfersResponse)	Monadic computation which returns 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>

data PostTransfersRequestBody Source #

Defines the object schema located at paths./v1/transfers.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTransfersRequestBody

Fields

postTransfersRequestBodyAmount :: Maybe Int
amount: A positive integer in %s representing how much to transfer.
postTransfersRequestBodyCurrency :: Text
currency: 3-letter ISO code for currency.
postTransfersRequestBodyDescription :: Maybe Text
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 5000
postTransfersRequestBodyDestination :: Text
destination: The ID of a connected Stripe account. <a href="/docs/connect/charges-transfers">See the Connect documentation</a> for details.
postTransfersRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postTransfersRequestBodyMetadata :: Maybe Object
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 Text
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 Text
transfer_group: A string that identifies this transaction as part of a group. See the Connect documentation for details.

Instances

Instances details

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] #

mkPostTransfersRequestBody Source #

Arguments

:: Text	`postTransfersRequestBodyCurrency`
-> Text	`postTransfersRequestBodyDestination`
-> PostTransfersRequestBody

Create a new PostTransfersRequestBody with all required fields.

data PostTransfersRequestBodySourceType' Source #

Defines the enum schema located at paths./v1/transfers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_type in the specification.

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'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostTransfersRequestBodySourceType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostTransfersRequestBodySourceType'EnumBankAccount	Represents the JSON value `"bank_account"`
PostTransfersRequestBodySourceType'EnumCard	Represents the JSON value `"card"`
PostTransfersRequestBodySourceType'EnumFpx	Represents the JSON value `"fpx"`

Instances

Instances details

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

Instances details

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 #