Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTopups

Contains the different functions to run the operation postTopups

3 types
2 values

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourcePostTopups.hs

valuepostTopups

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

POST /v1/topups

<p>Top up the balance of an account</p>

datadata PostTopupsRequestBody

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

Constructors

PostTopupsRequestBody
- postTopupsRequestBodyAmount :: Int
  amount: A positive integer representing how much to transfer.
- postTopupsRequestBodyCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- postTopupsRequestBodyDescription :: Maybe Text
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- postTopupsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postTopupsRequestBodyMetadata :: Maybe PostTopupsRequestBodyMetadata'Variants
  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`.
- postTopupsRequestBodySource :: Maybe Text
  source: The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see Testing Top-ups).
  Constraints:
  - Maximum length of 5000
- postTopupsRequestBodyStatementDescriptor :: Maybe Text
  statement_descriptor: Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
  Constraints:
  - Maximum length of 15
- postTopupsRequestBodyTransferGroup :: Maybe Text
  transfer_group: A string that identifies this top-up as part of a group.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTopupsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
Show PostTopupsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
FromJSON PostTopupsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
ToJSON PostTopupsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups

valuemkPostTopupsRequestBody

:: Int
postTopupsRequestBodyAmount
-> Text
postTopupsRequestBodyCurrency
-> PostTopupsRequestBody

Create a new PostTopupsRequestBody with all required fields.

datadata PostTopupsRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/topups.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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

PostTopupsRequestBodyMetadata'EmptyString
Represents the JSON value ""
PostTopupsRequestBodyMetadata'Object Object

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTopupsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
Show PostTopupsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
FromJSON PostTopupsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
ToJSON PostTopupsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups

datadata PostTopupsResponse

Represents a response of the operation postTopups.

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

Constructors

PostTopupsResponseError String
Means either no matching case available or a parse error
PostTopupsResponse200 Topup
Successful response.
PostTopupsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostTopupsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups
Show PostTopupsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTopups