Safe Haskell	None
Language	Haskell2010

Mollie.API.Mandates

Description

WARNING: This implementation is currently untested! Due to lack of access to the Mandates API.

Synopsis

mandatesPath :: Text
newMandate :: PaymentMethod -> Text -> Text -> NewMandate
createCustomerMandate :: Text -> NewMandate -> Mollie (Either ResponseError Mandate)
getCustomerMandate :: Text -> Text -> Mollie (Either ResponseError Mandate)
getCustomerMandates :: Text -> Int -> Int -> Mollie (Either ResponseError (List Mandate))
data PaymentMethod
- = Ideal
- | Creditcard
- | Mistercard
- | Sofort
- | Banktransfer
- | Directdebit
- | Belfius
- | Paypal
- | Bitcoin
- | Podiumcadeaukaart
- | Paysafecard
- | NewPaymentMethod Text
data NewMandate = NewMandate {
}
data MandateStatus
- = MandatePending
- | MandateValid
- | MandateInvalid
data MandateDetails = MandateDetails {
}
data Mandate = Mandate {
- mandate_id :: Text
- mandate_status :: MandateStatus
- mandate_method :: PaymentMethod
- mandate_customerId :: Text
- mandate_details :: Maybe MandateDetails
- mandate_mandateReference :: Maybe Text
- mandate_createdDatetime :: UTCTime
}
data ListLinks = ListLinks {
- listLinks_previous :: Maybe Text
- listLinks_next :: Maybe Text
- listLinks_first :: Maybe Text
- listLinks_last :: Maybe Text
}
data List a = List {
- list_totalCount :: Int
- list_offset :: Int
- list_count :: Int
- list_data :: [a]
- list_links :: Maybe ListLinks
}
data ResponseError
- = ClientError Int Error
- | ServerError Int
- | UnexpectedResponse

Documentation

mandatesPath :: Text Source #

Mandates resource's path, relative to API's versioned customer resource url.

newMandate Source #

Arguments

:: PaymentMethod
-> Text	consumerName
-> Text	consumerAccount
-> NewMandate

createCustomerMandate Source #

Arguments

:: Text	customerId
-> NewMandate
-> Mollie (Either ResponseError Mandate)

Handler to create a new mandate for a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/mandates/create.

getCustomerMandate Source #

Arguments

:: Text	customerId
-> Text	mandateId
-> Mollie (Either ResponseError Mandate)

Handler to get a mandate by its identifier from a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/mandates/get.

getCustomerMandates Source #

Arguments

:: Text	customerId
-> Int	offset
-> Int	count
-> Mollie (Either ResponseError (List Mandate))

Handler to get a list of mandates for a specific customer. Because the list endpoint is paginated this handler requires an offset and a count. The maximum amount of mandates returned with a single call is 250.

For more information see: https://www.mollie.com/en/docs/reference/mandates/list.

data PaymentMethod Source #

All possible payment methods.

Constructors

Ideal
Creditcard
Mistercard
Sofort
Banktransfer
Directdebit
Belfius
Paypal
Bitcoin
Podiumcadeaukaart
Paysafecard
NewPaymentMethod Text

Instances

Eq PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods (==) :: PaymentMethod -> PaymentMethod -> Bool # (/=) :: PaymentMethod -> PaymentMethod -> Bool #
Read PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods readsPrec :: Int -> ReadS PaymentMethod # readList :: ReadS [PaymentMethod] # readPrec :: ReadPrec PaymentMethod # readListPrec :: ReadPrec [PaymentMethod] #
Show PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> PaymentMethod -> ShowS # show :: PaymentMethod -> String # showList :: [PaymentMethod] -> ShowS #
ToJSON PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: PaymentMethod -> Value # toEncoding :: PaymentMethod -> Encoding # toJSONList :: [PaymentMethod] -> Value # toEncodingList :: [PaymentMethod] -> Encoding #
FromJSON PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser PaymentMethod # parseJSONList :: Value -> Parser [PaymentMethod] #
ToText PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toText :: PaymentMethod -> Text Source #

data NewMandate Source #

Structure to request a new mandate with.

For more information see: https://www.mollie.com/en/docs/reference/mandates/create.

Constructors

NewMandate

Fields

newMandate_method :: PaymentMethod
Set the payment method of the mandate. Currently only directdebit is supported.
newMandate_consumerName :: Text
Set the consumer's name.
newMandate_consumerAccount :: Text
Set the consumer's IBAN.
newMandate_consumerBic :: Maybe Text
Set the consumer's bank BIC/SWIFT code.
newMandate_signatureDate :: Maybe Text
Set the date the mandate was signed in `YYYY-MM-DD` format.
newMandate_mandateReference :: Maybe Text
Set a custom reference to this mandate.

