Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTransfers

Contains the different functions to run the operation postTransfers

3 types
2 values

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourcePostTransfers.hs

valuepostTransfers

:: 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>

datadata PostTransfersRequestBody

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

Constructors

PostTransfersRequestBody
- postTransfersRequestBodyAmount :: Maybe Int
  amount: A positive integer in cents (or local equivalent) 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.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
Show PostTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
FromJSON PostTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
ToJSON PostTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers

valuemkPostTransfersRequestBody

:: Text
postTransfersRequestBodyCurrency
-> Text
postTransfersRequestBodyDestination
-> PostTransfersRequestBody

Create a new PostTransfersRequestBody with all required fields.

datadata PostTransfersRequestBodySourceType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTransfersRequestBodySourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
Show PostTransfersRequestBodySourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
FromJSON PostTransfersRequestBodySourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
ToJSON PostTransfersRequestBodySourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers

datadata PostTransfersResponse

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.

Instances2Eq, Show

Eq PostTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers
Show PostTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTransfers