Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Mandate
Description
Contains the types generated from the schema Mandate
Synopsis
- data Mandate = Mandate {
- mandateCustomerAcceptance :: CustomerAcceptance
- mandateId :: Text
- mandateLivemode :: Bool
- mandateMultiUse :: Maybe MandateMultiUse
- mandatePaymentMethod :: MandatePaymentMethod'Variants
- mandatePaymentMethodDetails :: MandatePaymentMethodDetails
- mandateSingleUse :: Maybe MandateSingleUse
- mandateStatus :: MandateStatus'
- mandateType :: MandateType'
- mkMandate :: CustomerAcceptance -> Text -> Bool -> MandatePaymentMethod'Variants -> MandatePaymentMethodDetails -> MandateStatus' -> MandateType' -> Mandate
- data MandatePaymentMethod'Variants
- data MandateStatus'
- data MandateType'
Documentation
Defines the object schema located at components.schemas.mandate
in the specification.
A Mandate is a record of the permission a customer has given you to debit their payment method.
Constructors
Mandate | |
Fields
|
Arguments
:: CustomerAcceptance | |
-> Text | |
-> Bool | |
-> MandatePaymentMethod'Variants | |
-> MandatePaymentMethodDetails | |
-> MandateStatus' | |
-> MandateType' | |
-> Mandate |
Create a new Mandate
with all required fields.
data MandatePaymentMethod'Variants Source #
Defines the oneOf schema located at components.schemas.mandate.properties.payment_method.anyOf
in the specification.
ID of the payment method associated with this mandate.
Instances
Eq MandatePaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.Mandate | |
Show MandatePaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandatePaymentMethod'Variants -> ShowS # show :: MandatePaymentMethod'Variants -> String # showList :: [MandatePaymentMethod'Variants] -> ShowS # | |
ToJSON MandatePaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.Mandate Methods toJSON :: MandatePaymentMethod'Variants -> Value # toEncoding :: MandatePaymentMethod'Variants -> Encoding # toJSONList :: [MandatePaymentMethod'Variants] -> Value # toEncodingList :: [MandatePaymentMethod'Variants] -> Encoding # | |
FromJSON MandatePaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser MandatePaymentMethod'Variants # parseJSONList :: Value -> Parser [MandatePaymentMethod'Variants] # |
data MandateStatus' Source #
Defines the enum schema located at components.schemas.mandate.properties.status
in the specification.
The status of the mandate, which indicates whether it can be used to initiate a payment.
Constructors
MandateStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
MandateStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
MandateStatus'EnumActive | Represents the JSON value |
MandateStatus'EnumInactive | Represents the JSON value |
MandateStatus'EnumPending | Represents the JSON value |
Instances
Eq MandateStatus' Source # | |
Defined in StripeAPI.Types.Mandate Methods (==) :: MandateStatus' -> MandateStatus' -> Bool # (/=) :: MandateStatus' -> MandateStatus' -> Bool # | |
Show MandateStatus' Source # | |
Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandateStatus' -> ShowS # show :: MandateStatus' -> String # showList :: [MandateStatus'] -> ShowS # | |
ToJSON MandateStatus' Source # | |
Defined in StripeAPI.Types.Mandate Methods toJSON :: MandateStatus' -> Value # toEncoding :: MandateStatus' -> Encoding # toJSONList :: [MandateStatus'] -> Value # toEncodingList :: [MandateStatus'] -> Encoding # | |
FromJSON MandateStatus' Source # | |
Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser MandateStatus' # parseJSONList :: Value -> Parser [MandateStatus'] # |
data MandateType' Source #
Defines the enum schema located at components.schemas.mandate.properties.type
in the specification.
The type of the mandate.
Constructors
MandateType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
MandateType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
MandateType'EnumMultiUse | Represents the JSON value |
MandateType'EnumSingleUse | Represents the JSON value |
Instances
Eq MandateType' Source # | |
Defined in StripeAPI.Types.Mandate | |
Show MandateType' Source # | |
Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandateType' -> ShowS # show :: MandateType' -> String # showList :: [MandateType'] -> ShowS # | |
ToJSON MandateType' Source # | |
Defined in StripeAPI.Types.Mandate Methods toJSON :: MandateType' -> Value # toEncoding :: MandateType' -> Encoding # toJSONList :: [MandateType'] -> Value # toEncodingList :: [MandateType'] -> Encoding # | |
FromJSON MandateType' Source # | |
Defined in StripeAPI.Types.Mandate |