StripeAPI.Operations.GetPaymentMethods

Contains the different functions to run the operation getPaymentMethods

Documentation

getPaymentMethods

Arguments

:: forall m. MonadHTTP m

=> GetPaymentMethodsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetPaymentMethodsResponse)

Monadic computation which returns the result of the operation

GET /v1/payment_methods

<p>Returns a list of PaymentMethods for a given Customer</p>

data GetPaymentMethodsParameters

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

Constructors

GetPaymentMethodsParameters

Fields

• getPaymentMethodsParametersQueryCustomer :: Text

  queryCustomer: Represents the parameter named 'customer'

  The ID of the customer whose PaymentMethods will be retrieved.

  Constraints:

  • Maximum length of 5000
• getPaymentMethodsParametersQueryEndingBefore :: 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.

• getPaymentMethodsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getPaymentMethodsParametersQueryLimit :: 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.

• getPaymentMethodsParametersQueryStartingAfter :: 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.

• getPaymentMethodsParametersQueryType :: GetPaymentMethodsParametersQueryType'

  queryType: Represents the parameter named 'type'

  A required filter on the list, based on the object `type` field.

Instances

Eq GetPaymentMethodsParameters

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

(==) :: GetPaymentMethodsParameters -> GetPaymentMethodsParameters -> Bool

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

Show GetPaymentMethodsParameters

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

showsPrec :: Int -> GetPaymentMethodsParameters -> ShowS

show :: GetPaymentMethodsParameters -> String

showList :: [GetPaymentMethodsParameters] -> ShowS

ToJSON GetPaymentMethodsParameters

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

toJSON :: GetPaymentMethodsParameters -> Value

toEncoding :: GetPaymentMethodsParameters -> Encoding

toJSONList :: [GetPaymentMethodsParameters] -> Value

toEncodingList :: [GetPaymentMethodsParameters] -> Encoding

FromJSON GetPaymentMethodsParameters

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

parseJSON :: Value -> Parser GetPaymentMethodsParameters

parseJSONList :: Value -> Parser [GetPaymentMethodsParameters]

mkGetPaymentMethodsParameters

Arguments

:: Text

getPaymentMethodsParametersQueryCustomer

-> GetPaymentMethodsParametersQueryType'

getPaymentMethodsParametersQueryType

-> GetPaymentMethodsParameters

Create a new GetPaymentMethodsParameters with all required fields.

data GetPaymentMethodsParametersQueryType'

Defines the enum schema located at paths./v1/payment_methods.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

A required filter on the list, based on the object `type` field.

Constructors

GetPaymentMethodsParametersQueryType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

GetPaymentMethodsParametersQueryType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

GetPaymentMethodsParametersQueryType'EnumAcssDebit

Represents the JSON value "acss_debit"

GetPaymentMethodsParametersQueryType'EnumAfterpayClearpay

Represents the JSON value "afterpay_clearpay"

GetPaymentMethodsParametersQueryType'EnumAlipay

Represents the JSON value "alipay"

GetPaymentMethodsParametersQueryType'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

GetPaymentMethodsParametersQueryType'EnumBacsDebit

Represents the JSON value "bacs_debit"

GetPaymentMethodsParametersQueryType'EnumBancontact

Represents the JSON value "bancontact"

GetPaymentMethodsParametersQueryType'EnumBoleto

Represents the JSON value "boleto"

GetPaymentMethodsParametersQueryType'EnumCard

Represents the JSON value "card"

GetPaymentMethodsParametersQueryType'EnumEps

Represents the JSON value "eps"

GetPaymentMethodsParametersQueryType'EnumFpx

Represents the JSON value "fpx"

GetPaymentMethodsParametersQueryType'EnumGiropay

Represents the JSON value "giropay"

GetPaymentMethodsParametersQueryType'EnumGrabpay

Represents the JSON value "grabpay"

GetPaymentMethodsParametersQueryType'EnumIdeal

Represents the JSON value "ideal"

