Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryCreditReversals

Contains the different functions to run the operation getTreasuryCreditReversals

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryCreditReversals.hs

valuegetTreasuryCreditReversals

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

GET /v1/treasury/credit_reversals

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

datadata GetTreasuryCreditReversalsParameters

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

Constructors

GetTreasuryCreditReversalsParameters
- getTreasuryCreditReversalsParametersQueryEndingBefore :: 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
- getTreasuryCreditReversalsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryCreditReversalsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryCreditReversalsParametersQueryLimit :: 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.
- getTreasuryCreditReversalsParametersQueryReceivedCredit :: Maybe Text
  queryReceived_credit: Represents the parameter named 'received_credit'
  Only return CreditReversals for the ReceivedCredit ID.
  Constraints:
  - Maximum length of 5000
- getTreasuryCreditReversalsParametersQueryStartingAfter :: 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
- getTreasuryCreditReversalsParametersQueryStatus :: Maybe GetTreasuryCreditReversalsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return CreditReversals for a given status.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryCreditReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
Show GetTreasuryCreditReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
FromJSON GetTreasuryCreditReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
ToJSON GetTreasuryCreditReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals

valuemkGetTreasuryCreditReversalsParameters

:: Text
getTreasuryCreditReversalsParametersQueryFinancialAccount
-> GetTreasuryCreditReversalsParameters

Create a new GetTreasuryCreditReversalsParameters with all required fields.

datadata GetTreasuryCreditReversalsParametersQueryStatus'

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

Represents the parameter named 'status'

Only return CreditReversals for a given status.

Constructors

GetTreasuryCreditReversalsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryCreditReversalsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryCreditReversalsParametersQueryStatus'EnumCanceled
Represents the JSON value "canceled"
GetTreasuryCreditReversalsParametersQueryStatus'EnumPosted
Represents the JSON value "posted"
GetTreasuryCreditReversalsParametersQueryStatus'EnumProcessing
Represents the JSON value "processing"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryCreditReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
Show GetTreasuryCreditReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
FromJSON GetTreasuryCreditReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
ToJSON GetTreasuryCreditReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals

datadata GetTreasuryCreditReversalsResponse

Represents a response of the operation getTreasuryCreditReversals.

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

Constructors

GetTreasuryCreditReversalsResponseError String
Means either no matching case available or a parse error
GetTreasuryCreditReversalsResponse200 GetTreasuryCreditReversalsResponseBody200
Successful response.
GetTreasuryCreditReversalsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryCreditReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
Show GetTreasuryCreditReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals

datadata GetTreasuryCreditReversalsResponseBody200

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

Constructors

GetTreasuryCreditReversalsResponseBody200
- getTreasuryCreditReversalsResponseBody200Data :: [Treasury'creditReversal]
  data: Details about each object.
- getTreasuryCreditReversalsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryCreditReversalsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryCreditReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
Show GetTreasuryCreditReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
FromJSON GetTreasuryCreditReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals
ToJSON GetTreasuryCreditReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryCreditReversals

valuemkGetTreasuryCreditReversalsResponseBody200

:: [Treasury'creditReversal]
getTreasuryCreditReversalsResponseBody200Data
-> Bool
getTreasuryCreditReversalsResponseBody200HasMore
-> Text
getTreasuryCreditReversalsResponseBody200Url
-> GetTreasuryCreditReversalsResponseBody200

Create a new GetTreasuryCreditReversalsResponseBody200 with all required fields.