Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryDebitReversals

Contains the different functions to run the operation getTreasuryDebitReversals

5 types
3 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryDebitReversals.hs

valuegetTreasuryDebitReversals

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

GET /v1/treasury/debit_reversals

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

datadata GetTreasuryDebitReversalsParameters

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

Constructors

GetTreasuryDebitReversalsParameters
- getTreasuryDebitReversalsParametersQueryEndingBefore :: 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
- getTreasuryDebitReversalsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryDebitReversalsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryDebitReversalsParametersQueryLimit :: 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.
- getTreasuryDebitReversalsParametersQueryReceivedDebit :: Maybe Text
  queryReceived_debit: Represents the parameter named 'received_debit'
  Only return DebitReversals for the ReceivedDebit ID.
  Constraints:
  - Maximum length of 5000
- getTreasuryDebitReversalsParametersQueryResolution :: Maybe GetTreasuryDebitReversalsParametersQueryResolution'
  queryResolution: Represents the parameter named 'resolution'
  Only return DebitReversals for a given resolution.
- getTreasuryDebitReversalsParametersQueryStartingAfter :: 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
- getTreasuryDebitReversalsParametersQueryStatus :: Maybe GetTreasuryDebitReversalsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return DebitReversals for a given status.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryDebitReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
Show GetTreasuryDebitReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
FromJSON GetTreasuryDebitReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
ToJSON GetTreasuryDebitReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals

valuemkGetTreasuryDebitReversalsParameters

:: Text
getTreasuryDebitReversalsParametersQueryFinancialAccount
-> GetTreasuryDebitReversalsParameters

Create a new GetTreasuryDebitReversalsParameters with all required fields.

datadata GetTreasuryDebitReversalsParametersQueryResolution'

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

Represents the parameter named 'resolution'

Only return DebitReversals for a given resolution.

Constructors

GetTreasuryDebitReversalsParametersQueryResolution'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryDebitReversalsParametersQueryResolution'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryDebitReversalsParametersQueryResolution'EnumLost
Represents the JSON value "lost"
GetTreasuryDebitReversalsParametersQueryResolution'EnumWon
Represents the JSON value "won"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryDebitReversalsParametersQueryResolution'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
Show GetTreasuryDebitReversalsParametersQueryResolution'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
FromJSON GetTreasuryDebitReversalsParametersQueryResolution'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
ToJSON GetTreasuryDebitReversalsParametersQueryResolution'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals

datadata GetTreasuryDebitReversalsParametersQueryStatus'

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

Represents the parameter named 'status'

Only return DebitReversals for a given status.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryDebitReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
Show GetTreasuryDebitReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
FromJSON GetTreasuryDebitReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
ToJSON GetTreasuryDebitReversalsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals

datadata GetTreasuryDebitReversalsResponse

Represents a response of the operation getTreasuryDebitReversals.

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

Constructors

GetTreasuryDebitReversalsResponseError String
Means either no matching case available or a parse error
GetTreasuryDebitReversalsResponse200 GetTreasuryDebitReversalsResponseBody200
Successful response.
GetTreasuryDebitReversalsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryDebitReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
Show GetTreasuryDebitReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals

datadata GetTreasuryDebitReversalsResponseBody200

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

Constructors

GetTreasuryDebitReversalsResponseBody200
- getTreasuryDebitReversalsResponseBody200Data :: [Treasury'debitReversal]
  data: Details about each object.
- getTreasuryDebitReversalsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryDebitReversalsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryDebitReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
Show GetTreasuryDebitReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
FromJSON GetTreasuryDebitReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals
ToJSON GetTreasuryDebitReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryDebitReversals

valuemkGetTreasuryDebitReversalsResponseBody200

:: [Treasury'debitReversal]
getTreasuryDebitReversalsResponseBody200Data
-> Bool
getTreasuryDebitReversalsResponseBody200HasMore
-> Text
getTreasuryDebitReversalsResponseBody200Url
-> GetTreasuryDebitReversalsResponseBody200

Create a new GetTreasuryDebitReversalsResponseBody200 with all required fields.