StripeAPI.Operations.GetPayouts

Contains the different functions to run the operation getPayouts

Documentation

getPayouts

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>

getPayoutsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetPayoutsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/payouts

The same as getPayouts but returns the raw ByteString

getPayoutsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetPayoutsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPayoutsResponse))

GET /v1/payouts

Monadic version of getPayouts (use with runWithConfiguration)

getPayoutsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetPayoutsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/payouts

Monadic version of getPayoutsRaw (use with runWithConfiguration)

data GetPayoutsRequestBody

Defines the data type for the schema getPayoutsRequestBody

Constructors

GetPayoutsRequestBody

Instances

Eq GetPayoutsRequestBody

Defined in StripeAPI.Operations.GetPayouts

Methods

(==) :: GetPayoutsRequestBody -> GetPayoutsRequestBody -> Bool

(/=) :: GetPayoutsRequestBody -> GetPayoutsRequestBody -> Bool

Show GetPayoutsRequestBody

Defined in StripeAPI.Operations.GetPayouts

Methods

showsPrec :: Int -> GetPayoutsRequestBody -> ShowS

show :: GetPayoutsRequestBody -> String

showList :: [GetPayoutsRequestBody] -> ShowS

ToJSON GetPayoutsRequestBody

Defined in StripeAPI.Operations.GetPayouts

Methods

toJSON :: GetPayoutsRequestBody -> Value

toEncoding :: GetPayoutsRequestBody -> Encoding

toJSONList :: [GetPayoutsRequestBody] -> Value

toEncodingList :: [GetPayoutsRequestBody] -> Encoding

FromJSON GetPayoutsRequestBody

Defined in StripeAPI.Operations.GetPayouts

Methods

parseJSON :: Value -> Parser GetPayoutsRequestBody

parseJSONList :: Value -> Parser [GetPayoutsRequestBody]

data GetPayoutsResponse

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.

Instances

Eq GetPayoutsResponse

Defined in StripeAPI.Operations.GetPayouts

Methods

(==) :: GetPayoutsResponse -> GetPayoutsResponse -> Bool

(/=) :: GetPayoutsResponse -> GetPayoutsResponse -> Bool

Show GetPayoutsResponse

Defined in StripeAPI.Operations.GetPayouts

Methods

showsPrec :: Int -> GetPayoutsResponse -> ShowS

show :: GetPayoutsResponse -> String

showList :: [GetPayoutsResponse] -> ShowS

data GetPayoutsResponseBody200

Defines the data type for the schema GetPayoutsResponseBody200

Constructors

GetPayoutsResponseBody200

Fields

• getPayoutsResponseBody200Data :: [] Payout

  data

• getPayoutsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getPayoutsResponseBody200Object :: GetPayoutsResponseBody200Object'

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

• getPayoutsResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/payouts'

Instances

Eq GetPayoutsResponseBody200

Defined in StripeAPI.Operations.GetPayouts

Methods

(==) :: GetPayoutsResponseBody200 -> GetPayoutsResponseBody200 -> Bool

(/=) :: GetPayoutsResponseBody200 -> GetPayoutsResponseBody200 -> Bool

Show GetPayoutsResponseBody200

Defined in StripeAPI.Operations.GetPayouts

Methods

showsPrec :: Int -> GetPayoutsResponseBody200 -> ShowS

show :: GetPayoutsResponseBody200 -> String

showList :: [GetPayoutsResponseBody200] -> ShowS

ToJSON GetPayoutsResponseBody200

Defined in StripeAPI.Operations.GetPayouts

Methods

toJSON :: GetPayoutsResponseBody200 -> Value

toEncoding :: GetPayoutsResponseBody200 -> Encoding

toJSONList :: [GetPayoutsResponseBody200] -> Value

toEncodingList :: [GetPayoutsResponseBody200] -> Encoding

FromJSON GetPayoutsResponseBody200

Defined in StripeAPI.Operations.GetPayouts

Methods

parseJSON :: Value -> Parser GetPayoutsResponseBody200

parseJSONList :: Value -> Parser [GetPayoutsResponseBody200]

data GetPayoutsResponseBody200Object'

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

Constructors

GetPayoutsResponseBody200Object'EnumOther Value

GetPayoutsResponseBody200Object'EnumTyped String

GetPayoutsResponseBody200Object'EnumStringList

Instances

Eq GetPayoutsResponseBody200Object'

Defined in StripeAPI.Operations.GetPayouts

Methods

(==) :: GetPayoutsResponseBody200Object' -> GetPayoutsResponseBody200Object' -> Bool

(/=) :: GetPayoutsResponseBody200Object' -> GetPayoutsResponseBody200Object' -> Bool

Show GetPayoutsResponseBody200Object'

Defined in StripeAPI.Operations.GetPayouts

Methods

showsPrec :: Int -> GetPayoutsResponseBody200Object' -> ShowS

show :: GetPayoutsResponseBody200Object' -> String

showList :: [GetPayoutsResponseBody200Object'] -> ShowS

ToJSON GetPayoutsResponseBody200Object'

Defined in StripeAPI.Operations.GetPayouts

Methods

toJSON :: GetPayoutsResponseBody200Object' -> Value

toEncoding :: GetPayoutsResponseBody200Object' -> Encoding

toJSONList :: [GetPayoutsResponseBody200Object'] -> Value

toEncodingList :: [GetPayoutsResponseBody200Object'] -> Encoding

FromJSON GetPayoutsResponseBody200Object'

Defined in StripeAPI.Operations.GetPayouts

Methods

parseJSON :: Value -> Parser GetPayoutsResponseBody200Object'

parseJSONList :: Value -> Parser [GetPayoutsResponseBody200Object']