stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetPayouts

Description

Contains the different functions to run the operation getPayouts

Synopsis

Documentation

getPayouts Source #

Arguments

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

The configuration to use in the request

-> Maybe String

arrival_date

-> Maybe String

created

-> Maybe String

destination: The ID of an external account - only return payouts sent to this external account.

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

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

-> Maybe String

status: Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. | Constraints: Maximum length of 5000

-> GetPayoutsRequestBody

The request body to send

-> m (Either HttpException (Response GetPayoutsResponse))

Monad containing the result of the operation

GET /v1/payouts

<p>Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.</p>

data GetPayoutsResponse Source #

Represents a response of the operation getPayouts.

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

Constructors

GetPayoutsResponseError String

Means either no matching case available or a parse error

GetPayoutsResponse200 GetPayoutsResponseBody200

Successful response.

GetPayoutsResponseDefault Error

Error response.

data GetPayoutsResponseBody200 Source #

Defines the data type for the schema GetPayoutsResponseBody200

Constructors

GetPayoutsResponseBody200 

Fields

data GetPayoutsResponseBody200Object' Source #

Defines the enum schema GetPayoutsResponseBody200Object'

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