Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryReceivedDebits

Contains the different functions to run the operation getTreasuryReceivedDebits

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryReceivedDebits.hs

valuegetTreasuryReceivedDebits

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

GET /v1/treasury/received_debits

<p>Returns a list of ReceivedDebits.</p>

datadata GetTreasuryReceivedDebitsParameters

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

Constructors

GetTreasuryReceivedDebitsParameters
- getTreasuryReceivedDebitsParametersQueryEndingBefore :: 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
- getTreasuryReceivedDebitsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryReceivedDebitsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  The FinancialAccount that funds were pulled from.
- getTreasuryReceivedDebitsParametersQueryLimit :: 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.
- getTreasuryReceivedDebitsParametersQueryStartingAfter :: 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
- getTreasuryReceivedDebitsParametersQueryStatus :: Maybe GetTreasuryReceivedDebitsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return ReceivedDebits that have the given status: `succeeded` or `failed`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedDebitsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
Show GetTreasuryReceivedDebitsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
FromJSON GetTreasuryReceivedDebitsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
ToJSON GetTreasuryReceivedDebitsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits

valuemkGetTreasuryReceivedDebitsParameters

:: Text
getTreasuryReceivedDebitsParametersQueryFinancialAccount
-> GetTreasuryReceivedDebitsParameters

Create a new GetTreasuryReceivedDebitsParameters with all required fields.

datadata GetTreasuryReceivedDebitsParametersQueryStatus'

Defines the enum schema located at paths./v1/treasury/received_debits.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return ReceivedDebits that have the given status: `succeeded` or `failed`.

Constructors

GetTreasuryReceivedDebitsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryReceivedDebitsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryReceivedDebitsParametersQueryStatus'EnumFailed
Represents the JSON value "failed"
GetTreasuryReceivedDebitsParametersQueryStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedDebitsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
Show GetTreasuryReceivedDebitsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
FromJSON GetTreasuryReceivedDebitsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
ToJSON GetTreasuryReceivedDebitsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits

datadata GetTreasuryReceivedDebitsResponse

Represents a response of the operation getTreasuryReceivedDebits.

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

Constructors

GetTreasuryReceivedDebitsResponseError String
Means either no matching case available or a parse error
GetTreasuryReceivedDebitsResponse200 GetTreasuryReceivedDebitsResponseBody200
Successful response.
GetTreasuryReceivedDebitsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryReceivedDebitsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
Show GetTreasuryReceivedDebitsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits

datadata GetTreasuryReceivedDebitsResponseBody200

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

Constructors

GetTreasuryReceivedDebitsResponseBody200
- getTreasuryReceivedDebitsResponseBody200Data :: [Treasury'receivedDebit]
  data: Details about each object.
- getTreasuryReceivedDebitsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryReceivedDebitsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedDebitsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
Show GetTreasuryReceivedDebitsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
FromJSON GetTreasuryReceivedDebitsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits
ToJSON GetTreasuryReceivedDebitsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedDebits

valuemkGetTreasuryReceivedDebitsResponseBody200

:: [Treasury'receivedDebit]
getTreasuryReceivedDebitsResponseBody200Data
-> Bool
getTreasuryReceivedDebitsResponseBody200HasMore
-> Text
getTreasuryReceivedDebitsResponseBody200Url
-> GetTreasuryReceivedDebitsResponseBody200

Create a new GetTreasuryReceivedDebitsResponseBody200 with all required fields.