GetPaymentMethodsParametersQueryType'EnumOxxo

Represents the JSON value "oxxo"

GetPaymentMethodsParametersQueryType'EnumP24

Represents the JSON value "p24"

GetPaymentMethodsParametersQueryType'EnumSepaDebit

Represents the JSON value "sepa_debit"

GetPaymentMethodsParametersQueryType'EnumSofort

Represents the JSON value "sofort"

Instances

Eq GetPaymentMethodsParametersQueryType'

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

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

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

Show GetPaymentMethodsParametersQueryType'

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

showsPrec :: Int -> GetPaymentMethodsParametersQueryType' -> ShowS

show :: GetPaymentMethodsParametersQueryType' -> String

showList :: [GetPaymentMethodsParametersQueryType'] -> ShowS

ToJSON GetPaymentMethodsParametersQueryType'

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

toJSON :: GetPaymentMethodsParametersQueryType' -> Value

toEncoding :: GetPaymentMethodsParametersQueryType' -> Encoding

toJSONList :: [GetPaymentMethodsParametersQueryType'] -> Value

toEncodingList :: [GetPaymentMethodsParametersQueryType'] -> Encoding

FromJSON GetPaymentMethodsParametersQueryType'

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

parseJSON :: Value -> Parser GetPaymentMethodsParametersQueryType'

parseJSONList :: Value -> Parser [GetPaymentMethodsParametersQueryType']

data GetPaymentMethodsResponse

Represents a response of the operation getPaymentMethods.

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

Constructors

GetPaymentMethodsResponseError String

Means either no matching case available or a parse error

GetPaymentMethodsResponse200 GetPaymentMethodsResponseBody200

Successful response.

GetPaymentMethodsResponseDefault Error

Error response.

Instances

Eq GetPaymentMethodsResponse

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

(==) :: GetPaymentMethodsResponse -> GetPaymentMethodsResponse -> Bool

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

Show GetPaymentMethodsResponse

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

showsPrec :: Int -> GetPaymentMethodsResponse -> ShowS

show :: GetPaymentMethodsResponse -> String

showList :: [GetPaymentMethodsResponse] -> ShowS

data GetPaymentMethodsResponseBody200

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

Constructors

GetPaymentMethodsResponseBody200

Fields

• getPaymentMethodsResponseBody200Data :: [PaymentMethod]

  data

• getPaymentMethodsResponseBody200HasMore :: Bool

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

• getPaymentMethodsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetPaymentMethodsResponseBody200

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

(==) :: GetPaymentMethodsResponseBody200 -> GetPaymentMethodsResponseBody200 -> Bool

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

Show GetPaymentMethodsResponseBody200

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

showsPrec :: Int -> GetPaymentMethodsResponseBody200 -> ShowS

show :: GetPaymentMethodsResponseBody200 -> String

showList :: [GetPaymentMethodsResponseBody200] -> ShowS

ToJSON GetPaymentMethodsResponseBody200

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

toJSON :: GetPaymentMethodsResponseBody200 -> Value

toEncoding :: GetPaymentMethodsResponseBody200 -> Encoding

toJSONList :: [GetPaymentMethodsResponseBody200] -> Value

toEncodingList :: [GetPaymentMethodsResponseBody200] -> Encoding

FromJSON GetPaymentMethodsResponseBody200

Defined in StripeAPI.Operations.GetPaymentMethods

Methods

parseJSON :: Value -> Parser GetPaymentMethodsResponseBody200

parseJSONList :: Value -> Parser [GetPaymentMethodsResponseBody200]

mkGetPaymentMethodsResponseBody200

Arguments

:: [PaymentMethod]

getPaymentMethodsResponseBody200Data

-> Bool

getPaymentMethodsResponseBody200HasMore

-> Text

getPaymentMethodsResponseBody200Url

-> GetPaymentMethodsResponseBody200

Create a new GetPaymentMethodsResponseBody200 with all required fields.