Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTransfersIdReversals

Contains the different functions to run the operation getTransfersIdReversals

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetTransfersIdReversals.hs

valuegetTransfersIdReversals

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

GET /v1/transfers/{id}/reversals

<p>You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p>

datadata GetTransfersIdReversalsParameters

Defines the object schema located at paths./v1/transfers/{id}/reversals.GET.parameters in the specification.

Constructors

GetTransfersIdReversalsParameters
- getTransfersIdReversalsParametersPathId :: Text
  pathId: Represents the parameter named 'id'
  Constraints:
  - Maximum length of 5000
- getTransfersIdReversalsParametersQueryEndingBefore :: 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
- getTransfersIdReversalsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTransfersIdReversalsParametersQueryLimit :: 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.
- getTransfersIdReversalsParametersQueryStartingAfter :: 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersIdReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
Show GetTransfersIdReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
FromJSON GetTransfersIdReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
ToJSON GetTransfersIdReversalsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals

valuemkGetTransfersIdReversalsParameters

:: Text
getTransfersIdReversalsParametersPathId
-> GetTransfersIdReversalsParameters

Create a new GetTransfersIdReversalsParameters with all required fields.

datadata GetTransfersIdReversalsResponse

Represents a response of the operation getTransfersIdReversals.

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

Constructors

GetTransfersIdReversalsResponseError String
Means either no matching case available or a parse error
GetTransfersIdReversalsResponse200 GetTransfersIdReversalsResponseBody200
Successful response.
GetTransfersIdReversalsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTransfersIdReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
Show GetTransfersIdReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals

datadata GetTransfersIdReversalsResponseBody200

Defines the object schema located at paths./v1/transfers/{id}/reversals.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetTransfersIdReversalsResponseBody200
- getTransfersIdReversalsResponseBody200Data :: [TransferReversal]
  data: Details about each object.
- getTransfersIdReversalsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTransfersIdReversalsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersIdReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
Show GetTransfersIdReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
FromJSON GetTransfersIdReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals
ToJSON GetTransfersIdReversalsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfersIdReversals

valuemkGetTransfersIdReversalsResponseBody200

:: [TransferReversal]
getTransfersIdReversalsResponseBody200Data
-> Bool
getTransfersIdReversalsResponseBody200HasMore
-> Text
getTransfersIdReversalsResponseBody200Url
-> GetTransfersIdReversalsResponseBody200

Create a new GetTransfersIdReversalsResponseBody200 with all required fields.