Mollie.API.Customers

Documentation

customersPath :: Text

Customer resource's path, relative to API's versioned url.

newCustomer

Arguments

:: Text

name

-> Text

email

-> NewCustomer

Helper to create a minimal new customer.

createCustomer :: NewCustomer -> Mollie (Either ResponseError Customer)

Handler to create a new customer.

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

getCustomer

Arguments

:: Text

customerId

-> Mollie (Either ResponseError Customer)

Handler to get a customer by its identifier.

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

getCustomers

Arguments

:: Int

offset

-> Int

count

-> Mollie (Either ResponseError (List Customer))

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

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

createCustomerPayment

Arguments

:: Text

customerId

-> NewPayment

-> Mollie (Either ResponseError Payment)

Handler to create a new payment for a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/customers/create-payment.

getCustomerPayments

Arguments

:: Text

customerId

-> Int

offset

-> Int

count

-> Mollie (Either ResponseError (List Payment))

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

For more information see: https://www.mollie.com/en/docs/reference/customers/list-payments.

data NewCustomer

Structure to request a new customer with.

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

Constructors

NewCustomer

Fields

• newCustomer_name :: Text

  Set the full name of the customer.

• newCustomer_email :: Text

  Set the email address.

• newCustomer_locale :: Maybe Text

  Set the language to use for this customer during checkout,

• newCustomer_metadata :: Maybe Value

  Set any additional data in JSON format.

Instances

Show NewCustomer

Methods

showsPrec :: Int -> NewCustomer -> ShowS

show :: NewCustomer -> String

showList :: [NewCustomer] -> ShowS

ToJSON NewCustomer

Methods

toJSON :: NewCustomer -> Value

toEncoding :: NewCustomer -> Encoding

toJSONList :: [NewCustomer] -> Value

toEncodingList :: [NewCustomer] -> Encoding

data Customer

Representation of an customer available at Mollie.

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

Constructors

Customer

Fields

• customer_id :: Text

  Mollies reference to the customer.

• customer_mode :: Mode

  The mode in which this customer was created.

• customer_name :: Text

  The customers full name.

• customer_email :: Text

  The cusomters email address.

• customer_locale :: Maybe Text

  The locale used for this customer during checkout.

• customer_metadata :: Maybe Value

  Custom privided data for this customer.

• customer_recentlyUsedMethods :: [PaymentMethod]

  The payment methods this customer recently used.

• customer_createdDatetime :: UTCTime

  The creation date of this customer.

Instances

Show Customer

Methods

showsPrec :: Int -> Customer -> ShowS

show :: Customer -> String

showList :: [Customer] -> ShowS

FromJSON Customer

Methods

parseJSON :: Value -> Parser Customer

parseJSONList :: Value -> Parser [Customer]

data Mode

All available API modes.

Constructors

Live

Test

Instances

Eq Mode

Methods

(==) :: Mode -> Mode -> Bool

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

Read Mode

Methods

readsPrec :: Int -> ReadS Mode

readList :: ReadS [Mode]

readPrec :: ReadPrec Mode

readListPrec :: ReadPrec [Mode]

Show Mode

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

ToJSON Mode

Methods

toJSON :: Mode -> Value

toEncoding :: Mode -> Encoding

toJSONList :: [Mode] -> Value

toEncodingList :: [Mode] -> Encoding

FromJSON Mode

Methods

parseJSON :: Value -> Parser Mode

parseJSONList :: Value -> Parser [Mode]

ToText Mode

Methods

toText :: Mode -> Text

data PaymentStatus

All possible statusses which can be assigned to a payment. When an important status changes occurs Mollie will notify the application by requesting the configured Webhook. Note that some changes will never be known to the application.

For more information see: https://www.mollie.com/en/docs/status.

Constructors

PaymentOpen

Payment has been created. This is the initial status.

PaymentCancelled

Customer has cancelled the payment.

PaymentPending

The payment process has been started. No notification.

PaymentExpired

The payment has expired. Some payment methods (like banktransfer) might need a few days to process.

PaymentFailed

The payment can't be completed.

PaymentPaid

The payment was successful. This is the success status.

PaymentPaidout

Mollie has transfered the payment to your bankaccount. No notification.

PaymentRefunded

You requested a refund for the payment.

PaymentChargedBack

The customer dispute the payment. This is possible with creditcard, directdebit and paypal payments.

Instances

