Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTreasuryOutboundTransfers

Contains the different functions to run the operation postTreasuryOutboundTransfers

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourcePostTreasuryOutboundTransfers.hs

valuepostTreasuryOutboundTransfers

:: MonadHTTP m
=> PostTreasuryOutboundTransfersRequestBody
The request body to send
-> ClientT m (Response PostTreasuryOutboundTransfersResponse)
Monadic computation which returns the result of the operation

POST /v1/treasury/outbound_transfers

<p>Creates an OutboundTransfer.</p>

datadata PostTreasuryOutboundTransfersRequestBody

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

Constructors

PostTreasuryOutboundTransfersRequestBody
- postTreasuryOutboundTransfersRequestBodyAmount :: Int
  amount: Amount (in cents) to be transferred.
- postTreasuryOutboundTransfersRequestBodyCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- postTreasuryOutboundTransfersRequestBodyDescription :: Maybe Text
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- postTreasuryOutboundTransfersRequestBodyDestinationPaymentMethod :: Text
  destination_payment_method: The PaymentMethod to use as the payment instrument for the OutboundTransfer.
  Constraints:
  - Maximum length of 5000
- postTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions :: Maybe PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'
  destination_payment_method_options: Hash describing payment method configuration details.
- postTreasuryOutboundTransfersRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postTreasuryOutboundTransfersRequestBodyFinancialAccount :: Text
  financial_account: The FinancialAccount to pull funds from.
- postTreasuryOutboundTransfersRequestBodyMetadata :: 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`.
- postTreasuryOutboundTransfersRequestBodyStatementDescriptor :: Maybe Text
  statement_descriptor: Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `wire` transfers. The default value is `transfer`.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryOutboundTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
FromJSON PostTreasuryOutboundTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
ToJSON PostTreasuryOutboundTransfersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers

valuemkPostTreasuryOutboundTransfersRequestBody

:: Int
postTreasuryOutboundTransfersRequestBodyAmount
-> Text
postTreasuryOutboundTransfersRequestBodyCurrency
-> Text
postTreasuryOutboundTransfersRequestBodyDestinationPaymentMethod
-> Text
postTreasuryOutboundTransfersRequestBodyFinancialAccount
-> PostTreasuryOutboundTransfersRequestBody

Create a new PostTreasuryOutboundTransfersRequestBody with all required fields.

datadata PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'

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

Hash describing payment method configuration details.

Constructors

PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'
- postTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount :: Maybe PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'Variants
  us_bank_account

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
FromJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
ToJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers

value

mkPostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions' :: PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'

Create a new PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions' with all required fields.

datadata PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1

Constructors

PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1
- postTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network :: Maybe PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'
  network

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
FromJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
ToJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers

value

mkPostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1 :: PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1

Create a new PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1 with all required fields.

datadata PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'

Defines the enum schema located at paths./v1/treasury/outbound_transfers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.destination_payment_method_options.properties.us_bank_account.anyOf.properties.network in the specification.

Constructors

PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'EnumAch
Represents the JSON value "ach"
PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'EnumUsDomesticWire
Represents the JSON value "us_domestic_wire"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
FromJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
ToJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1Network'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers

datadata PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'Variants

Defines the oneOf schema located at paths./v1/treasury/outbound_transfers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.destination_payment_method_options.properties.us_bank_account.anyOf in the specification.

Constructors

PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'EmptyString
Represents the JSON value ""
PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1 PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
FromJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
ToJSON PostTreasuryOutboundTransfersRequestBodyDestinationPaymentMethodOptions'UsBankAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers

datadata PostTreasuryOutboundTransfersResponse

Represents a response of the operation postTreasuryOutboundTransfers.

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

Constructors

PostTreasuryOutboundTransfersResponseError String
Means either no matching case available or a parse error
PostTreasuryOutboundTransfersResponse200 Treasury'outboundTransfer
Successful response.
PostTreasuryOutboundTransfersResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostTreasuryOutboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers
Show PostTreasuryOutboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryOutboundTransfers