StripeAPI.Types.PaymentMethod

Contains the types generated from the schema PaymentMethod

Documentation

data PaymentMethod

Defines the object schema located at components.schemas.payment_method in the specification.

PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Constructors

PaymentMethod

Fields

• paymentMethodAcssDebit :: Maybe PaymentMethodAcssDebit

  acss_debit:

• paymentMethodAfterpayClearpay :: Maybe PaymentMethodAfterpayClearpay

  afterpay_clearpay:

• paymentMethodAlipay :: Maybe PaymentFlowsPrivatePaymentMethodsAlipay

  alipay:

• paymentMethodAuBecsDebit :: Maybe PaymentMethodAuBecsDebit

  au_becs_debit:

• paymentMethodBacsDebit :: Maybe PaymentMethodBacsDebit

  bacs_debit:

• paymentMethodBancontact :: Maybe PaymentMethodBancontact

  bancontact:

• paymentMethodBillingDetails :: BillingDetails

  billing_details:

• paymentMethodBoleto :: Maybe PaymentMethodBoleto

  boleto:

• paymentMethodCard :: Maybe PaymentMethodCard

  card:

• paymentMethodCardPresent :: Maybe PaymentMethodCardPresent

  card_present:

• paymentMethodCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• paymentMethodCustomer :: Maybe PaymentMethodCustomer'Variants

  customer: The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

• paymentMethodEps :: Maybe PaymentMethodEps

  eps:

• paymentMethodFpx :: Maybe PaymentMethodFpx

  fpx:

• paymentMethodGiropay :: Maybe PaymentMethodGiropay

  giropay:

• paymentMethodGrabpay :: Maybe PaymentMethodGrabpay

  grabpay:

• paymentMethodId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• paymentMethodIdeal :: Maybe PaymentMethodIdeal

  ideal:

• paymentMethodInteracPresent :: Maybe PaymentMethodInteracPresent

  interac_present:

• paymentMethodLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• paymentMethodMetadata :: Maybe Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• paymentMethodOxxo :: Maybe PaymentMethodOxxo

  oxxo:

• paymentMethodP24 :: Maybe PaymentMethodP24

  p24:

• paymentMethodSepaDebit :: Maybe PaymentMethodSepaDebit

  sepa_debit:

• paymentMethodSofort :: Maybe PaymentMethodSofort

  sofort:

• paymentMethodType :: PaymentMethodType'

  type: The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Instances

Eq PaymentMethod

Defined in StripeAPI.Types.PaymentMethod

Methods

(==) :: PaymentMethod -> PaymentMethod -> Bool

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

Show PaymentMethod

Defined in StripeAPI.Types.PaymentMethod

Methods

showsPrec :: Int -> PaymentMethod -> ShowS

show :: PaymentMethod -> String

showList :: [PaymentMethod] -> ShowS

ToJSON PaymentMethod

Defined in StripeAPI.Types.PaymentMethod

Methods

toJSON :: PaymentMethod -> Value

toEncoding :: PaymentMethod -> Encoding

toJSONList :: [PaymentMethod] -> Value

toEncodingList :: [PaymentMethod] -> Encoding

FromJSON PaymentMethod

Defined in StripeAPI.Types.PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethod

parseJSONList :: Value -> Parser [PaymentMethod]

mkPaymentMethod

Arguments

:: BillingDetails

paymentMethodBillingDetails

-> Int

paymentMethodCreated

-> Text

paymentMethodId

-> Bool

paymentMethodLivemode

-> PaymentMethodType'

paymentMethodType

-> PaymentMethod

Create a new PaymentMethod with all required fields.

data PaymentMethodCustomer'Variants

Defines the oneOf schema located at components.schemas.payment_method.properties.customer.anyOf in the specification.

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

Constructors

PaymentMethodCustomer'Text Text

PaymentMethodCustomer'Customer Customer

Instances

Eq PaymentMethodCustomer'Variants

Defined in StripeAPI.Types.PaymentMethod

Methods

(==) :: PaymentMethodCustomer'Variants -> PaymentMethodCustomer'Variants -> Bool

(/=) :: PaymentMethodCustomer'Variants -> PaymentMethodCustomer'Variants -> Bool

Show PaymentMethodCustomer'Variants

Defined in StripeAPI.Types.PaymentMethod

Methods

showsPrec :: Int -> PaymentMethodCustomer'Variants -> ShowS

show :: PaymentMethodCustomer'Variants -> String

showList :: [PaymentMethodCustomer'Variants] -> ShowS

ToJSON PaymentMethodCustomer'Variants

Defined in StripeAPI.Types.PaymentMethod

Methods

toJSON :: PaymentMethodCustomer'Variants -> Value

toEncoding :: PaymentMethodCustomer'Variants -> Encoding

toJSONList :: [PaymentMethodCustomer'Variants] -> Value

toEncodingList :: [PaymentMethodCustomer'Variants] -> Encoding

FromJSON PaymentMethodCustomer'Variants

Defined in StripeAPI.Types.PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethodCustomer'Variants

parseJSONList :: Value -> Parser [PaymentMethodCustomer'Variants]

data PaymentMethodType'

Defines the enum schema located at components.schemas.payment_method.properties.type in the specification.

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Constructors

PaymentMethodType'Other Value

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

PaymentMethodType'Typed Text

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

PaymentMethodType'EnumAcssDebit

Represents the JSON value "acss_debit"

PaymentMethodType'EnumAfterpayClearpay

Represents the JSON value "afterpay_clearpay"

PaymentMethodType'EnumAlipay

Represents the JSON value "alipay"

PaymentMethodType'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

PaymentMethodType'EnumBacsDebit

Represents the JSON value "bacs_debit"

PaymentMethodType'EnumBancontact

Represents the JSON value "bancontact"

PaymentMethodType'EnumBoleto

Represents the JSON value "boleto"

PaymentMethodType'EnumCard

Represents the JSON value "card"

PaymentMethodType'EnumCardPresent

Represents the JSON value "card_present"

PaymentMethodType'EnumEps

Represents the JSON value "eps"

PaymentMethodType'EnumFpx

Represents the JSON value "fpx"

PaymentMethodType'EnumGiropay

Represents the JSON value "giropay"

PaymentMethodType'EnumGrabpay

Represents the JSON value "grabpay"

PaymentMethodType'EnumIdeal

Represents the JSON value "ideal"

PaymentMethodType'EnumInteracPresent

Represents the JSON value "interac_present"

PaymentMethodType'EnumOxxo

Represents the JSON value "oxxo"

PaymentMethodType'EnumP24

Represents the JSON value "p24"

PaymentMethodType'EnumSepaDebit

Represents the JSON value "sepa_debit"

PaymentMethodType'EnumSofort

Represents the JSON value "sofort"

Instances

Eq PaymentMethodType'

Defined in StripeAPI.Types.PaymentMethod

Methods

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

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

Show PaymentMethodType'

Defined in StripeAPI.Types.PaymentMethod

Methods

showsPrec :: Int -> PaymentMethodType' -> ShowS

show :: PaymentMethodType' -> String

showList :: [PaymentMethodType'] -> ShowS

ToJSON PaymentMethodType'

Defined in StripeAPI.Types.PaymentMethod

Methods

toJSON :: PaymentMethodType' -> Value

toEncoding :: PaymentMethodType' -> Encoding

toJSONList :: [PaymentMethodType'] -> Value

toEncodingList :: [PaymentMethodType'] -> Encoding

FromJSON PaymentMethodType'

Defined in StripeAPI.Types.PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethodType'

parseJSONList :: Value -> Parser [PaymentMethodType']