Eq PaymentStatus

Methods

(==) :: PaymentStatus -> PaymentStatus -> Bool

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

Read PaymentStatus

Methods

readsPrec :: Int -> ReadS PaymentStatus

readList :: ReadS [PaymentStatus]

readPrec :: ReadPrec PaymentStatus

readListPrec :: ReadPrec [PaymentStatus]

Show PaymentStatus

Methods

showsPrec :: Int -> PaymentStatus -> ShowS

show :: PaymentStatus -> String

showList :: [PaymentStatus] -> ShowS

FromJSON PaymentStatus

Methods

parseJSON :: Value -> Parser PaymentStatus

parseJSONList :: Value -> Parser [PaymentStatus]

ToText PaymentStatus

Methods

toText :: PaymentStatus -> Text

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

toJSONList :: [PaymentMethod] -> Value

toEncodingList :: [PaymentMethod] -> Encoding

FromJSON PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethod

parseJSONList :: Value -> Parser [PaymentMethod]

ToText PaymentMethod

Methods

toText :: PaymentMethod -> Text

data RecurringType

All available recurring types.

Constructors

First

Recurring

Instances

Eq RecurringType

Methods

(==) :: RecurringType -> RecurringType -> Bool

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

Read RecurringType

Methods

readsPrec :: Int -> ReadS RecurringType

readList :: ReadS [RecurringType]

readPrec :: ReadPrec RecurringType

readListPrec :: ReadPrec [RecurringType]

Show RecurringType

Methods

showsPrec :: Int -> RecurringType -> ShowS

show :: RecurringType -> String

showList :: [RecurringType] -> ShowS

ToJSON RecurringType

Methods

toJSON :: RecurringType -> Value

toEncoding :: RecurringType -> Encoding

toJSONList :: [RecurringType] -> Value

toEncodingList :: [RecurringType] -> Encoding

FromJSON RecurringType

Methods

parseJSON :: Value -> Parser RecurringType

parseJSONList :: Value -> Parser [RecurringType]

ToText RecurringType

Methods

toText :: RecurringType -> Text

data NewPayment

Structure to request a new payment with.

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

Constructors

NewPayment

Fields

• newPayment_amount :: Double

  Set the amount in EURO to charge. Minimum based on available payment methods.

• newPayment_description :: Text

  Set the description. Will be shown on card or bank statement.

• newPayment_redirectUrl :: Maybe Text

  Set the url the customer will be redirected to after the payment process.

• newPayment_webhookUrl :: Maybe Text

  Set a specific webhook for this payment.

• newPayment_method :: Maybe PaymentMethod

  Set a specific payment method for this payment. The customer will not have a choice when this is set.

• newPayment_metadata :: Maybe Value

  Set any additional data in JSON format.

• newPayment_locale :: Maybe Text

  Force the payment screen language.

• newPayment_recurringType :: Maybe RecurringType

  Set the recurring type, for more information see: https://www.mollie.com/en/docs/reference/customers/create-payment.

• newPayment_customerId :: Maybe Text

  Set a customer account for this payment. IDEAL fields

• newPayment_issuer :: Maybe Text
• newPayment_billingAddress :: Maybe Text

  Set card holder's address. This is to improve the credit card fraude protection.

• newPayment_billingCity :: Maybe Text

  Set the card holder's city.

• newPayment_billingRegion :: Maybe Text

  Set the card holder's region.

• newPayment_billingPostal :: Maybe Text

  Set the card holder's postal code.

• newPayment_billingCountry :: Maybe Text

  Set the card holder's country in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 format. CREDIT CARD & PAYPAL

• newPayment_shippingAddress :: Maybe Text

  Set the shipping address. This is to improve fraude protection. When used with PayPal the maximum length is 128 characters.

• newPayment_shippingCity :: Maybe Text

  Set the shipping city. When used with PayPal the maximum length is 100 characters.

• newPayment_shippingRegion :: Maybe Text

  Set the shipping region. When used with PayPal the maximum length is 100 characters and this field is required when the shipping country is one of the following countries: AR BR CA CN ID IN JP MX TH US.

• newPayment_shippingPostal :: Maybe Text

  Set the shipping postal code. When used with PayPal the maximum length is 20 characters.

• newPayment_shippingCountry :: Maybe Text

  Set the shipping country in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 format. BANK TRANSFER

