Mollie.API.Mandates

WARNING

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

Documentation

mandatesPath :: Text

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

newMandate

Arguments

:: PaymentMethod

-> Text

consumerName

-> Text

consumerAccount

-> NewMandate

createCustomerMandate

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

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

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

All possible payment methods.

Constructors

Ideal

Creditcard

Mistercard

Sofort

Banktransfer

Directdebit

Belfius

Paypal

Bitcoin

Podiumcadeaukaart

Paysafecard

NewPaymentMethod Text

Instances

Eq PaymentMethod

Methods

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

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

Read PaymentMethod

Methods

readsPrec :: Int -> ReadS PaymentMethod

readList :: ReadS [PaymentMethod]

readPrec :: ReadPrec PaymentMethod

readListPrec :: ReadPrec [PaymentMethod]

Show PaymentMethod

Methods

showsPrec :: Int -> PaymentMethod -> ShowS

show :: PaymentMethod -> String

showList :: [PaymentMethod] -> ShowS

ToJSON PaymentMethod

Methods

toJSON :: PaymentMethod -> Value

toEncoding :: PaymentMethod -> Encoding

FromJSON PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethod

ToText PaymentMethod

Methods

toText :: PaymentMethod -> Text

data NewMandate

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

Methods

showsPrec :: Int -> NewMandate -> ShowS

show :: NewMandate -> String

showList :: [NewMandate] -> ShowS

ToJSON NewMandate

Methods

toJSON :: NewMandate -> Value

toEncoding :: NewMandate -> Encoding

data MandateStatus

All possible statusses for a Mandate.

Constructors

MandatePending

MandateValid

MandateInvalid

Instances

Eq MandateStatus

Methods

(==) :: MandateStatus -> MandateStatus -> Bool

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

Read MandateStatus

Methods

readsPrec :: Int -> ReadS MandateStatus

readList :: ReadS [MandateStatus]

readPrec :: ReadPrec MandateStatus

readListPrec :: ReadPrec [MandateStatus]

Show MandateStatus

Methods

showsPrec :: Int -> MandateStatus -> ShowS

show :: MandateStatus -> String

showList :: [MandateStatus] -> ShowS

FromJSON MandateStatus

Methods

parseJSON :: Value -> Parser MandateStatus

ToText MandateStatus

Methods

toText :: MandateStatus -> Text

data MandateDetails

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

Methods

showsPrec :: Int -> MandateDetails -> ShowS

show :: MandateDetails -> String

showList :: [MandateDetails] -> ShowS

FromJSON MandateDetails

Methods

parseJSON :: Value -> Parser MandateDetails

data Mandate

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

Methods

showsPrec :: Int -> Mandate -> ShowS

show :: Mandate -> String

showList :: [Mandate] -> ShowS

FromJSON Mandate

Methods

parseJSON :: Value -> Parser Mandate

data ListLinks

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

Methods

showsPrec :: Int -> ListLinks -> ShowS

show :: ListLinks -> String

showList :: [ListLinks] -> ShowS

FromJSON ListLinks

Methods

parseJSON :: Value -> Parser ListLinks

data List a

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)

Methods

showsPrec :: Int -> List a -> ShowS

show :: List a -> String

showList :: [List a] -> ShowS

FromJSON a0 => FromJSON (List a0)

Methods

parseJSON :: Value -> Parser (List a0)

data ResponseError

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error

ServerError Int

UnexpectedResponse

Instances

Show ResponseError

Methods

showsPrec :: Int -> ResponseError -> ShowS

show :: ResponseError -> String

showList :: [ResponseError] -> ShowS