Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetBalanceTransactions

Contains the different functions to run the operation getBalanceTransactions

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetBalanceTransactions.hs

valuegetBalanceTransactions

:: 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>

datadata GetBalanceTransactionsParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
Show GetBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
FromJSON GetBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
ToJSON GetBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions

valuemkGetBalanceTransactionsParameters :: GetBalanceTransactionsParameters

Create a new GetBalanceTransactionsParameters with all required fields.

datadata GetBalanceTransactionsParametersQueryCreated'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBalanceTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
Show GetBalanceTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
FromJSON GetBalanceTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
ToJSON GetBalanceTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions

valuemkGetBalanceTransactionsParametersQueryCreated'OneOf1 :: GetBalanceTransactionsParametersQueryCreated'OneOf1

Create a new GetBalanceTransactionsParametersQueryCreated'OneOf1 with all required fields.

datadata GetBalanceTransactionsParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBalanceTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
Show GetBalanceTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
FromJSON GetBalanceTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
ToJSON GetBalanceTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions

datadata GetBalanceTransactionsResponse

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.

Instances2Eq, Show

Eq GetBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
Show GetBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions

datadata GetBalanceTransactionsResponseBody200

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

Constructors

GetBalanceTransactionsResponseBody200
- 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'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
Show GetBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
FromJSON GetBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions
ToJSON GetBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBalanceTransactions

valuemkGetBalanceTransactionsResponseBody200

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

Create a new GetBalanceTransactionsResponseBody200 with all required fields.