stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetRefunds

Description

Contains the different functions to run the operation getRefunds

Synopsis

Documentation

getRefunds Source #

Arguments

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

The configuration to use in the request

-> Maybe String

charge: Only return refunds for the charge specified by this charge ID.

-> Maybe String

created

-> 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.

-> Maybe String

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

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

payment_intent: Only return refunds for the PaymentIntent specified by this ID. | Constraints: Maximum length of 5000

-> 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.

-> GetRefundsRequestBody

The request body to send

-> m (Either HttpException (Response GetRefundsResponse))

Monad containing the result of the operation

GET /v1/refunds

<p>Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.</p>

data GetRefundsResponse Source #

Represents a response of the operation getRefunds.

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

Constructors

GetRefundsResponseError String

Means either no matching case available or a parse error

GetRefundsResponse200 GetRefundsResponseBody200

Successful response.

GetRefundsResponseDefault Error

Error response.

data GetRefundsResponseBody200 Source #

Defines the data type for the schema GetRefundsResponseBody200

Constructors

GetRefundsResponseBody200 

Fields

data GetRefundsResponseBody200Object' Source #

Defines the enum schema GetRefundsResponseBody200Object'

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