• newPayment_billingEmail :: Maybe Text

  Set the billing email address. Billing instructions will be send immediately when the payment is created. When no locale is set the email will be sent in English.

• newPayment_dueDate :: Maybe Text

  Set the date this payment should expire, in `YYYY-MM-DD` format. Minimum date is tomorrow and maximum is 100 days from now. SEPA DIRECT DEBIT

• newPayment_consumerName :: Maybe Text

  Set the beneficiary name of the account holder.

• newPayment_consumerAccount :: Maybe Text

  Set the account holders IBAN. PAYSAFECARD

• newPayment_customerReference :: Maybe Text

  Set an identifier for the customer.

Instances

Show NewPayment

Methods

showsPrec :: Int -> NewPayment -> ShowS

show :: NewPayment -> String

showList :: [NewPayment] -> ShowS

ToJSON NewPayment

Methods

toJSON :: NewPayment -> Value

toEncoding :: NewPayment -> Encoding

toJSONList :: [NewPayment] -> Value

toEncodingList :: [NewPayment] -> Encoding

data Payment

Representation of a payment made with Mollie.

Note that the amounts are curently returned as text because Mollie does not return them as valid json numbers.

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

Constructors

Payment

Fields

• payment_id :: Text

  Mollie's reference to the payment resource.

• payment_mode :: Mode

  The mode used to create this payment.

• payment_createdDatetime :: UTCTime

  The date on which the payment was created.

• payment_status :: PaymentStatus

  The current status.

• payment_paidDatetime :: Maybe UTCTime

  The date on which the payment was paid.

• payment_cancelledDatetime :: Maybe UTCTime

  The date on which the payment was cancelled.

• payment_expiredDatetime :: Maybe UTCTime

  The date on which the payment expired.

• payment_expiryPeriod :: Maybe Text

  The expiry period assigned to the payment, format: https://en.wikipedia.org/wiki/ISO_8601#Durations.

• payment_amount :: Text

  The amount of EURO charged for this payment.

• payment_amountRefunded :: Maybe Text

  The amount of EURO which has been refunded.

• payment_amountRemaining :: Maybe Text

  The amount of EURO which remained after refunding.

• payment_description :: Text

  The payment description, as show on the bank or card statement.

• payment_method :: Maybe PaymentMethod

  The payment method used.

• payment_metadata :: Maybe Value

  Custom privided metadata.

• payment_locale :: Maybe Text

  The language used during checkout.

• payment_profileId :: Text

  Identifier for the profile this payment was created on.

• payment_customerId :: Maybe Text

  Identifier for the customer this payment was created for.

• payment_mandateId :: Maybe Text

  Identifier for the mandate used for this payment if it's recurring.

• payment_settlementId :: Maybe Text

  Identifier for the settlement this payment belongs to.

• payment_links :: PaymentLinks

  Important links used for this payment. TODO: Add payment specific details, see: https://www.mollie.com/nl/docs/reference/payments/get

• payment_details :: Maybe Object

Instances

Show Payment

Methods

showsPrec :: Int -> Payment -> ShowS

show :: Payment -> String

showList :: [Payment] -> ShowS

FromJSON Payment

Methods

parseJSON :: Value -> Parser Payment

parseJSONList :: Value -> Parser [Payment]

data PaymentLinks

Important links used for a payment.

Constructors

PaymentLinks

Fields

• paymentLinks_paymentUrl :: Maybe Text

  URL where the customer should be redirected to pay.

• paymentLinks_webhookUrl :: Maybe Text

  URL for the webhook called on status changes.

• paymentLinks_redirectUrl :: Maybe Text

  URL where the customer will be redirected to by Mollie after checkout.

• paymentLinks_settlement :: Maybe Text

  URL to the settlement resource this payment belongs to.

• paymentLinks_refunds :: Maybe Text

  URL to the refund resources for this payment.

Instances

Show PaymentLinks

Methods

showsPrec :: Int -> PaymentLinks -> ShowS

show :: PaymentLinks -> String

showList :: [PaymentLinks] -> ShowS

FromJSON PaymentLinks

Methods

parseJSON :: Value -> Parser PaymentLinks

parseJSONList :: Value -> Parser [PaymentLinks]

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 a => FromJSON (List a)

Methods

parseJSON :: Value -> Parser (List a)

parseJSONList :: Value -> Parser [List a]

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

parseJSONList :: Value -> Parser [ListLinks]

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