Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetBalanceTransactions

Description

Contains the different functions to run the operation getBalanceTransactions

Synopsis

getBalanceTransactions :: forall m. MonadHTTP m => GetBalanceTransactionsParameters -> ClientT m (Response GetBalanceTransactionsResponse)
data GetBalanceTransactionsParameters = GetBalanceTransactionsParameters {
}
mkGetBalanceTransactionsParameters :: GetBalanceTransactionsParameters
data GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 = GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 {
}
mkGetBalanceTransactionsParametersQueryAvailableOn'OneOf1 :: GetBalanceTransactionsParametersQueryAvailableOn'OneOf1
data GetBalanceTransactionsParametersQueryAvailableOn'Variants
- = GetBalanceTransactionsParametersQueryAvailableOn'GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 GetBalanceTransactionsParametersQueryAvailableOn'OneOf1
- | GetBalanceTransactionsParametersQueryAvailableOn'Int Int
data GetBalanceTransactionsParametersQueryCreated'OneOf1 = GetBalanceTransactionsParametersQueryCreated'OneOf1 {
}
mkGetBalanceTransactionsParametersQueryCreated'OneOf1 :: GetBalanceTransactionsParametersQueryCreated'OneOf1
data GetBalanceTransactionsParametersQueryCreated'Variants
- = GetBalanceTransactionsParametersQueryCreated'GetBalanceTransactionsParametersQueryCreated'OneOf1 GetBalanceTransactionsParametersQueryCreated'OneOf1
- | GetBalanceTransactionsParametersQueryCreated'Int Int
data GetBalanceTransactionsResponse
data GetBalanceTransactionsResponseBody200 = GetBalanceTransactionsResponseBody200 {
}
mkGetBalanceTransactionsResponseBody200 :: [BalanceTransaction] -> Bool -> Text -> GetBalanceTransactionsResponseBody200

Documentation

getBalanceTransactions Source #

Arguments

:: forall m. MonadHTTP m
=> GetBalanceTransactionsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetBalanceTransactionsResponse)	Monadic computation which returns the result of the operation

GET /v1/balance_transactions

<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 GetBalanceTransactionsParameters Source #

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

Constructors

GetBalanceTransactionsParameters

Fields

getBalanceTransactionsParametersQueryAvailableOn :: Maybe GetBalanceTransactionsParametersQueryAvailableOn'Variants
queryAvailable_on: Represents the parameter named 'available_on'
getBalanceTransactionsParametersQueryCreated :: Maybe GetBalanceTransactionsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getBalanceTransactionsParametersQueryCurrency :: 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.
getBalanceTransactionsParametersQueryEndingBefore :: 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
getBalanceTransactionsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getBalanceTransactionsParametersQueryLimit :: 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.
getBalanceTransactionsParametersQueryPayout :: 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
getBalanceTransactionsParametersQuerySource :: Maybe Text
querySource: Represents the parameter named 'source'
Only returns the original transaction.
Constraints:
- Maximum length of 5000
getBalanceTransactionsParametersQueryStartingAfter :: 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
getBalanceTransactionsParametersQueryType :: 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 GetBalanceTransactionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods (==) :: GetBalanceTransactionsParameters -> GetBalanceTransactionsParameters -> Bool # (/=) :: GetBalanceTransactionsParameters -> GetBalanceTransactionsParameters -> Bool #
Show GetBalanceTransactionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods showsPrec :: Int -> GetBalanceTransactionsParameters -> ShowS # show :: GetBalanceTransactionsParameters -> String # showList :: [GetBalanceTransactionsParameters] -> ShowS #
ToJSON GetBalanceTransactionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods toJSON :: GetBalanceTransactionsParameters -> Value # toEncoding :: GetBalanceTransactionsParameters -> Encoding # toJSONList :: [GetBalanceTransactionsParameters] -> Value # toEncodingList :: [GetBalanceTransactionsParameters] -> Encoding #
FromJSON GetBalanceTransactionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods parseJSON :: Value -> Parser GetBalanceTransactionsParameters # parseJSONList :: Value -> Parser [GetBalanceTransactionsParameters] #

mkGetBalanceTransactionsParameters :: GetBalanceTransactionsParameters Source #

