Mollie.API.Types

Documentation

class ToText a where

Helper class for when data is required to be transformed to Mollies format.

Minimal complete definition

toText

Methods

toText :: a -> Text

Instances

ToText PaymentStatus

Methods

toText :: PaymentStatus -> Text

ToText RecurringType

Methods

toText :: RecurringType -> Text

ToText PaymentMethod

Methods

toText :: PaymentMethod -> Text

ToText Mode

Methods

toText :: Mode -> Text

ToText RefundStatus

Methods

toText :: RefundStatus -> Text

ToText MandateStatus

Methods

toText :: MandateStatus -> Text

ToText SubscriptionStatus

Methods

toText :: SubscriptionStatus -> 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

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

FromJSON PaymentMethod

Methods

parseJSON :: 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

FromJSON RecurringType

Methods

parseJSON :: 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

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

FromJSON Mode

Methods

parseJSON :: Value -> Parser Mode

ToText Mode

Methods

toText :: Mode -> Text

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

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

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 NewRefund

Structure to request a refund.

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

Constructors

NewRefund

Fields

• newRefund_amount :: Maybe Double

  Set the amount in EURO that should be refunded. If left Nothing the full amount of the targetted payment will be refunded.

• newRefund_description :: Maybe Text

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

Instances

Show NewRefund

Methods

showsPrec :: Int -> NewRefund -> ShowS

show :: NewRefund -> String

showList :: [NewRefund] -> ShowS

ToJSON NewRefund

Methods

toJSON :: NewRefund -> Value

toEncoding :: NewRefund -> Encoding

data RefundStatus

All possible statusses a refund could be assigned.

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

Constructors

RefundPending

The payment will be processed soon (usually the next business day). The refund could still be cancelled, see: https://www.mollie.com/en/docs/reference/refunds/delete.

RefundProcessing

The refund is processing, cancellation is no longer possible.

RefundRefunded

The refund has been paid out the the customer.

Instances

Eq RefundStatus

Methods

(==) :: RefundStatus -> RefundStatus -> Bool

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

Read RefundStatus

Methods

readsPrec :: Int -> ReadS RefundStatus

readList :: ReadS [RefundStatus]

readPrec :: ReadPrec RefundStatus

readListPrec :: ReadPrec [RefundStatus]

Show RefundStatus

Methods

showsPrec :: Int -> RefundStatus -> ShowS

show :: RefundStatus -> String

showList :: [RefundStatus] -> ShowS

FromJSON RefundStatus

Methods

parseJSON :: Value -> Parser RefundStatus

ToText RefundStatus

Methods

toText :: RefundStatus -> Text

data Refund

Representation of a refund made with Mollie.

Note that the amount is curently returned as text because Mollie does not return it as a valid json number.

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

Constructors

Refund

Fields

• refund_id :: Text

  Mollies reference to the refund.

• refund_payment :: Payment

  The payment for which this refund was made.

• refund_amount :: Text

  The amount of EURO which this refund refunded.

• refund_status :: RefundStatus

  The status in which this refund currently is.

• refund_refundedDatetime :: Maybe UTCTime

  The date on which the refund was issued.

Instances

Show Refund

Methods

showsPrec :: Int -> Refund -> ShowS

show :: Refund -> String

showList :: [Refund] -> ShowS

FromJSON Refund

Methods

parseJSON :: Value -> Parser Refund

data MethodAmount

Minimum and maximum amounts for a payment method.

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

Constructors

MethodAmount

Fields

• methodAmount_minimum :: Text

  The minimum amount of EURO for which it's possible to use this method.

• methodAmount_maximum :: Text

  The maximum amount of EURO for which it's possible to use this method.

Instances

Show MethodAmount

Methods

showsPrec :: Int -> MethodAmount -> ShowS

show :: MethodAmount -> String

showList :: [MethodAmount] -> ShowS

FromJSON MethodAmount

Methods

parseJSON :: Value -> Parser MethodAmount

data MethodImage

Images associated with a payment method.

Constructors

MethodImage

Fields

• methodImage_normal :: Text

  Normal method icon, 40x40 pixels.

• methodImage_bigger :: Text

  Bigger method icon, 80x80px pixels.

Instances

Show MethodImage

Methods

showsPrec :: Int -> MethodImage -> ShowS

show :: MethodImage -> String

showList :: [MethodImage] -> ShowS

FromJSON MethodImage

Methods

parseJSON :: Value -> Parser MethodImage

data Method

Representation of a payment method available at Mollie.

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

Constructors

Method

Fields

• method_id :: PaymentMethod

  Mollies reference to the method.

• method_description :: Text

  Full name of the method. This value changes based on requested locale.

• method_amount :: MethodAmount

  Range for this method in EURO.

• method_image :: MethodImage

  Icons for this method.

Instances

Show Method

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

FromJSON Method

Methods

parseJSON :: Value -> Parser Method

data Issuer

Representation of an issuer available at Mollie.

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

Constructors

Issuer

Fields

• issuer_id :: Text

  Mollies reference to the issuer.

• issuer_name :: Text

  The issuers full name.

• issuer_method :: PaymentMethod

  The payment method this issuer belongs to. Currently only Ideal is supported.

