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 -> ClientT m (Response PostTransfersResponse)
- data PostTransfersRequestBody = PostTransfersRequestBody {
- postTransfersRequestBodyAmount :: Maybe Int
- postTransfersRequestBodyCurrency :: Text
- postTransfersRequestBodyDescription :: Maybe Text
- postTransfersRequestBodyDestination :: Text
- postTransfersRequestBodyExpand :: Maybe [Text]
- postTransfersRequestBodyMetadata :: Maybe Object
- postTransfersRequestBodySourceTransaction :: Maybe Text
- postTransfersRequestBodySourceType :: Maybe PostTransfersRequestBodySourceType'
- postTransfersRequestBodyTransferGroup :: Maybe Text
- mkPostTransfersRequestBody :: Text -> Text -> PostTransfersRequestBody
- data PostTransfersRequestBodySourceType'
- data PostTransfersResponse
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> PostTransfersRequestBody | The request body to send |
-> ClientT 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
|
Instances
Eq PostTransfersRequestBody Source # | |
Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersRequestBody -> PostTransfersRequestBody -> Bool # (/=) :: PostTransfersRequestBody -> PostTransfersRequestBody -> Bool # | |
Show PostTransfersRequestBody Source # | |
Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersRequestBody -> ShowS # show :: PostTransfersRequestBody -> String # showList :: [PostTransfersRequestBody] -> ShowS # | |
ToJSON PostTransfersRequestBody Source # | |
Defined in StripeAPI.Operations.PostTransfers Methods toJSON :: PostTransfersRequestBody -> Value # toEncoding :: PostTransfersRequestBody -> Encoding # toJSONList :: [PostTransfersRequestBody] -> Value # | |
FromJSON PostTransfersRequestBody Source # | |
Defined in StripeAPI.Operations.PostTransfers Methods parseJSON :: Value -> Parser PostTransfersRequestBody # parseJSONList :: Value -> Parser [PostTransfersRequestBody] # |
mkPostTransfersRequestBody Source #
Arguments
:: Text | |
-> Text | |
-> 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 |
PostTransfersRequestBodySourceType'EnumCard | Represents the JSON value |
PostTransfersRequestBodySourceType'EnumFpx | Represents the JSON value |
Instances
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 # | |
Defined in StripeAPI.Operations.PostTransfers Methods (==) :: PostTransfersResponse -> PostTransfersResponse -> Bool # (/=) :: PostTransfersResponse -> PostTransfersResponse -> Bool # | |
Show PostTransfersResponse Source # | |
Defined in StripeAPI.Operations.PostTransfers Methods showsPrec :: Int -> PostTransfersResponse -> ShowS # show :: PostTransfersResponse -> String # showList :: [PostTransfersResponse] -> ShowS # |