Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPayouts

Contains the different functions to run the operation getPayouts

7 types
5 values

Packagestripeapi-3.0.0.0
Exports12
LanguageHaskell2010
LicenceMIT
SourceGetPayouts.hs

valuegetPayouts

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

datadata GetPayoutsParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

valuemkGetPayoutsParameters :: GetPayoutsParameters

Create a new GetPayoutsParameters with all required fields.

datadata GetPayoutsParametersQueryArrivalDate'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsParametersQueryArrivalDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsParametersQueryArrivalDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsParametersQueryArrivalDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsParametersQueryArrivalDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

valuemkGetPayoutsParametersQueryArrivalDate'OneOf1 :: GetPayoutsParametersQueryArrivalDate'OneOf1

Create a new GetPayoutsParametersQueryArrivalDate'OneOf1 with all required fields.

datadata GetPayoutsParametersQueryArrivalDate'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsParametersQueryArrivalDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsParametersQueryArrivalDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsParametersQueryArrivalDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsParametersQueryArrivalDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

datadata GetPayoutsParametersQueryCreated'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

valuemkGetPayoutsParametersQueryCreated'OneOf1 :: GetPayoutsParametersQueryCreated'OneOf1

Create a new GetPayoutsParametersQueryCreated'OneOf1 with all required fields.

datadata GetPayoutsParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

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

Instances2Eq, Show

Eq GetPayoutsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

datadata GetPayoutsResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPayoutsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
Show GetPayoutsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
FromJSON GetPayoutsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts
ToJSON GetPayoutsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPayouts

valuemkGetPayoutsResponseBody200

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

Create a new GetPayoutsResponseBody200 with all required fields.