Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryReceivedCredits

Contains the different functions to run the operation getTreasuryReceivedCredits

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryReceivedCredits.hs

valuegetTreasuryReceivedCredits

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

GET /v1/treasury/received_credits

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

datadata GetTreasuryReceivedCreditsParameters

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

Constructors

GetTreasuryReceivedCreditsParameters
- getTreasuryReceivedCreditsParametersQueryEndingBefore :: 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
- getTreasuryReceivedCreditsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryReceivedCreditsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  The FinancialAccount that received the funds.
- getTreasuryReceivedCreditsParametersQueryLimit :: 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.
- getTreasuryReceivedCreditsParametersQueryLinkedFlows :: Maybe GetTreasuryReceivedCreditsParametersQueryLinkedFlows'
  queryLinked_flows: Represents the parameter named 'linked_flows'
  Only return ReceivedCredits described by the flow.
- getTreasuryReceivedCreditsParametersQueryStartingAfter :: 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
- getTreasuryReceivedCreditsParametersQueryStatus :: Maybe GetTreasuryReceivedCreditsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return ReceivedCredits that have the given status: `succeeded` or `failed`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedCreditsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
FromJSON GetTreasuryReceivedCreditsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
ToJSON GetTreasuryReceivedCreditsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

valuemkGetTreasuryReceivedCreditsParameters

:: Text
getTreasuryReceivedCreditsParametersQueryFinancialAccount
-> GetTreasuryReceivedCreditsParameters

Create a new GetTreasuryReceivedCreditsParameters with all required fields.

datadata GetTreasuryReceivedCreditsParametersQueryLinkedFlows'

Defines the object schema located at paths./v1/treasury/received_credits.GET.parameters.properties.queryLinked_flows in the specification.

Represents the parameter named 'linked_flows'

Only return ReceivedCredits described by the flow.

Constructors

GetTreasuryReceivedCreditsParametersQueryLinkedFlows'
- getTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType :: GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'
  source_flow_type

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedCreditsParametersQueryLinkedFlows'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsParametersQueryLinkedFlows'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
FromJSON GetTreasuryReceivedCreditsParametersQueryLinkedFlows'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
ToJSON GetTreasuryReceivedCreditsParametersQueryLinkedFlows'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

valuemkGetTreasuryReceivedCreditsParametersQueryLinkedFlows'

:: GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'
getTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType
-> GetTreasuryReceivedCreditsParametersQueryLinkedFlows'

Create a new GetTreasuryReceivedCreditsParametersQueryLinkedFlows' with all required fields.

datadata GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'

Defines the enum schema located at paths./v1/treasury/received_credits.GET.parameters.properties.queryLinked_flows.properties.source_flow_type in the specification.

Constructors

GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'EnumCreditReversal
Represents the JSON value "credit_reversal"
GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'EnumOther
Represents the JSON value "other"
GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'EnumOutboundPayment
Represents the JSON value "outbound_payment"
GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'EnumPayout
Represents the JSON value "payout"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
FromJSON GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
ToJSON GetTreasuryReceivedCreditsParametersQueryLinkedFlows'SourceFlowType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

datadata GetTreasuryReceivedCreditsParametersQueryStatus'

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

Represents the parameter named 'status'

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedCreditsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
FromJSON GetTreasuryReceivedCreditsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
ToJSON GetTreasuryReceivedCreditsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

datadata GetTreasuryReceivedCreditsResponse

Represents a response of the operation getTreasuryReceivedCredits.

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

Constructors

GetTreasuryReceivedCreditsResponseError String
Means either no matching case available or a parse error
GetTreasuryReceivedCreditsResponse200 GetTreasuryReceivedCreditsResponseBody200
Successful response.
GetTreasuryReceivedCreditsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryReceivedCreditsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

datadata GetTreasuryReceivedCreditsResponseBody200

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

Constructors

GetTreasuryReceivedCreditsResponseBody200
- getTreasuryReceivedCreditsResponseBody200Data :: [Treasury'receivedCredit]
  data: Details about each object.
- getTreasuryReceivedCreditsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryReceivedCreditsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryReceivedCreditsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
Show GetTreasuryReceivedCreditsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
FromJSON GetTreasuryReceivedCreditsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits
ToJSON GetTreasuryReceivedCreditsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryReceivedCredits

valuemkGetTreasuryReceivedCreditsResponseBody200

:: [Treasury'receivedCredit]
getTreasuryReceivedCreditsResponseBody200Data
-> Bool
getTreasuryReceivedCreditsResponseBody200HasMore
-> Text
getTreasuryReceivedCreditsResponseBody200Url
-> GetTreasuryReceivedCreditsResponseBody200

Create a new GetTreasuryReceivedCreditsResponseBody200 with all required fields.