Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPaymentIntentsSearch

Contains the different functions to run the operation getPaymentIntentsSearch

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetPaymentIntentsSearch.hs

valuegetPaymentIntentsSearch

:: MonadHTTP m
=> GetPaymentIntentsSearchParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetPaymentIntentsSearchResponse)
Monadic computation which returns the result of the operation

GET /v1/payment_intents/search

<p>Search for PaymentIntents you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

datadata GetPaymentIntentsSearchParameters

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

Constructors

GetPaymentIntentsSearchParameters
- getPaymentIntentsSearchParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getPaymentIntentsSearchParametersQueryLimit :: 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.
- getPaymentIntentsSearchParametersQueryPage :: Maybe Text
  queryPage: Represents the parameter named 'page'
  A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
  Constraints:
  - Maximum length of 5000
- getPaymentIntentsSearchParametersQueryQuery :: Text
  queryQuery: Represents the parameter named 'query'
  The search query string. See search query language and the list of supported query fields for payment intents.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPaymentIntentsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
Show GetPaymentIntentsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
FromJSON GetPaymentIntentsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
ToJSON GetPaymentIntentsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch

valuemkGetPaymentIntentsSearchParameters

:: Text
getPaymentIntentsSearchParametersQueryQuery
-> GetPaymentIntentsSearchParameters

Create a new GetPaymentIntentsSearchParameters with all required fields.

datadata GetPaymentIntentsSearchResponse

Represents a response of the operation getPaymentIntentsSearch.

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

Constructors

GetPaymentIntentsSearchResponseError String
Means either no matching case available or a parse error
GetPaymentIntentsSearchResponse200 GetPaymentIntentsSearchResponseBody200
Successful response.
GetPaymentIntentsSearchResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetPaymentIntentsSearchResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
Show GetPaymentIntentsSearchResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch

datadata GetPaymentIntentsSearchResponseBody200

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

Constructors

GetPaymentIntentsSearchResponseBody200
- getPaymentIntentsSearchResponseBody200Data :: [PaymentIntent]
  data
- getPaymentIntentsSearchResponseBody200HasMore :: Bool
  has_more
- getPaymentIntentsSearchResponseBody200NextPage :: Maybe (Nullable Text)
  next_page
  Constraints:
  - Maximum length of 5000
- getPaymentIntentsSearchResponseBody200TotalCount :: Maybe Int
  total_count: The total number of objects that match the query, only accurate up to 10,000.
- getPaymentIntentsSearchResponseBody200Url :: Text
  url
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPaymentIntentsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
Show GetPaymentIntentsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
FromJSON GetPaymentIntentsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch
ToJSON GetPaymentIntentsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentIntentsSearch

valuemkGetPaymentIntentsSearchResponseBody200

:: [PaymentIntent]
getPaymentIntentsSearchResponseBody200Data
-> Bool
getPaymentIntentsSearchResponseBody200HasMore
-> Text
getPaymentIntentsSearchResponseBody200Url
-> GetPaymentIntentsSearchResponseBody200

Create a new GetPaymentIntentsSearchResponseBody200 with all required fields.