Instances

Show Issuer

Methods

showsPrec :: Int -> Issuer -> ShowS

show :: Issuer -> String

showList :: [Issuer] -> ShowS

FromJSON Issuer

Methods

parseJSON :: Value -> Parser Issuer

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

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

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 NewSubscription

Structure to request a new subscription with.

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

Constructors

NewSubscription

Fields

• newSubscription_amount :: Double

  Set the constant amount in EURO you want to charge with each payment.

• newSubscription_times :: Maybe Int

  Set the total number of charges for the subscription to complete. Leave empty for ongoing subscriptions.

• newSubscription_interval :: Text

  Set the interval to wait between charges like `1 month(s)`, `2 weeks` or `14 days`.

• newSubscription_description :: Text

  Set the description which will be included in the payment description along with the carge date in `Y-m-d` format.

• newSubscription_method :: Maybe PaymentMethod

  Force the payment method, leave empty to use one of the customers valid mandates.

• newSubscription_webhookUrl :: Maybe Text

  Set a webhook URL for all subscription payments.

Instances

Show NewSubscription

Methods

showsPrec :: Int -> NewSubscription -> ShowS

show :: NewSubscription -> String

showList :: [NewSubscription] -> ShowS

ToJSON NewSubscription

Methods

toJSON :: NewSubscription -> Value

toEncoding :: NewSubscription -> Encoding

data SubscriptionStatus

All possible statusses a subscription could be assigned.

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

Constructors

SubscriptionPending

SubscriptionActive

SubscriptionCancelled

SubscriptionSuspended

SubscriptionCompleted

Instances

Eq SubscriptionStatus

Methods

(==) :: SubscriptionStatus -> SubscriptionStatus -> Bool

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

Read SubscriptionStatus

Methods

readsPrec :: Int -> ReadS SubscriptionStatus

readList :: ReadS [SubscriptionStatus]

readPrec :: ReadPrec SubscriptionStatus

readListPrec :: ReadPrec [SubscriptionStatus]

Show SubscriptionStatus

Methods

showsPrec :: Int -> SubscriptionStatus -> ShowS

show :: SubscriptionStatus -> String

showList :: [SubscriptionStatus] -> ShowS

FromJSON SubscriptionStatus

Methods

parseJSON :: Value -> Parser SubscriptionStatus

ToText SubscriptionStatus

Methods

toText :: SubscriptionStatus -> Text

data SubscriptionLinks

Important links used for a subscription.

Constructors

SubscriptionLinks

Fields

• subscriptionLinks_webhookUrl :: Maybe Text

  The webhook URL used for payment made with this subscription.

Instances

Show SubscriptionLinks

Methods

showsPrec :: Int -> SubscriptionLinks -> ShowS

show :: SubscriptionLinks -> String

showList :: [SubscriptionLinks] -> ShowS

FromJSON SubscriptionLinks

Methods

parseJSON :: Value -> Parser SubscriptionLinks

data Subscription

Representation of a subscription available at Mollie.

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

Constructors

Subscription

Fields

• subscription_id :: Text

  Mollies reference to the subscription.

• subscription_customerId :: Text

  The reference to the customer this subscription was made for.

• subscription_mode :: Mode

  The mode used to create this subscription

• subscription_createdDatetime :: UTCTime

  The date on which this subscription was created.

• subscription_status :: SubscriptionStatus

  The subscriptions status.

• subscription_amount :: Text

  The amount of EURO charged with each payment for this subscription.

• subscription_times :: Maybe Int

  The total number or charges for the subscription to complete.

• subscription_interval :: Text

  The interval to wait between charges.

• subscription_description :: Text

  The description for the payments made with this subscription.

• subscription_method :: Maybe PaymentMethod

  The payment method used for this subscription.

• subscription_cancelledDatetime :: Maybe UTCTime

  The date on which this subscription was cancelled.

• subscription_links :: SubscriptionLinks

  Important links used for this subscription.

Instances

Show Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

FromJSON Subscription

Methods

parseJSON :: Value -> Parser Subscription

data ErrorLinks

Error data representations.

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

Constructors

ErrorLinks

Fields

• errorLinks_documentation :: Text

Instances

Show ErrorLinks

Methods

showsPrec :: Int -> ErrorLinks -> ShowS

show :: ErrorLinks -> String

showList :: [ErrorLinks] -> ShowS

FromJSON ErrorLinks

Methods

parseJSON :: Value -> Parser ErrorLinks

data ErrorBody

Constructors

ErrorBody

Fields

• errorBody_type :: Text
• errorBody_message :: Text
• errorBody_field :: Maybe Text
• errorBody_links :: Maybe ErrorLinks

Instances

Show ErrorBody

Methods

showsPrec :: Int -> ErrorBody -> ShowS

show :: ErrorBody -> String

showList :: [ErrorBody] -> ShowS

FromJSON ErrorBody

Methods

parseJSON :: Value -> Parser ErrorBody

data Error

Constructors

Error

Fields

• error_error :: ErrorBody

Instances

Show Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

FromJSON Error

Methods

parseJSON :: Value -> Parser Error

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