Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getBalanceHistory
Synopsis
- getBalanceHistory :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> m (Either HttpException (Response GetBalanceHistoryResponse))
- getBalanceHistoryRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> m (Either HttpException (Response ByteString))
- getBalanceHistoryM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBalanceHistoryResponse))
- getBalanceHistoryRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetBalanceHistoryRequestBody = GetBalanceHistoryRequestBody {
- data GetBalanceHistoryResponse
- data GetBalanceHistoryResponseBody200 = GetBalanceHistoryResponseBody200 {}
- data GetBalanceHistoryResponseBody200Object'
Documentation
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Maybe Text | available_on |
-> Maybe Text | created |
-> Maybe Text | currency: Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency. |
-> Maybe Text | ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000 |
-> Maybe Text | expand: Specifies which fields in the response should be expanded. |
-> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
-> Maybe Text | payout: For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. | Constraints: Maximum length of 5000 |
-> Maybe Text | source: Only returns the original transaction. | Constraints: Maximum length of 5000 |
-> Maybe Text | starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
-> Maybe Text | type: Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. | Constraints: Maximum length of 5000 |
-> Maybe GetBalanceHistoryRequestBody | The request body to send |
-> m (Either HttpException (Response GetBalanceHistoryResponse)) | Monad containing the result of the operation |
GET /v1/balance/history
<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p>
<p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>
getBalanceHistoryRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/balance/history
The same as getBalanceHistory
but returns the raw ByteString
getBalanceHistoryM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBalanceHistoryResponse)) Source #
GET /v1/balance/history
Monadic version of getBalanceHistory
(use with runWithConfiguration
)
getBalanceHistoryRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/balance/history
Monadic version of getBalanceHistoryRaw
(use with runWithConfiguration
)
data GetBalanceHistoryRequestBody Source #
Defines the data type for the schema getBalanceHistoryRequestBody
Instances
data GetBalanceHistoryResponse Source #
Represents a response of the operation getBalanceHistory
.
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), GetBalanceHistoryResponseError
is used.
GetBalanceHistoryResponseError String | Means either no matching case available or a parse error |
GetBalanceHistoryResponse200 GetBalanceHistoryResponseBody200 | Successful response. |
GetBalanceHistoryResponseDefault Error | Error response. |
Instances
data GetBalanceHistoryResponseBody200 Source #
Defines the data type for the schema GetBalanceHistoryResponseBody200
GetBalanceHistoryResponseBody200 | |
|
data GetBalanceHistoryResponseBody200Object' Source #
Defines the enum schema GetBalanceHistoryResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
GetBalanceHistoryResponseBody200Object'EnumOther Value | |
GetBalanceHistoryResponseBody200Object'EnumTyped Text | |
GetBalanceHistoryResponseBody200Object'EnumStringList |