Create a new GetBalanceTransactionsParameters with all required fields.

data GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 Source #

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

Constructors

GetBalanceTransactionsParametersQueryAvailableOn'OneOf1
Fields getBalanceTransactionsParametersQueryAvailableOn'OneOf1Gt :: Maybe Int gt getBalanceTransactionsParametersQueryAvailableOn'OneOf1Gte :: Maybe Int gte getBalanceTransactionsParametersQueryAvailableOn'OneOf1Lt :: Maybe Int lt getBalanceTransactionsParametersQueryAvailableOn'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetBalanceTransactionsParametersQueryAvailableOn'OneOf1 :: GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 Source #

Create a new GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 with all required fields.

data GetBalanceTransactionsParametersQueryAvailableOn'Variants Source #

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

Represents the parameter named 'available_on'

Constructors

GetBalanceTransactionsParametersQueryAvailableOn'GetBalanceTransactionsParametersQueryAvailableOn'OneOf1 GetBalanceTransactionsParametersQueryAvailableOn'OneOf1
GetBalanceTransactionsParametersQueryAvailableOn'Int Int

Instances

Instances details

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

data GetBalanceTransactionsParametersQueryCreated'OneOf1 Source #

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

Constructors

GetBalanceTransactionsParametersQueryCreated'OneOf1
Fields getBalanceTransactionsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getBalanceTransactionsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getBalanceTransactionsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getBalanceTransactionsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetBalanceTransactionsParametersQueryCreated'OneOf1 :: GetBalanceTransactionsParametersQueryCreated'OneOf1 Source #

Create a new GetBalanceTransactionsParametersQueryCreated'OneOf1 with all required fields.

data GetBalanceTransactionsParametersQueryCreated'Variants Source #

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

Represents the parameter named 'created'

Constructors

GetBalanceTransactionsParametersQueryCreated'GetBalanceTransactionsParametersQueryCreated'OneOf1 GetBalanceTransactionsParametersQueryCreated'OneOf1
GetBalanceTransactionsParametersQueryCreated'Int Int

Instances

Instances details

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

data GetBalanceTransactionsResponse Source #

Represents a response of the operation getBalanceTransactions.

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

Constructors

GetBalanceTransactionsResponseError String	Means either no matching case available or a parse error
GetBalanceTransactionsResponse200 GetBalanceTransactionsResponseBody200	Successful response.
GetBalanceTransactionsResponseDefault Error	Error response.

Instances

Instances details

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

data GetBalanceTransactionsResponseBody200 Source #

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

Constructors

GetBalanceTransactionsResponseBody200
Fields getBalanceTransactionsResponseBody200Data :: [BalanceTransaction] data getBalanceTransactionsResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getBalanceTransactionsResponseBody200Url :: 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 GetBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods (==) :: GetBalanceTransactionsResponseBody200 -> GetBalanceTransactionsResponseBody200 -> Bool # (/=) :: GetBalanceTransactionsResponseBody200 -> GetBalanceTransactionsResponseBody200 -> Bool #
Show GetBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods showsPrec :: Int -> GetBalanceTransactionsResponseBody200 -> ShowS # show :: GetBalanceTransactionsResponseBody200 -> String # showList :: [GetBalanceTransactionsResponseBody200] -> ShowS #
ToJSON GetBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods toJSON :: GetBalanceTransactionsResponseBody200 -> Value # toEncoding :: GetBalanceTransactionsResponseBody200 -> Encoding # toJSONList :: [GetBalanceTransactionsResponseBody200] -> Value # toEncodingList :: [GetBalanceTransactionsResponseBody200] -> Encoding #
FromJSON GetBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBalanceTransactions Methods parseJSON :: Value -> Parser GetBalanceTransactionsResponseBody200 # parseJSONList :: Value -> Parser [GetBalanceTransactionsResponseBody200] #

mkGetBalanceTransactionsResponseBody200 Source #

Arguments

:: [BalanceTransaction]	`getBalanceTransactionsResponseBody200Data`
-> Bool	`getBalanceTransactionsResponseBody200HasMore`
-> Text	`getBalanceTransactionsResponseBody200Url`
-> GetBalanceTransactionsResponseBody200

Create a new GetBalanceTransactionsResponseBody200 with all required fields.