stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetBalance

Description

Contains the different functions to run the operation getBalance

Synopsis

Documentation

getBalance Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> GetBalanceRequestBody

The request body to send

-> m (Either HttpException (Response GetBalanceResponse))

Monad containing the result of the operation

GET /v1/balance

<p>Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see <a href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative balances</a>.</p>

getBalanceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> GetBalanceRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/balance

The same as getBalance but returns the raw ByteString

data GetBalanceResponse Source #

Represents a response of the operation getBalance.

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

Constructors

GetBalanceResponseError String

Means either no matching case available or a parse error

GetBalanceResponse200 Balance

Successful response.

GetBalanceResponseDefault Error

Error response.