StripeAPI.Operations.GetBalanceHistory

Contains the different functions to run the operation getBalanceHistory

Documentation

getBalanceHistory

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe String

available_on

-> Maybe String

created

-> Maybe String

currency: Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.

-> Maybe String

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 String

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 String

payout: For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. | Constraints: Maximum length of 5000

-> Maybe String

source: Only returns the original transaction. | Constraints: Maximum length of 5000

-> Maybe String

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 String

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

-> 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 String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetBalanceHistoryRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/balance/history

The same as getBalanceHistory but returns the raw ByteString

getBalanceHistoryM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBalanceHistoryResponse))

GET /v1/balance/history

Monadic version of getBalanceHistory (use with runWithConfiguration)

getBalanceHistoryRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetBalanceHistoryRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/balance/history

Monadic version of getBalanceHistoryRaw (use with runWithConfiguration)

data GetBalanceHistoryRequestBody

Defines the data type for the schema getBalanceHistoryRequestBody

Constructors

GetBalanceHistoryRequestBody

Instances

Eq GetBalanceHistoryRequestBody

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

(==) :: GetBalanceHistoryRequestBody -> GetBalanceHistoryRequestBody -> Bool

(/=) :: GetBalanceHistoryRequestBody -> GetBalanceHistoryRequestBody -> Bool

Show GetBalanceHistoryRequestBody

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

showsPrec :: Int -> GetBalanceHistoryRequestBody -> ShowS

show :: GetBalanceHistoryRequestBody -> String

showList :: [GetBalanceHistoryRequestBody] -> ShowS

ToJSON GetBalanceHistoryRequestBody

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

toJSON :: GetBalanceHistoryRequestBody -> Value

toEncoding :: GetBalanceHistoryRequestBody -> Encoding

toJSONList :: [GetBalanceHistoryRequestBody] -> Value

toEncodingList :: [GetBalanceHistoryRequestBody] -> Encoding

FromJSON GetBalanceHistoryRequestBody

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

parseJSON :: Value -> Parser GetBalanceHistoryRequestBody

parseJSONList :: Value -> Parser [GetBalanceHistoryRequestBody]

data GetBalanceHistoryResponse

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

Eq GetBalanceHistoryResponse

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

(==) :: GetBalanceHistoryResponse -> GetBalanceHistoryResponse -> Bool

(/=) :: GetBalanceHistoryResponse -> GetBalanceHistoryResponse -> Bool

Show GetBalanceHistoryResponse

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

showsPrec :: Int -> GetBalanceHistoryResponse -> ShowS

show :: GetBalanceHistoryResponse -> String

showList :: [GetBalanceHistoryResponse] -> ShowS

data GetBalanceHistoryResponseBody200

Defines the data type for the schema GetBalanceHistoryResponseBody200

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.

• getBalanceHistoryResponseBody200Object :: GetBalanceHistoryResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getBalanceHistoryResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/balance_transactions'

Instances

Eq GetBalanceHistoryResponseBody200

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

(==) :: GetBalanceHistoryResponseBody200 -> GetBalanceHistoryResponseBody200 -> Bool

(/=) :: GetBalanceHistoryResponseBody200 -> GetBalanceHistoryResponseBody200 -> Bool

Show GetBalanceHistoryResponseBody200

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

showsPrec :: Int -> GetBalanceHistoryResponseBody200 -> ShowS

show :: GetBalanceHistoryResponseBody200 -> String

showList :: [GetBalanceHistoryResponseBody200] -> ShowS

ToJSON GetBalanceHistoryResponseBody200

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

toJSON :: GetBalanceHistoryResponseBody200 -> Value

toEncoding :: GetBalanceHistoryResponseBody200 -> Encoding

toJSONList :: [GetBalanceHistoryResponseBody200] -> Value

toEncodingList :: [GetBalanceHistoryResponseBody200] -> Encoding

FromJSON GetBalanceHistoryResponseBody200

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

parseJSON :: Value -> Parser GetBalanceHistoryResponseBody200

parseJSONList :: Value -> Parser [GetBalanceHistoryResponseBody200]

data GetBalanceHistoryResponseBody200Object'

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`.

Constructors

GetBalanceHistoryResponseBody200Object'EnumOther Value

GetBalanceHistoryResponseBody200Object'EnumTyped String

GetBalanceHistoryResponseBody200Object'EnumStringList

Instances

Eq GetBalanceHistoryResponseBody200Object'

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

(==) :: GetBalanceHistoryResponseBody200Object' -> GetBalanceHistoryResponseBody200Object' -> Bool

(/=) :: GetBalanceHistoryResponseBody200Object' -> GetBalanceHistoryResponseBody200Object' -> Bool

Show GetBalanceHistoryResponseBody200Object'

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

showsPrec :: Int -> GetBalanceHistoryResponseBody200Object' -> ShowS

show :: GetBalanceHistoryResponseBody200Object' -> String

showList :: [GetBalanceHistoryResponseBody200Object'] -> ShowS

ToJSON GetBalanceHistoryResponseBody200Object'

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

toJSON :: GetBalanceHistoryResponseBody200Object' -> Value

toEncoding :: GetBalanceHistoryResponseBody200Object' -> Encoding

toJSONList :: [GetBalanceHistoryResponseBody200Object'] -> Value

toEncodingList :: [GetBalanceHistoryResponseBody200Object'] -> Encoding

FromJSON GetBalanceHistoryResponseBody200Object'

Defined in StripeAPI.Operations.GetBalanceHistory

Methods

parseJSON :: Value -> Parser GetBalanceHistoryResponseBody200Object'

parseJSONList :: Value -> Parser [GetBalanceHistoryResponseBody200Object']