Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetBalanceHistory

Description

Contains the different functions to run the operation getBalanceHistory

Synopsis

getBalanceHistory :: forall m. MonadHTTP m => GetBalanceHistoryParameters -> ClientT m (Response GetBalanceHistoryResponse)
data GetBalanceHistoryParameters = GetBalanceHistoryParameters {
}
mkGetBalanceHistoryParameters :: GetBalanceHistoryParameters
data GetBalanceHistoryParametersQueryAvailableOn'OneOf1 = GetBalanceHistoryParametersQueryAvailableOn'OneOf1 {
}
mkGetBalanceHistoryParametersQueryAvailableOn'OneOf1 :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1
data GetBalanceHistoryParametersQueryAvailableOn'Variants
- = GetBalanceHistoryParametersQueryAvailableOn'GetBalanceHistoryParametersQueryAvailableOn'OneOf1 GetBalanceHistoryParametersQueryAvailableOn'OneOf1
- | GetBalanceHistoryParametersQueryAvailableOn'Int Int
data GetBalanceHistoryParametersQueryCreated'OneOf1 = GetBalanceHistoryParametersQueryCreated'OneOf1 {
}
mkGetBalanceHistoryParametersQueryCreated'OneOf1 :: GetBalanceHistoryParametersQueryCreated'OneOf1
data GetBalanceHistoryParametersQueryCreated'Variants
- = GetBalanceHistoryParametersQueryCreated'GetBalanceHistoryParametersQueryCreated'OneOf1 GetBalanceHistoryParametersQueryCreated'OneOf1
- | GetBalanceHistoryParametersQueryCreated'Int Int
data GetBalanceHistoryResponse
data GetBalanceHistoryResponseBody200 = GetBalanceHistoryResponseBody200 {
}
mkGetBalanceHistoryResponseBody200 :: [BalanceTransaction] -> Bool -> Text -> GetBalanceHistoryResponseBody200

Documentation

getBalanceHistory Source #

Arguments

:: forall m. MonadHTTP m
=> GetBalanceHistoryParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetBalanceHistoryResponse)	Monadic computation which returns 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>

data GetBalanceHistoryParameters Source #

Defines the object schema located at paths./v1/balance/history.GET.parameters in the specification.

Constructors

GetBalanceHistoryParameters

Fields

getBalanceHistoryParametersQueryAvailableOn :: Maybe GetBalanceHistoryParametersQueryAvailableOn'Variants
queryAvailable_on: Represents the parameter named 'available_on'
getBalanceHistoryParametersQueryCreated :: Maybe GetBalanceHistoryParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getBalanceHistoryParametersQueryCurrency :: Maybe Text
queryCurrency: Represents the parameter named 'currency'
Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
getBalanceHistoryParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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
getBalanceHistoryParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getBalanceHistoryParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getBalanceHistoryParametersQueryPayout :: Maybe Text
queryPayout: Represents the parameter named 'payout'
For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
Constraints:
- Maximum length of 5000
getBalanceHistoryParametersQuerySource :: Maybe Text
querySource: Represents the parameter named 'source'
Only returns the original transaction.
Constraints:
- Maximum length of 5000
getBalanceHistoryParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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
getBalanceHistoryParametersQueryType :: Maybe Text
queryType: Represents the parameter named 'type'
Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq GetBalanceHistoryParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryParameters -> GetBalanceHistoryParameters -> Bool # (/=) :: GetBalanceHistoryParameters -> GetBalanceHistoryParameters -> Bool #
Show GetBalanceHistoryParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryParameters -> ShowS # show :: GetBalanceHistoryParameters -> String # showList :: [GetBalanceHistoryParameters] -> ShowS #
ToJSON GetBalanceHistoryParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryParameters -> Value # toEncoding :: GetBalanceHistoryParameters -> Encoding # toJSONList :: [GetBalanceHistoryParameters] -> Value # toEncodingList :: [GetBalanceHistoryParameters] -> Encoding #
FromJSON GetBalanceHistoryParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryParameters # parseJSONList :: Value -> Parser [GetBalanceHistoryParameters] #

mkGetBalanceHistoryParameters :: GetBalanceHistoryParameters Source #

Create a new GetBalanceHistoryParameters with all required fields.

data GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #

