Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetPayouts

Description

Contains the different functions to run the operation getPayouts

Synopsis

getPayouts :: forall m. MonadHTTP m => GetPayoutsParameters -> ClientT m (Response GetPayoutsResponse)
data GetPayoutsParameters = GetPayoutsParameters {
}
mkGetPayoutsParameters :: GetPayoutsParameters
data GetPayoutsParametersQueryArrivalDate'OneOf1 = GetPayoutsParametersQueryArrivalDate'OneOf1 {
}
mkGetPayoutsParametersQueryArrivalDate'OneOf1 :: GetPayoutsParametersQueryArrivalDate'OneOf1
data GetPayoutsParametersQueryArrivalDate'Variants
- = GetPayoutsParametersQueryArrivalDate'GetPayoutsParametersQueryArrivalDate'OneOf1 GetPayoutsParametersQueryArrivalDate'OneOf1
- | GetPayoutsParametersQueryArrivalDate'Int Int
data GetPayoutsParametersQueryCreated'OneOf1 = GetPayoutsParametersQueryCreated'OneOf1 {
}
mkGetPayoutsParametersQueryCreated'OneOf1 :: GetPayoutsParametersQueryCreated'OneOf1
data GetPayoutsParametersQueryCreated'Variants
- = GetPayoutsParametersQueryCreated'GetPayoutsParametersQueryCreated'OneOf1 GetPayoutsParametersQueryCreated'OneOf1
- | GetPayoutsParametersQueryCreated'Int Int
data GetPayoutsResponse
data GetPayoutsResponseBody200 = GetPayoutsResponseBody200 {
}
mkGetPayoutsResponseBody200 :: [Payout] -> Bool -> Text -> GetPayoutsResponseBody200

Documentation

getPayouts Source #

Arguments

:: forall m. MonadHTTP m
=> GetPayoutsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetPayoutsResponse)	Monadic computation which returns 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 GetPayoutsParameters Source #

Defines the object schema located at paths./v1/payouts.GET.parameters in the specification.

Constructors

GetPayoutsParameters

Fields

getPayoutsParametersQueryArrivalDate :: Maybe GetPayoutsParametersQueryArrivalDate'Variants
queryArrival_date: Represents the parameter named 'arrival_date'
getPayoutsParametersQueryCreated :: Maybe GetPayoutsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getPayoutsParametersQueryDestination :: Maybe Text
queryDestination: Represents the parameter named 'destination'
The ID of an external account - only return payouts sent to this external account.
getPayoutsParametersQueryEndingBefore :: 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
getPayoutsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getPayoutsParametersQueryLimit :: 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.
getPayoutsParametersQueryStartingAfter :: 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
getPayoutsParametersQueryStatus :: Maybe Text
queryStatus: Represents the parameter named 'status'
Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq GetPayoutsParameters Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsParameters -> GetPayoutsParameters -> Bool # (/=) :: GetPayoutsParameters -> GetPayoutsParameters -> Bool #
Show GetPayoutsParameters Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsParameters -> ShowS # show :: GetPayoutsParameters -> String # showList :: [GetPayoutsParameters] -> ShowS #
ToJSON GetPayoutsParameters Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsParameters -> Value # toEncoding :: GetPayoutsParameters -> Encoding # toJSONList :: [GetPayoutsParameters] -> Value # toEncodingList :: [GetPayoutsParameters] -> Encoding #
FromJSON GetPayoutsParameters Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsParameters # parseJSONList :: Value -> Parser [GetPayoutsParameters] #

mkGetPayoutsParameters :: GetPayoutsParameters Source #

Create a new GetPayoutsParameters with all required fields.

data GetPayoutsParametersQueryArrivalDate'OneOf1 Source #

Defines the object schema located at paths./v1/payouts.GET.parameters.properties.queryArrival_date.anyOf in the specification.

Constructors

GetPayoutsParametersQueryArrivalDate'OneOf1
Fields getPayoutsParametersQueryArrivalDate'OneOf1Gt :: Maybe Int gt getPayoutsParametersQueryArrivalDate'OneOf1Gte :: Maybe Int gte getPayoutsParametersQueryArrivalDate'OneOf1Lt :: Maybe Int lt getPayoutsParametersQueryArrivalDate'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetPayoutsParametersQueryArrivalDate'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsParametersQueryArrivalDate'OneOf1 -> GetPayoutsParametersQueryArrivalDate'OneOf1 -> Bool # (/=) :: GetPayoutsParametersQueryArrivalDate'OneOf1 -> GetPayoutsParametersQueryArrivalDate'OneOf1 -> Bool #
Show GetPayoutsParametersQueryArrivalDate'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsParametersQueryArrivalDate'OneOf1 -> ShowS # show :: GetPayoutsParametersQueryArrivalDate'OneOf1 -> String # showList :: [GetPayoutsParametersQueryArrivalDate'OneOf1] -> ShowS #
ToJSON GetPayoutsParametersQueryArrivalDate'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsParametersQueryArrivalDate'OneOf1 -> Value # toEncoding :: GetPayoutsParametersQueryArrivalDate'OneOf1 -> Encoding # toJSONList :: [GetPayoutsParametersQueryArrivalDate'OneOf1] -> Value # toEncodingList :: [GetPayoutsParametersQueryArrivalDate'OneOf1] -> Encoding #
FromJSON GetPayoutsParametersQueryArrivalDate'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsParametersQueryArrivalDate'OneOf1 # parseJSONList :: Value -> Parser [GetPayoutsParametersQueryArrivalDate'OneOf1] #

mkGetPayoutsParametersQueryArrivalDate'OneOf1 :: GetPayoutsParametersQueryArrivalDate'OneOf1 Source #

Create a new GetPayoutsParametersQueryArrivalDate'OneOf1 with all required fields.

