StripeAPI.Operations.GetPaymentIntents

Contains the different functions to run the operation getPaymentIntents

Documentation

getPaymentIntents

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created: A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

-> Maybe Text

customer: Only return PaymentIntents for the customer specified by this customer ID. | Constraints: Maximum length of 5000

-> Maybe Text

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 Text

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 Text

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 GetPaymentIntentsRequestBody

The request body to send

-> m (Either HttpException (Response GetPaymentIntentsResponse))

Monad containing the result of the operation

GET /v1/payment_intents

<p>Returns a list of PaymentIntents.</p>

getPaymentIntentsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetPaymentIntentsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/payment_intents

The same as getPaymentIntents but returns the raw ByteString

getPaymentIntentsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPaymentIntentsResponse))

GET /v1/payment_intents

Monadic version of getPaymentIntents (use with runWithConfiguration)

getPaymentIntentsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/payment_intents

Monadic version of getPaymentIntentsRaw (use with runWithConfiguration)

data GetPaymentIntentsRequestBody

Defines the data type for the schema getPaymentIntentsRequestBody

Constructors

GetPaymentIntentsRequestBody

Instances

Eq GetPaymentIntentsRequestBody

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

(==) :: GetPaymentIntentsRequestBody -> GetPaymentIntentsRequestBody -> Bool

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

Show GetPaymentIntentsRequestBody

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

showsPrec :: Int -> GetPaymentIntentsRequestBody -> ShowS

show :: GetPaymentIntentsRequestBody -> String

showList :: [GetPaymentIntentsRequestBody] -> ShowS

ToJSON GetPaymentIntentsRequestBody

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

toJSON :: GetPaymentIntentsRequestBody -> Value

toEncoding :: GetPaymentIntentsRequestBody -> Encoding

toJSONList :: [GetPaymentIntentsRequestBody] -> Value

toEncodingList :: [GetPaymentIntentsRequestBody] -> Encoding

FromJSON GetPaymentIntentsRequestBody

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

parseJSON :: Value -> Parser GetPaymentIntentsRequestBody

parseJSONList :: Value -> Parser [GetPaymentIntentsRequestBody]

data GetPaymentIntentsResponse

Represents a response of the operation getPaymentIntents.

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

Constructors

GetPaymentIntentsResponseError String

Means either no matching case available or a parse error

GetPaymentIntentsResponse200 GetPaymentIntentsResponseBody200

Successful response.

GetPaymentIntentsResponseDefault Error

Error response.

Instances

Eq GetPaymentIntentsResponse

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

(==) :: GetPaymentIntentsResponse -> GetPaymentIntentsResponse -> Bool

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

Show GetPaymentIntentsResponse

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

showsPrec :: Int -> GetPaymentIntentsResponse -> ShowS

show :: GetPaymentIntentsResponse -> String

showList :: [GetPaymentIntentsResponse] -> ShowS

data GetPaymentIntentsResponseBody200

Defines the data type for the schema GetPaymentIntentsResponseBody200

Constructors

GetPaymentIntentsResponseBody200

Fields

• getPaymentIntentsResponseBody200Data :: [] PaymentIntent

  data

• getPaymentIntentsResponseBody200HasMore :: Bool

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

• getPaymentIntentsResponseBody200Object :: GetPaymentIntentsResponseBody200Object'

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

• getPaymentIntentsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetPaymentIntentsResponseBody200

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

(==) :: GetPaymentIntentsResponseBody200 -> GetPaymentIntentsResponseBody200 -> Bool

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

Show GetPaymentIntentsResponseBody200

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

showsPrec :: Int -> GetPaymentIntentsResponseBody200 -> ShowS

show :: GetPaymentIntentsResponseBody200 -> String

showList :: [GetPaymentIntentsResponseBody200] -> ShowS

ToJSON GetPaymentIntentsResponseBody200

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

toJSON :: GetPaymentIntentsResponseBody200 -> Value

toEncoding :: GetPaymentIntentsResponseBody200 -> Encoding

toJSONList :: [GetPaymentIntentsResponseBody200] -> Value

toEncodingList :: [GetPaymentIntentsResponseBody200] -> Encoding

FromJSON GetPaymentIntentsResponseBody200

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

parseJSON :: Value -> Parser GetPaymentIntentsResponseBody200

parseJSONList :: Value -> Parser [GetPaymentIntentsResponseBody200]

data GetPaymentIntentsResponseBody200Object'

Defines the enum schema GetPaymentIntentsResponseBody200Object'

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

Constructors

GetPaymentIntentsResponseBody200Object'EnumOther Value

GetPaymentIntentsResponseBody200Object'EnumTyped Text

GetPaymentIntentsResponseBody200Object'EnumStringList

Instances

Eq GetPaymentIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

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

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

Show GetPaymentIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

showsPrec :: Int -> GetPaymentIntentsResponseBody200Object' -> ShowS

show :: GetPaymentIntentsResponseBody200Object' -> String

showList :: [GetPaymentIntentsResponseBody200Object'] -> ShowS

ToJSON GetPaymentIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

toJSON :: GetPaymentIntentsResponseBody200Object' -> Value

toEncoding :: GetPaymentIntentsResponseBody200Object' -> Encoding

toJSONList :: [GetPaymentIntentsResponseBody200Object'] -> Value

toEncodingList :: [GetPaymentIntentsResponseBody200Object'] -> Encoding

FromJSON GetPaymentIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetPaymentIntents

Methods

parseJSON :: Value -> Parser GetPaymentIntentsResponseBody200Object'

parseJSONList :: Value -> Parser [GetPaymentIntentsResponseBody200Object']