Defines the object schema located at paths./v1/balance/history.GET.parameters.properties.queryAvailable_on.anyOf in the specification.

Constructors

GetBalanceHistoryParametersQueryAvailableOn'OneOf1
Fields getBalanceHistoryParametersQueryAvailableOn'OneOf1Gt :: Maybe Int gt getBalanceHistoryParametersQueryAvailableOn'OneOf1Gte :: Maybe Int gte getBalanceHistoryParametersQueryAvailableOn'OneOf1Lt :: Maybe Int lt getBalanceHistoryParametersQueryAvailableOn'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> Bool # (/=) :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> Bool #
Show GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> ShowS # show :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> String # showList :: [GetBalanceHistoryParametersQueryAvailableOn'OneOf1] -> ShowS #
ToJSON GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> Value # toEncoding :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 -> Encoding # toJSONList :: [GetBalanceHistoryParametersQueryAvailableOn'OneOf1] -> Value # toEncodingList :: [GetBalanceHistoryParametersQueryAvailableOn'OneOf1] -> Encoding #
FromJSON GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryParametersQueryAvailableOn'OneOf1 # parseJSONList :: Value -> Parser [GetBalanceHistoryParametersQueryAvailableOn'OneOf1] #

mkGetBalanceHistoryParametersQueryAvailableOn'OneOf1 :: GetBalanceHistoryParametersQueryAvailableOn'OneOf1 Source #

Create a new GetBalanceHistoryParametersQueryAvailableOn'OneOf1 with all required fields.

data GetBalanceHistoryParametersQueryAvailableOn'Variants Source #

Defines the oneOf schema located at paths./v1/balance/history.GET.parameters.properties.queryAvailable_on.anyOf in the specification.

Represents the parameter named 'available_on'

Constructors

GetBalanceHistoryParametersQueryAvailableOn'GetBalanceHistoryParametersQueryAvailableOn'OneOf1 GetBalanceHistoryParametersQueryAvailableOn'OneOf1
GetBalanceHistoryParametersQueryAvailableOn'Int Int

Instances

Instances details

Eq GetBalanceHistoryParametersQueryAvailableOn'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryParametersQueryAvailableOn'Variants -> GetBalanceHistoryParametersQueryAvailableOn'Variants -> Bool # (/=) :: GetBalanceHistoryParametersQueryAvailableOn'Variants -> GetBalanceHistoryParametersQueryAvailableOn'Variants -> Bool #
Show GetBalanceHistoryParametersQueryAvailableOn'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryParametersQueryAvailableOn'Variants -> ShowS # show :: GetBalanceHistoryParametersQueryAvailableOn'Variants -> String # showList :: [GetBalanceHistoryParametersQueryAvailableOn'Variants] -> ShowS #
ToJSON GetBalanceHistoryParametersQueryAvailableOn'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryParametersQueryAvailableOn'Variants -> Value # toEncoding :: GetBalanceHistoryParametersQueryAvailableOn'Variants -> Encoding # toJSONList :: [GetBalanceHistoryParametersQueryAvailableOn'Variants] -> Value # toEncodingList :: [GetBalanceHistoryParametersQueryAvailableOn'Variants] -> Encoding #
FromJSON GetBalanceHistoryParametersQueryAvailableOn'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryParametersQueryAvailableOn'Variants # parseJSONList :: Value -> Parser [GetBalanceHistoryParametersQueryAvailableOn'Variants] #

data GetBalanceHistoryParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/balance/history.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetBalanceHistoryParametersQueryCreated'OneOf1
Fields getBalanceHistoryParametersQueryCreated'OneOf1Gt :: Maybe Int gt getBalanceHistoryParametersQueryCreated'OneOf1Gte :: Maybe Int gte getBalanceHistoryParametersQueryCreated'OneOf1Lt :: Maybe Int lt getBalanceHistoryParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetBalanceHistoryParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryParametersQueryCreated'OneOf1 -> GetBalanceHistoryParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetBalanceHistoryParametersQueryCreated'OneOf1 -> GetBalanceHistoryParametersQueryCreated'OneOf1 -> Bool #
Show GetBalanceHistoryParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryParametersQueryCreated'OneOf1 -> ShowS # show :: GetBalanceHistoryParametersQueryCreated'OneOf1 -> String # showList :: [GetBalanceHistoryParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetBalanceHistoryParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetBalanceHistoryParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetBalanceHistoryParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetBalanceHistoryParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetBalanceHistoryParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetBalanceHistoryParametersQueryCreated'OneOf1] #

