Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetIssuingSettlements

Description

Contains the different functions to run the operation getIssuingSettlements

Synopsis

getIssuingSettlements :: forall m. MonadHTTP m => GetIssuingSettlementsParameters -> StripeT m (Response GetIssuingSettlementsResponse)
data GetIssuingSettlementsParameters = GetIssuingSettlementsParameters {
}
mkGetIssuingSettlementsParameters :: GetIssuingSettlementsParameters
data GetIssuingSettlementsParametersQueryCreated'OneOf1 = GetIssuingSettlementsParametersQueryCreated'OneOf1 {
}
mkGetIssuingSettlementsParametersQueryCreated'OneOf1 :: GetIssuingSettlementsParametersQueryCreated'OneOf1
data GetIssuingSettlementsParametersQueryCreated'Variants
- = GetIssuingSettlementsParametersQueryCreated'GetIssuingSettlementsParametersQueryCreated'OneOf1 GetIssuingSettlementsParametersQueryCreated'OneOf1
- | GetIssuingSettlementsParametersQueryCreated'Int Int
data GetIssuingSettlementsResponse
data GetIssuingSettlementsResponseBody200 = GetIssuingSettlementsResponseBody200 {
}
mkGetIssuingSettlementsResponseBody200 :: [Issuing'settlement] -> Bool -> Text -> GetIssuingSettlementsResponseBody200

Documentation

getIssuingSettlements Source #

Arguments

:: forall m. MonadHTTP m
=> GetIssuingSettlementsParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetIssuingSettlementsResponse)	Monadic computation which returns the result of the operation

GET /v1/issuing/settlements

<p>Returns a list of Issuing <code>Settlement</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

data GetIssuingSettlementsParameters Source #

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

Constructors

GetIssuingSettlementsParameters

Fields

getIssuingSettlementsParametersQueryCreated :: Maybe GetIssuingSettlementsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
Only return issuing settlements that were created during the given date interval.
getIssuingSettlementsParametersQueryEndingBefore :: 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
getIssuingSettlementsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getIssuingSettlementsParametersQueryLimit :: 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.
getIssuingSettlementsParametersQueryStartingAfter :: 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

Instances

Instances details

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

mkGetIssuingSettlementsParameters :: GetIssuingSettlementsParameters Source #

Create a new GetIssuingSettlementsParameters with all required fields.

data GetIssuingSettlementsParametersQueryCreated'OneOf1 Source #

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

Constructors

GetIssuingSettlementsParametersQueryCreated'OneOf1
Fields getIssuingSettlementsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getIssuingSettlementsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getIssuingSettlementsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getIssuingSettlementsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetIssuingSettlementsParametersQueryCreated'OneOf1 :: GetIssuingSettlementsParametersQueryCreated'OneOf1 Source #

Create a new GetIssuingSettlementsParametersQueryCreated'OneOf1 with all required fields.

data GetIssuingSettlementsParametersQueryCreated'Variants Source #

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

Represents the parameter named 'created'

Only return issuing settlements that were created during the given date interval.

Constructors

GetIssuingSettlementsParametersQueryCreated'GetIssuingSettlementsParametersQueryCreated'OneOf1 GetIssuingSettlementsParametersQueryCreated'OneOf1
GetIssuingSettlementsParametersQueryCreated'Int Int

Instances

Instances details

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

data GetIssuingSettlementsResponse Source #

Represents a response of the operation getIssuingSettlements.

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

Constructors

GetIssuingSettlementsResponseError String	Means either no matching case available or a parse error
GetIssuingSettlementsResponse200 GetIssuingSettlementsResponseBody200	Successful response.
GetIssuingSettlementsResponseDefault Error	Error response.

Instances

Instances details

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

data GetIssuingSettlementsResponseBody200 Source #

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

Constructors

GetIssuingSettlementsResponseBody200
Fields getIssuingSettlementsResponseBody200Data :: [Issuing'settlement] data getIssuingSettlementsResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getIssuingSettlementsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/issuing/settlements'

Instances

Instances details

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

mkGetIssuingSettlementsResponseBody200 Source #

Arguments

:: [Issuing'settlement]	`getIssuingSettlementsResponseBody200Data`
-> Bool	`getIssuingSettlementsResponseBody200HasMore`
-> Text	`getIssuingSettlementsResponseBody200Url`
-> GetIssuingSettlementsResponseBody200

Create a new GetIssuingSettlementsResponseBody200 with all required fields.