Instances

Show NewMandate Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewMandate -> ShowS # show :: NewMandate -> String # showList :: [NewMandate] -> ShowS #
ToJSON NewMandate Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewMandate -> Value # toEncoding :: NewMandate -> Encoding # toJSONList :: [NewMandate] -> Value # toEncodingList :: [NewMandate] -> Encoding #

data MandateStatus Source #

All possible statusses for a Mandate.

Constructors

MandatePending
MandateValid
MandateInvalid

Instances

Eq MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods (==) :: MandateStatus -> MandateStatus -> Bool # (/=) :: MandateStatus -> MandateStatus -> Bool #
Read MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods readsPrec :: Int -> ReadS MandateStatus # readList :: ReadS [MandateStatus] # readPrec :: ReadPrec MandateStatus # readListPrec :: ReadPrec [MandateStatus] #
Show MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> MandateStatus -> ShowS # show :: MandateStatus -> String # showList :: [MandateStatus] -> ShowS #
FromJSON MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser MandateStatus # parseJSONList :: Value -> Parser [MandateStatus] #
ToText MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: MandateStatus -> Text Source #

data MandateDetails Source #

Details which might be available on Mandates.

Constructors

MandateDetails

Fields

mandateDetails_consumerName :: Maybe Text
The direct debit account holder's name.
mandateDetails_consumerAccount :: Maybe Text
The direct debit account IBAN.
mandateDetails_consumerBic :: Maybe Text
The direct debit account BIC.
mandateDetails_cardHolder :: Maybe Text
The credit card holder's name.
mandateDetails_cardNumber :: Maybe Text
The last 4 digits of the credit card number.
mandateDetails_cardLabel :: Maybe Text
The credit card's label.
mandateDetails_cardFingerprint :: Maybe Text
Unique alphanumeric representation of a credit card. Usable to identify returning customers.
mandateDetails_cardExpiryDate :: Maybe Text
The credit card's expiry date in `YYYY-MM-DD` format.

Instances

Show MandateDetails Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> MandateDetails -> ShowS # show :: MandateDetails -> String # showList :: [MandateDetails] -> ShowS #
FromJSON MandateDetails Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser MandateDetails # parseJSONList :: Value -> Parser [MandateDetails] #

data Mandate Source #

Representation of a mandate available at Mollie.

For more information see: https://www.mollie.com/en/docs/reference/mandates/get.

Constructors

Mandate

Fields

mandate_id :: Text
Mollies reference to the mandate.
mandate_status :: MandateStatus
The status of the mandate.
mandate_method :: PaymentMethod
The payment method of the mandate.
mandate_customerId :: Text
The reference to the customer this mandate is assigned to.
mandate_details :: Maybe MandateDetails
The mandate details.
mandate_mandateReference :: Maybe Text
The custom reference set for this mandate.
mandate_createdDatetime :: UTCTime
The date on which this mandate was created.

Instances

Show Mandate Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Mandate -> ShowS # show :: Mandate -> String # showList :: [Mandate] -> ShowS #
FromJSON Mandate Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Mandate # parseJSONList :: Value -> Parser [Mandate] #

data ListLinks Source #

Important links associated with List responses.

Constructors

ListLinks
Fields listLinks_previous :: Maybe Text URL to previous list. listLinks_next :: Maybe Text URL to next list. listLinks_first :: Maybe Text URL to first list. listLinks_last :: Maybe Text URL to last list.

Instances

Show ListLinks Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> ListLinks -> ShowS # show :: ListLinks -> String # showList :: [ListLinks] -> ShowS #
FromJSON ListLinks Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser ListLinks # parseJSONList :: Value -> Parser [ListLinks] #

data List a Source #

List response for any resource with metadata.

For more information see: https://www.mollie.com/nl/docs/reference/payments/list.

Constructors

List
Fields list_totalCount :: Int Total number of resources available. list_offset :: Int The number of skipped resources. list_count :: Int The number of resources found in `data`. list_data :: [a] The resources for this request. list_links :: Maybe ListLinks Important links for this list.

Instances

Show a => Show (List a) Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> List a -> ShowS # show :: List a -> String # showList :: [List a] -> ShowS #
FromJSON a => FromJSON (List a) Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser (List a) # parseJSONList :: Value -> Parser [List a] #

data ResponseError Source #

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error
ServerError Int
UnexpectedResponse

Instances

Show ResponseError Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> ResponseError -> ShowS # show :: ResponseError -> String # showList :: [ResponseError] -> ShowS #