mkGetBalanceHistoryParametersQueryCreated'OneOf1 :: GetBalanceHistoryParametersQueryCreated'OneOf1 Source #

Create a new GetBalanceHistoryParametersQueryCreated'OneOf1 with all required fields.

data GetBalanceHistoryParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/balance/history.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetBalanceHistoryParametersQueryCreated'GetBalanceHistoryParametersQueryCreated'OneOf1 GetBalanceHistoryParametersQueryCreated'OneOf1
GetBalanceHistoryParametersQueryCreated'Int Int

Instances

Instances details

Eq GetBalanceHistoryParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryParametersQueryCreated'Variants -> GetBalanceHistoryParametersQueryCreated'Variants -> Bool # (/=) :: GetBalanceHistoryParametersQueryCreated'Variants -> GetBalanceHistoryParametersQueryCreated'Variants -> Bool #
Show GetBalanceHistoryParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryParametersQueryCreated'Variants -> ShowS # show :: GetBalanceHistoryParametersQueryCreated'Variants -> String # showList :: [GetBalanceHistoryParametersQueryCreated'Variants] -> ShowS #
ToJSON GetBalanceHistoryParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryParametersQueryCreated'Variants -> Value # toEncoding :: GetBalanceHistoryParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetBalanceHistoryParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetBalanceHistoryParametersQueryCreated'Variants] -> Encoding #
FromJSON GetBalanceHistoryParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetBalanceHistoryParametersQueryCreated'Variants] #

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.

Constructors

GetBalanceHistoryResponseError String	Means either no matching case available or a parse error
GetBalanceHistoryResponse200 GetBalanceHistoryResponseBody200	Successful response.
GetBalanceHistoryResponseDefault Error	Error response.

Instances

Instances details

Eq GetBalanceHistoryResponse Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryResponse -> GetBalanceHistoryResponse -> Bool # (/=) :: GetBalanceHistoryResponse -> GetBalanceHistoryResponse -> Bool #
Show GetBalanceHistoryResponse Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryResponse -> ShowS # show :: GetBalanceHistoryResponse -> String # showList :: [GetBalanceHistoryResponse] -> ShowS #

data GetBalanceHistoryResponseBody200 Source #

Defines the object schema located at paths./v1/balance/history.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetBalanceHistoryResponseBody200
Fields getBalanceHistoryResponseBody200Data :: [BalanceTransaction] data getBalanceHistoryResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getBalanceHistoryResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/balance_transactions'

Instances

Instances details

Eq GetBalanceHistoryResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods (==) :: GetBalanceHistoryResponseBody200 -> GetBalanceHistoryResponseBody200 -> Bool # (/=) :: GetBalanceHistoryResponseBody200 -> GetBalanceHistoryResponseBody200 -> Bool #
Show GetBalanceHistoryResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods showsPrec :: Int -> GetBalanceHistoryResponseBody200 -> ShowS # show :: GetBalanceHistoryResponseBody200 -> String # showList :: [GetBalanceHistoryResponseBody200] -> ShowS #
ToJSON GetBalanceHistoryResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods toJSON :: GetBalanceHistoryResponseBody200 -> Value # toEncoding :: GetBalanceHistoryResponseBody200 -> Encoding # toJSONList :: [GetBalanceHistoryResponseBody200] -> Value # toEncodingList :: [GetBalanceHistoryResponseBody200] -> Encoding #
FromJSON GetBalanceHistoryResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceHistory Methods parseJSON :: Value -> Parser GetBalanceHistoryResponseBody200 # parseJSONList :: Value -> Parser [GetBalanceHistoryResponseBody200] #

mkGetBalanceHistoryResponseBody200 Source #

Arguments

:: [BalanceTransaction]	`getBalanceHistoryResponseBody200Data`
-> Bool	`getBalanceHistoryResponseBody200HasMore`
-> Text	`getBalanceHistoryResponseBody200Url`
-> GetBalanceHistoryResponseBody200

Create a new GetBalanceHistoryResponseBody200 with all required fields.