data GetPayoutsParametersQueryArrivalDate'Variants Source #

Defines the oneOf schema located at paths./v1/payouts.GET.parameters.properties.queryArrival_date.anyOf in the specification.

Represents the parameter named 'arrival_date'

Constructors

GetPayoutsParametersQueryArrivalDate'GetPayoutsParametersQueryArrivalDate'OneOf1 GetPayoutsParametersQueryArrivalDate'OneOf1
GetPayoutsParametersQueryArrivalDate'Int Int

Instances

Instances details

Eq GetPayoutsParametersQueryArrivalDate'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsParametersQueryArrivalDate'Variants -> GetPayoutsParametersQueryArrivalDate'Variants -> Bool # (/=) :: GetPayoutsParametersQueryArrivalDate'Variants -> GetPayoutsParametersQueryArrivalDate'Variants -> Bool #
Show GetPayoutsParametersQueryArrivalDate'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsParametersQueryArrivalDate'Variants -> ShowS # show :: GetPayoutsParametersQueryArrivalDate'Variants -> String # showList :: [GetPayoutsParametersQueryArrivalDate'Variants] -> ShowS #
ToJSON GetPayoutsParametersQueryArrivalDate'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsParametersQueryArrivalDate'Variants -> Value # toEncoding :: GetPayoutsParametersQueryArrivalDate'Variants -> Encoding # toJSONList :: [GetPayoutsParametersQueryArrivalDate'Variants] -> Value # toEncodingList :: [GetPayoutsParametersQueryArrivalDate'Variants] -> Encoding #
FromJSON GetPayoutsParametersQueryArrivalDate'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsParametersQueryArrivalDate'Variants # parseJSONList :: Value -> Parser [GetPayoutsParametersQueryArrivalDate'Variants] #

data GetPayoutsParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/payouts.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetPayoutsParametersQueryCreated'OneOf1
Fields getPayoutsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getPayoutsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getPayoutsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getPayoutsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetPayoutsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsParametersQueryCreated'OneOf1 -> GetPayoutsParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetPayoutsParametersQueryCreated'OneOf1 -> GetPayoutsParametersQueryCreated'OneOf1 -> Bool #
Show GetPayoutsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsParametersQueryCreated'OneOf1 -> ShowS # show :: GetPayoutsParametersQueryCreated'OneOf1 -> String # showList :: [GetPayoutsParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetPayoutsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetPayoutsParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetPayoutsParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetPayoutsParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetPayoutsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetPayoutsParametersQueryCreated'OneOf1] #

mkGetPayoutsParametersQueryCreated'OneOf1 :: GetPayoutsParametersQueryCreated'OneOf1 Source #

Create a new GetPayoutsParametersQueryCreated'OneOf1 with all required fields.

data GetPayoutsParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/payouts.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetPayoutsParametersQueryCreated'GetPayoutsParametersQueryCreated'OneOf1 GetPayoutsParametersQueryCreated'OneOf1
GetPayoutsParametersQueryCreated'Int Int

Instances

Instances details

Eq GetPayoutsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsParametersQueryCreated'Variants -> GetPayoutsParametersQueryCreated'Variants -> Bool # (/=) :: GetPayoutsParametersQueryCreated'Variants -> GetPayoutsParametersQueryCreated'Variants -> Bool #
Show GetPayoutsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsParametersQueryCreated'Variants -> ShowS # show :: GetPayoutsParametersQueryCreated'Variants -> String # showList :: [GetPayoutsParametersQueryCreated'Variants] -> ShowS #
ToJSON GetPayoutsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsParametersQueryCreated'Variants -> Value # toEncoding :: GetPayoutsParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetPayoutsParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetPayoutsParametersQueryCreated'Variants] -> Encoding #
FromJSON GetPayoutsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetPayoutsParametersQueryCreated'Variants] #

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.

Instances

Instances details

Eq GetPayoutsResponse Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsResponse -> GetPayoutsResponse -> Bool # (/=) :: GetPayoutsResponse -> GetPayoutsResponse -> Bool #
Show GetPayoutsResponse Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsResponse -> ShowS # show :: GetPayoutsResponse -> String # showList :: [GetPayoutsResponse] -> ShowS #

data GetPayoutsResponseBody200 Source #

Defines the object schema located at paths./v1/payouts.GET.responses.200.content.application/json.schema in the specification.

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. getPayoutsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/payouts'

Instances

Instances details

Eq GetPayoutsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods (==) :: GetPayoutsResponseBody200 -> GetPayoutsResponseBody200 -> Bool # (/=) :: GetPayoutsResponseBody200 -> GetPayoutsResponseBody200 -> Bool #
Show GetPayoutsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods showsPrec :: Int -> GetPayoutsResponseBody200 -> ShowS # show :: GetPayoutsResponseBody200 -> String # showList :: [GetPayoutsResponseBody200] -> ShowS #
ToJSON GetPayoutsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods toJSON :: GetPayoutsResponseBody200 -> Value # toEncoding :: GetPayoutsResponseBody200 -> Encoding # toJSONList :: [GetPayoutsResponseBody200] -> Value # toEncodingList :: [GetPayoutsResponseBody200] -> Encoding #
FromJSON GetPayoutsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPayouts Methods parseJSON :: Value -> Parser GetPayoutsResponseBody200 # parseJSONList :: Value -> Parser [GetPayoutsResponseBody200] #

mkGetPayoutsResponseBody200 Source #

Arguments

:: [Payout]	`getPayoutsResponseBody200Data`
-> Bool	`getPayoutsResponseBody200HasMore`
-> Text	`getPayoutsResponseBody200Url`
-> GetPayoutsResponseBody200

Create a new GetPayoutsResponseBody200 with all required fields.