StripeAPI.Operations.PostTopups

Contains the different functions to run the operation postTopups

Documentation

postTopups

Arguments

:: forall m. 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>

data PostTopupsRequestBody

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

Constructors

PostTopupsRequestBody

Fields

• 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.

Instances

Eq PostTopupsRequestBody

Defined in StripeAPI.Operations.PostTopups

Methods

(==) :: PostTopupsRequestBody -> PostTopupsRequestBody -> Bool

(/=) :: PostTopupsRequestBody -> PostTopupsRequestBody -> Bool

Show PostTopupsRequestBody

Defined in StripeAPI.Operations.PostTopups

Methods

showsPrec :: Int -> PostTopupsRequestBody -> ShowS

show :: PostTopupsRequestBody -> String

showList :: [PostTopupsRequestBody] -> ShowS

ToJSON PostTopupsRequestBody

Defined in StripeAPI.Operations.PostTopups

Methods

toJSON :: PostTopupsRequestBody -> Value

toEncoding :: PostTopupsRequestBody -> Encoding

toJSONList :: [PostTopupsRequestBody] -> Value

toEncodingList :: [PostTopupsRequestBody] -> Encoding

FromJSON PostTopupsRequestBody

Defined in StripeAPI.Operations.PostTopups

Methods

parseJSON :: Value -> Parser PostTopupsRequestBody

parseJSONList :: Value -> Parser [PostTopupsRequestBody]

mkPostTopupsRequestBody

Arguments

:: Int

postTopupsRequestBodyAmount

-> Text

postTopupsRequestBodyCurrency

-> PostTopupsRequestBody

Create a new PostTopupsRequestBody with all required fields.

data 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

Instances

Eq PostTopupsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopups

Methods

(==) :: PostTopupsRequestBodyMetadata'Variants -> PostTopupsRequestBodyMetadata'Variants -> Bool

(/=) :: PostTopupsRequestBodyMetadata'Variants -> PostTopupsRequestBodyMetadata'Variants -> Bool

Show PostTopupsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopups

Methods

showsPrec :: Int -> PostTopupsRequestBodyMetadata'Variants -> ShowS

show :: PostTopupsRequestBodyMetadata'Variants -> String

showList :: [PostTopupsRequestBodyMetadata'Variants] -> ShowS

ToJSON PostTopupsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopups

Methods

toJSON :: PostTopupsRequestBodyMetadata'Variants -> Value

toEncoding :: PostTopupsRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostTopupsRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostTopupsRequestBodyMetadata'Variants] -> Encoding

FromJSON PostTopupsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopups

Methods

parseJSON :: Value -> Parser PostTopupsRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostTopupsRequestBodyMetadata'Variants]

data 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.

Instances

Eq PostTopupsResponse

Defined in StripeAPI.Operations.PostTopups

Methods

(==) :: PostTopupsResponse -> PostTopupsResponse -> Bool

(/=) :: PostTopupsResponse -> PostTopupsResponse -> Bool

Show PostTopupsResponse

Defined in StripeAPI.Operations.PostTopups

Methods

showsPrec :: Int -> PostTopupsResponse -> ShowS

show :: PostTopupsResponse -> String

showList :: [PostTopupsResponse] -> ShowS