Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance

Contains the different functions to run the operation postPaymentIntentsIntentApplyCustomerBalance

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostPaymentIntentsIntentApplyCustomerBalance.hs

valuepostPaymentIntentsIntentApplyCustomerBalance

:: MonadHTTP m
=> Text
intent | Constraints: Maximum length of 5000
-> Maybe PostPaymentIntentsIntentApplyCustomerBalanceRequestBody
The request body to send
-> ClientT m (Response PostPaymentIntentsIntentApplyCustomerBalanceResponse)
Monadic computation which returns the result of the operation

POST /v1/payment_intents/{intent}/apply_customer_balance

<p>Manually reconcile the remaining amount for a customer_balance PaymentIntent.</p>

<p>This can be used when the cash balance for <a href="docs/payments/customer-balance/reconciliation#cash-manual-reconciliation">a customer in manual reconciliation mode</a> received funds.</p>

datadata PostPaymentIntentsIntentApplyCustomerBalanceRequestBody

Defines the object schema located at paths./v1/payment_intents/{intent}/apply_customer_balance.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostPaymentIntentsIntentApplyCustomerBalanceRequestBody
- postPaymentIntentsIntentApplyCustomerBalanceRequestBodyAmount :: Maybe Int
  amount: Amount intended to be applied to this PaymentIntent from the customer’s cash balance.
  A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
  The maximum amount is the amount of the PaymentIntent.
  When omitted, the amount defaults to the remaining amount requested on the PaymentIntent.
- postPaymentIntentsIntentApplyCustomerBalanceRequestBodyCurrency :: Maybe Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- postPaymentIntentsIntentApplyCustomerBalanceRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostPaymentIntentsIntentApplyCustomerBalanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance
Show PostPaymentIntentsIntentApplyCustomerBalanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance
FromJSON PostPaymentIntentsIntentApplyCustomerBalanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance
ToJSON PostPaymentIntentsIntentApplyCustomerBalanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance

valuemkPostPaymentIntentsIntentApplyCustomerBalanceRequestBody :: PostPaymentIntentsIntentApplyCustomerBalanceRequestBody

Create a new PostPaymentIntentsIntentApplyCustomerBalanceRequestBody with all required fields.

datadata PostPaymentIntentsIntentApplyCustomerBalanceResponse

Represents a response of the operation postPaymentIntentsIntentApplyCustomerBalance.

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

Constructors

PostPaymentIntentsIntentApplyCustomerBalanceResponseError String
Means either no matching case available or a parse error
PostPaymentIntentsIntentApplyCustomerBalanceResponse200 PaymentIntent
Successful response.
PostPaymentIntentsIntentApplyCustomerBalanceResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostPaymentIntentsIntentApplyCustomerBalanceResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance
Show PostPaymentIntentsIntentApplyCustomerBalanceResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPaymentIntentsIntentApplyCustomerBalance