stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetTransfersIdReversals

Description

Contains the different functions to run the operation getTransfersIdReversals

Synopsis

Documentation

getTransfersIdReversals Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

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

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> String

id | Constraints: Maximum length of 5000

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

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

-> GetTransfersIdReversalsRequestBody

The request body to send

-> m (Either HttpException (Response GetTransfersIdReversalsResponse))

Monad containing 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>

data GetTransfersIdReversalsResponse Source #

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.

data GetTransfersIdReversalsResponseBody200 Source #

Defines the data type for the schema GetTransfersIdReversalsResponseBody200

Constructors

GetTransfersIdReversalsResponseBody200 

Fields

data GetTransfersIdReversalsResponseBody200Object' Source #

Defines the enum schema GetTransfersIdReversalsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.