{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TemplateHaskell #-} module Mollie.API.Types where import qualified Data.Aeson as Aeson import qualified Data.Aeson.TH as Aeson import qualified Data.Aeson.Types as Aeson import qualified Data.Text as Text import qualified Data.Time as Time {-| Helper class for when data is required to be transformed to Mollies format. -} class ToText a where toText :: a -> Text.Text {-| 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. -} data PaymentStatus = 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. deriving (Read, Show, Eq) instance ToText PaymentStatus where toText = Text.pack . Aeson.camelTo2 '_' . drop 7 . show $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' . drop 7 } ''PaymentStatus) {-| All possible payment methods. -} data PaymentMethod = Ideal | Creditcard | Mistercard | Sofort | Banktransfer | Directdebit | Belfius | Paypal | Bitcoin | Podiumcadeaukaart | Paysafecard | NewPaymentMethod Text.Text -- When this shows up in a response from or is required for a request to Mollie contact package maintainer. deriving (Read, Show, Eq) instance ToText PaymentMethod where toText (NewPaymentMethod text) = text toText a = Text.pack $ Aeson.camelTo2 '_' $ show a instance Aeson.ToJSON PaymentMethod where toJSON = Aeson.String . toText instance Aeson.FromJSON PaymentMethod where parseJSON val = case lookup val methods of Just method -> return method Nothing -> case val of (Aeson.String method) -> return $ NewPaymentMethod method invalid -> Aeson.typeMismatch "PaymentMethod" invalid where methods = map (\method -> (Aeson.toJSON method, method)) [ Ideal, Creditcard, Mistercard, Sofort, Banktransfer , Directdebit, Belfius, Paypal, Bitcoin, Podiumcadeaukaart , Paysafecard ] {-| All available recurring types. -} data RecurringType = First | Recurring deriving (Read, Show, Eq) instance ToText RecurringType where toText = Text.pack . Aeson.camelTo2 '_' . show $(Aeson.deriveJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' } ''RecurringType) {-| Structure to request a new payment with. For more information see: https://www.mollie.com/en/docs/reference/payments/create. -} data NewPayment = NewPayment { newPayment_amount :: Double -- ^Set the amount in EURO to charge. Minimum based on available payment methods. , newPayment_description :: Text.Text -- ^Set the description. Will be shown on card or bank statement. , newPayment_redirectUrl :: Maybe Text.Text -- ^Set the url the customer will be redirected to after the payment process. , newPayment_webhookUrl :: Maybe Text.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 Aeson.Value -- ^Set any additional data in JSON format. , newPayment_locale :: Maybe Text.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.Text -- ^Set a customer account for this payment. -- IDEAL fields , newPayment_issuer :: Maybe Text.Text -- CREDIT CARD , newPayment_billingAddress :: Maybe Text.Text -- ^Set card holder's address. This is to improve the credit card fraude protection. , newPayment_billingCity :: Maybe Text.Text -- ^Set the card holder's city. , newPayment_billingRegion :: Maybe Text.Text -- ^Set the card holder's region. , newPayment_billingPostal :: Maybe Text.Text -- ^Set the card holder's postal code. , newPayment_billingCountry :: Maybe Text.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.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.Text -- ^Set the shipping city. When used with PayPal the maximum length is 100 characters. , newPayment_shippingRegion :: Maybe Text.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.Text -- ^Set the shipping postal code. When used with PayPal the maximum length is 20 characters. , newPayment_shippingCountry :: Maybe Text.Text -- ^Set the shipping country in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 format. -- BANK TRANSFER , newPayment_billingEmail :: Maybe Text.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.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.Text -- ^Set the beneficiary name of the account holder. , newPayment_consumerAccount :: Maybe Text.Text -- ^Set the account holders IBAN. -- PAYSAFECARD , newPayment_customerReference :: Maybe Text.Text -- ^Set an identifier for the customer. } deriving (Show) $(Aeson.deriveToJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') , Aeson.omitNothingFields = True } ''NewPayment) {-| All available API modes. -} data Mode = Live | Test deriving (Read, Show, Eq) instance ToText Mode where toText = Text.pack . Aeson.camelTo2 '_' . show $(Aeson.deriveJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' } ''Mode) {-| Important links used for a payment. -} data PaymentLinks = PaymentLinks { paymentLinks_paymentUrl :: Maybe Text.Text -- ^URL where the customer should be redirected to pay. , paymentLinks_webhookUrl :: Maybe Text.Text -- ^URL for the webhook called on status changes. , paymentLinks_redirectUrl :: Maybe Text.Text -- ^URL where the customer will be redirected to by Mollie after checkout. , paymentLinks_settlement :: Maybe Text.Text -- ^URL to the settlement resource this payment belongs to. , paymentLinks_refunds :: Maybe Text.Text -- ^URL to the refund resources for this payment. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''PaymentLinks) {-| 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. -} data Payment = Payment { payment_id :: Text.Text -- ^Mollie's reference to the payment resource. , payment_mode :: Mode -- ^The mode used to create this payment. , payment_createdDatetime :: Time.UTCTime -- ^The date on which the payment was created. , payment_status :: PaymentStatus -- ^The current status. , payment_paidDatetime :: Maybe Time.UTCTime -- ^The date on which the payment was paid. , payment_cancelledDatetime :: Maybe Time.UTCTime -- ^The date on which the payment was cancelled. , payment_expiredDatetime :: Maybe Time.UTCTime -- ^The date on which the payment expired. , payment_expiryPeriod :: Maybe Text.Text -- ^The expiry period assigned to the payment, format: https://en.wikipedia.org/wiki/ISO_8601#Durations. , payment_amount :: Text.Text -- FAIL: Amount is currently being returned as String -- ^The amount of EURO charged for this payment. , payment_amountRefunded :: Maybe Text.Text -- FAIL: Amount is currently being returned as String -- ^The amount of EURO which has been refunded. , payment_amountRemaining :: Maybe Text.Text -- FAIL: Amount is currently being returned as String -- ^The amount of EURO which remained after refunding. , payment_description :: Text.Text -- ^The payment description, as show on the bank or card statement. , payment_method :: Maybe PaymentMethod -- ^The payment method used. , payment_metadata :: Maybe Aeson.Value -- ^Custom privided metadata. , payment_locale :: Maybe Text.Text -- ^The language used during checkout. , payment_profileId :: Text.Text -- ^Identifier for the profile this payment was created on. , payment_customerId :: Maybe Text.Text -- ^Identifier for the customer this payment was created for. , payment_mandateId :: Maybe Text.Text -- ^Identifier for the mandate used for this payment if it's recurring. , payment_settlementId :: Maybe Text.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 Aeson.Object } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Payment) {-| Important links associated with List responses. -} data ListLinks = ListLinks { listLinks_previous :: Maybe Text.Text -- ^URL to previous list. , listLinks_next :: Maybe Text.Text -- ^URL to next list. , listLinks_first :: Maybe Text.Text -- ^URL to first list. , listLinks_last :: Maybe Text.Text -- ^URL to last list. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''ListLinks) {-| List response for any resource with metadata. For more information see: https://www.mollie.com/nl/docs/reference/payments/list. -} data List a = List { 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. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''List) {-| Structure to request a refund. For more information see: https://www.mollie.com/en/docs/reference/refunds/create. -} data NewRefund = NewRefund { 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.Text -- ^Set the description. Will be shown on card or bank statement. } deriving (Show) $(Aeson.deriveToJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''NewRefund) {-| All possible statusses a refund could be assigned. For more information see: https://www.mollie.com/en/docs/reference/refunds/get. -} data RefundStatus = 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. deriving (Read, Show, Eq) instance ToText RefundStatus where toText = Text.pack . Aeson.camelTo2 '_' . drop 6 . show $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' . drop 6 } ''RefundStatus) {-| 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. -} data Refund = Refund { refund_id :: Text.Text -- ^Mollies reference to the refund. , refund_payment :: Payment -- ^The payment for which this refund was made. , refund_amount :: Text.Text -- FAIL: Amount is currently being returned as String -- ^The amount of EURO which this refund refunded. , refund_status :: RefundStatus -- ^The status in which this refund currently is. , refund_refundedDatetime :: Maybe Time.UTCTime -- ^The date on which the refund was issued. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Refund) {-| 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. -} data MethodAmount = MethodAmount { methodAmount_minimum :: Text.Text -- FAIL: Amount is currently being returned as String -- ^The minimum amount of EURO for which it's possible to use this method. , methodAmount_maximum :: Text.Text -- FAIL: Amount is currently being returned as String -- ^The maximum amount of EURO for which it's possible to use this method. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''MethodAmount) {-| Images associated with a payment method. -} data MethodImage = MethodImage { methodImage_normal :: Text.Text -- ^Normal method icon, 40x40 pixels. , methodImage_bigger :: Text.Text -- ^Bigger method icon, 80x80px pixels. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''MethodImage) {-| Representation of a payment method available at Mollie. For more information see: https://www.mollie.com/en/docs/reference/methods/get. -} data Method = Method { method_id :: PaymentMethod -- ^Mollies reference to the method. , method_description :: Text.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. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Method) {-| Representation of an issuer available at Mollie. For more information see: https://www.mollie.com/en/docs/reference/issuers/get. -} data Issuer = Issuer { issuer_id :: Text.Text -- ^Mollies reference to the issuer. , issuer_name :: Text.Text -- ^The issuers full name. , issuer_method :: PaymentMethod -- ^The payment method this issuer belongs to. Currently only Ideal is supported. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Issuer) {-| Structure to request a new customer with. For more information see: https://www.mollie.com/en/docs/reference/customers/create. -} data NewCustomer = NewCustomer { newCustomer_name :: Text.Text -- ^Set the full name of the customer. , newCustomer_email :: Text.Text -- ^Set the email address. , newCustomer_locale :: Maybe Text.Text -- ^Set the language to use for this customer during checkout, , newCustomer_metadata :: Maybe Aeson.Value -- ^Set any additional data in JSON format. } deriving (Show) $(Aeson.deriveToJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''NewCustomer) {-| Representation of an customer available at Mollie. For more information see: https://www.mollie.com/en/docs/reference/customers/get. -} data Customer = Customer { customer_id :: Text.Text -- ^Mollies reference to the customer. , customer_mode :: Mode -- ^The mode in which this customer was created. , customer_name :: Text.Text -- ^The customers full name. , customer_email :: Text.Text -- ^The cusomters email address. , customer_locale :: Maybe Text.Text -- ^The locale used for this customer during checkout. , customer_metadata :: Maybe Aeson.Value -- ^Custom privided data for this customer. , customer_recentlyUsedMethods :: [PaymentMethod] -- ^The payment methods this customer recently used. , customer_createdDatetime :: Time.UTCTime -- ^The creation date of this customer. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Customer) {-| Structure to request a new mandate with. For more information see: https://www.mollie.com/en/docs/reference/mandates/create. -} data NewMandate = NewMandate { newMandate_method :: PaymentMethod -- ^Set the payment method of the mandate. Currently only directdebit is supported. , newMandate_consumerName :: Text.Text -- ^Set the consumer's name. , newMandate_consumerAccount :: Text.Text -- ^Set the consumer's IBAN. , newMandate_consumerBic :: Maybe Text.Text -- ^Set the consumer's bank BIC/SWIFT code. , newMandate_signatureDate :: Maybe Text.Text -- ^Set the date the mandate was signed in `YYYY-MM-DD` format. , newMandate_mandateReference :: Maybe Text.Text -- ^Set a custom reference to this mandate. } deriving (Show) $(Aeson.deriveToJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''NewMandate) {-| All possible statusses for a Mandate. -} data MandateStatus = MandatePending -- TODO: Validate this state, from https://www.mollie.com/nl/docs/recurring. | MandateValid | MandateInvalid deriving (Read, Show, Eq) instance ToText MandateStatus where toText = Text.pack . Aeson.camelTo2 '_' . drop 7 . show $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' . drop 7 } ''MandateStatus) {-| Details which might be available on Mandates. -} data MandateDetails = MandateDetails { mandateDetails_consumerName :: Maybe Text.Text -- ^The direct debit account holder's name. , mandateDetails_consumerAccount :: Maybe Text.Text -- ^The direct debit account IBAN. , mandateDetails_consumerBic :: Maybe Text.Text -- ^The direct debit account BIC. , mandateDetails_cardHolder :: Maybe Text.Text -- ^The credit card holder's name. , mandateDetails_cardNumber :: Maybe Text.Text -- ^The last 4 digits of the credit card number. , mandateDetails_cardLabel :: Maybe Text.Text -- ^The credit card's label. , mandateDetails_cardFingerprint :: Maybe Text.Text -- ^Unique alphanumeric representation of a credit card. Usable to identify returning customers. , mandateDetails_cardExpiryDate :: Maybe Text.Text -- ^The credit card's expiry date in `YYYY-MM-DD` format. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''MandateDetails) {-| Representation of a mandate available at Mollie. For more information see: https://www.mollie.com/en/docs/reference/mandates/get. -} data Mandate = Mandate { mandate_id :: Text.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.Text -- ^The reference to the customer this mandate is assigned to. , mandate_details :: Maybe MandateDetails -- ^The mandate details. , mandate_mandateReference :: Maybe Text.Text -- ^The custom reference set for this mandate. , mandate_createdDatetime :: Time.UTCTime -- ^The date on which this mandate was created. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Mandate) {-| Structure to request a new subscription with. For more information see: https://www.mollie.com/en/docs/reference/subscriptions/create. -} data NewSubscription = NewSubscription { 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.Text -- ^Set the interval to wait between charges like `1 month(s)`, `2 weeks` or `14 days`. , newSubscription_description :: Text.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.Text -- ^Set a webhook URL for all subscription payments. } deriving (Show) $(Aeson.deriveToJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''NewSubscription) {-| All possible statusses a subscription could be assigned. For more information see: https://www.mollie.com/en/docs/reference/subscriptions/get. -} data SubscriptionStatus = SubscriptionPending | SubscriptionActive | SubscriptionCancelled | SubscriptionSuspended | SubscriptionCompleted deriving (Read, Show, Eq) instance ToText SubscriptionStatus where toText = Text.pack . Aeson.camelTo2 '_' . drop 12 . show $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.constructorTagModifier = Aeson.camelTo2 '_' . drop 12 } ''SubscriptionStatus) {-| Important links used for a subscription. -} data SubscriptionLinks = SubscriptionLinks { subscriptionLinks_webhookUrl :: Maybe Text.Text -- ^The webhook URL used for payment made with this subscription. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''SubscriptionLinks) {-| Representation of a subscription available at Mollie. For more information see: https://www.mollie.com/en/docs/reference/subscriptions/get. -} data Subscription = Subscription { subscription_id :: Text.Text -- ^Mollies reference to the subscription. , subscription_customerId :: Text.Text -- ^The reference to the customer this subscription was made for. , subscription_mode :: Mode -- ^The mode used to create this subscription , subscription_createdDatetime :: Time.UTCTime -- ^The date on which this subscription was created. , subscription_status :: SubscriptionStatus -- ^The subscriptions status. , subscription_amount :: Text.Text -- FAIL: Amount is currently being returned as String -- ^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.Text -- ^The interval to wait between charges. , subscription_description :: Text.Text -- ^The description for the payments made with this subscription. , subscription_method :: Maybe PaymentMethod -- ^The payment method used for this subscription. , subscription_cancelledDatetime :: Maybe Time.UTCTime -- ^The date on which this subscription was cancelled. , subscription_links :: SubscriptionLinks -- ^Important links used for this subscription. } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Subscription) {-| Error data representations. For more information see: https://www.mollie.com/en/docs/errors. -} data ErrorLinks = ErrorLinks { errorLinks_documentation :: Text.Text } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''ErrorLinks) data ErrorBody = ErrorBody { errorBody_type :: Text.Text , errorBody_message :: Text.Text , errorBody_field :: Maybe Text.Text , errorBody_links :: Maybe ErrorLinks } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''ErrorBody) data Error = Error { error_error :: ErrorBody } deriving (Show) $(Aeson.deriveFromJSON Aeson.defaultOptions { Aeson.fieldLabelModifier = drop 1 . snd . break (== '_') } ''Error) {-| Response errors which could happen when requesting resources from Mollie. -} data ResponseError = ClientError Int Error | ServerError Int | UnexpectedResponse deriving (Show)