Safe Haskell	None
Language	Haskell2010

Mollie.API

Synopsis

type MollieServantAPI = "v2" :> ToServantApi MollieAPI
data MollieAPI route
data HalJSON
chargebackClient :: ChargebackAPI (AsClientT ClientM)
customerClient :: CustomerAPI (AsClientT ClientM)
mandateClient :: MandateAPI (AsClientT ClientM)
methodClient :: MethodAPI (AsClientT ClientM)
paymentClient :: PaymentAPI (AsClientT ClientM)
refundClient :: RefundAPI (AsClientT ClientM)
subscriptionClient :: SubscriptionAPI (AsClientT ClientM)
createEnv :: String -> IO ClientEnv
runMollie :: ClientEnv -> ClientM a -> IO (Either ResponseError a)
class ToText a where
- toText :: a -> Text
type CustomerId = Text
type PaymentId = Text
type RefundId = Text
type SubscriptionId = Text
type ChargebackId = Text
type MandateId = Text
data Amount = Amount {
- _amountCurrency :: Alpha
- _amountValue :: Text
}
defaultAmount :: Double -> Amount
class HasCurrency s a | s -> a where
- currency :: Lens' s a
class HasValue s a | s -> a where
- value :: Lens' s a
data Address = Address {
- _addressStreetAndNumber :: Text
- _addressStreetAdditional :: Maybe Text
- _addressPostalCode :: Text
- _addressCity :: Text
- _addressRegion :: Maybe Text
- _addressCountry :: Text
}
class HasCity s a | s -> a where
- city :: Lens' s a
class HasCountry s a | s -> a where
- country :: Lens' s a
class HasPostalCode s a | s -> a where
- postalCode :: Lens' s a
class HasRegion s a | s -> a where
- region :: Lens' s a
class HasStreetAdditional s a | s -> a where
- streetAdditional :: Lens' s a
class HasStreetAndNumber s a | s -> a where
- streetAndNumber :: Lens' s a
data Link = Link {
- _linkHref :: Text
}
class HasHref s a | s -> a where
- href :: Lens' s a
data Mode
- = Live
- | Test
data ListLinks = ListLinks {
- _listLinksSelf :: Link
- _listLinksNext :: Maybe Link
- _listLinksPrevious :: Maybe Link
- _listLinksDocumentation :: Maybe Link
}
class HasDocumentation s a | s -> a where
- documentation :: Lens' s a
class HasNext s a | s -> a where
- next :: Lens' s a
class HasPrevious s a | s -> a where
- previous :: Lens' s a
class HasSelf s a | s -> a where
- self :: Lens' s a
data List a = List {
- _listCount :: Int
- _listEmbedded :: [a]
- _listLinks :: ListLinks
}
class HasCount s a | s -> a where
- count :: Lens' s a
class HasEmbedded s a | s -> a where
- embedded :: Lens' s a
class HasLinks s a | s -> a where
- links :: Lens' s a
data ErrorLinks = ErrorLinks {
- _errorLinksDocumentation :: Link
}
data Error = Error {
- _errorTitle :: Text
- _errorDetail :: Text
- _errorField :: Maybe Text
- _errorLinks :: Maybe ErrorLinks
}
class HasDetail s a | s -> a where
- detail :: Lens' s a
class HasField s a | s -> a where
- field :: Lens' s a
class HasTitle s a | s -> a where
- title :: Lens' s a
data PaymentMethod
- = Bancontact
- | Banktransfer
- | Belfius
- | Bitcoin
- | Creditcard
- | Directdebit
- | Eps
- | Giftcard
- | Giropay
- | Ideal
- | Inghomepay
- | Kbc
- | Paypal
- | Paysafecard
- | Sofort
- | NewPaymentMethod Text
data ResponseError
- = ClientError Int Error
- | ServerError Int
- | UnexpectedResponse Text
data Chargeback = Chargeback {
- _chargebackId :: ChargebackId
- _chargebackAmount :: Amount
- _chargebackSettlementAmount :: Maybe Amount
- _chargebackCreatedAt :: UTCTime
- _chargebackReversedAt :: Maybe UTCTime
- _chargebackPaymentId :: PaymentId
}
class HasAmount s a | s -> a where
- amount :: Lens' s a
class HasCreatedAt s a | s -> a where
- createdAt :: Lens' s a
class HasId s a | s -> a where
- id :: Lens' s a
class HasPaymentId s a | s -> a where
- paymentId :: Lens' s a
class HasReversedAt s a | s -> a where
- reversedAt :: Lens' s a
class HasSettlementAmount s a | s -> a where
- settlementAmount :: Lens' s a
data NewCustomer = NewCustomer {
- _newCustomerName :: Maybe Text
- _newCustomerEmail :: Maybe Text
- _newCustomerLocale :: Maybe Text
- _newCustomerMetadata :: Maybe Value
}
class HasEmail s a | s -> a where
- email :: Lens' s a
class HasLocale s a | s -> a where
- locale :: Lens' s a
class HasMetadata s a | s -> a where
- metadata :: Lens' s a
class HasName s a | s -> a where
- name :: Lens' s a
data Customer = Customer {
- _customerId :: CustomerId
- _customerMode :: Mode
- _customerName :: Maybe Text
- _customerEmail :: Maybe Text
- _customerLocale :: Maybe Text
- _customerMetadata :: Maybe Value
- _customerRecentlyUsedMethods :: [PaymentMethod]
- _customerCreatedAt :: UTCTime
}
class HasMode s a | s -> a where
- mode :: Lens' s a
class HasRecentlyUsedMethods s a | s -> a where
- recentlyUsedMethods :: Lens' s a
data NewMandate = NewMandate {
- _newMandateMethod :: PaymentMethod
- _newMandateConsumerName :: Text
- _newMandateConsumerAccount :: Text
- _newMandateConsumerBic :: Maybe Text
- _newMandateSignatureDate :: Maybe Text
- _newMandateMandateReference :: Maybe Text
}
class HasConsumerAccount s a | s -> a where
- consumerAccount :: Lens' s a
class HasConsumerBic s a | s -> a where
- consumerBic :: Lens' s a
class HasConsumerName s a | s -> a where
- consumerName :: Lens' s a
class HasMandateReference s a | s -> a where
- mandateReference :: Lens' s a
class HasMethod s a | s -> a where
- method :: Lens' s a
class HasSignatureDate s a | s -> a where
- signatureDate :: Lens' s a
data MandateStatus
- = MandatePending
- | MandateValid
- | MandateInvalid
data MandateDetails = MandateDetails {
- _mandateDetailsConsumerName :: Maybe Text
- _mandateDetailsConsumerAccount :: Maybe Text
- _mandateDetailsConsumerBic :: Maybe Text
- _mandateDetailsCardHolder :: Maybe Text
- _mandateDetailsCardNumber :: Maybe Text
- _mandateDetailsCardLabel :: Maybe Text
- _mandateDetailsCardFingerprint :: Maybe Text
- _mandateDetailsCardExpiryDate :: Maybe Text
}
class HasCardExpiryDate s a | s -> a where
- cardExpiryDate :: Lens' s a
class HasCardFingerprint s a | s -> a where
- cardFingerprint :: Lens' s a
class HasCardHolder s a | s -> a where
- cardHolder :: Lens' s a
class HasCardLabel s a | s -> a where
- cardLabel :: Lens' s a
class HasCardNumber s a | s -> a where
- cardNumber :: Lens' s a
data Mandate = Mandate {
- _mandateId :: MandateId
- _mandateStatus :: MandateStatus
- _mandateMethod :: PaymentMethod
- _mandateDetails :: Maybe MandateDetails
- _mandateMandateReference :: Maybe Text
- _mandateSignatureDate :: Maybe Text
- _mandateCreatedAt :: UTCTime
}
class HasDetails s a | s -> a where
- details :: Lens' s a
class HasStatus s a | s -> a where
- status :: Lens' s a
data MethodImage = MethodImage {
- _methodImageSize1x :: Text
- _methodImageSize2x :: Text
- _methodImageSvg :: Text
}
class HasSize1x s a | s -> a where
- size1x :: Lens' s a
class HasSize2x s a | s -> a where
- size2x :: Lens' s a
class HasSvg s a | s -> a where
- svg :: Lens' s a
data Method = Method {
- _methodId :: PaymentMethod
- _methodDescription :: Text
- _methodImage :: MethodImage
}
class HasDescription s a | s -> a where
- description :: Lens' s a
class HasImage s a | s -> a where
- image :: Lens' s a
data PaymentStatus
- = PaymentOpen
- | PaymentCanceled
- | PaymentPending
- | PaymentExpired
- | PaymentFailed
- | PaymentPaid
data SequenceType
- = First
- | Recurring
- | Oneoff
data NewPayment = NewPayment {
- _newPaymentAmount :: Amount
- _newPaymentDescription :: Text
- _newPaymentRedirectUrl :: Maybe Text
- _newPaymentWebhookUrl :: Maybe Text
- _newPaymentMethod :: Maybe PaymentMethod
- _newPaymentMetadata :: Maybe Value
- _newPaymentLocale :: Maybe Text
- _newPaymentSequenceType :: Maybe SequenceType
- _newPaymentCustomerId :: Maybe CustomerId
- _newPaymentMandateId :: Maybe MandateId
- _newPaymentIssuer :: Maybe Text
- _newPaymentBillingAddress :: Maybe Address
- _newPaymentShippingAddress :: Maybe Address
- _newPaymentBillingEmail :: Maybe Text
- _newPaymentDueDate :: Maybe Text
- _newPaymentConsumerName :: Maybe Text
- _newPaymentConsumerAccount :: Maybe Text
- _newPaymentCustomerReference :: Maybe Text
}
class HasBillingAddress s a | s -> a where
- billingAddress :: Lens' s a
class HasBillingEmail s a | s -> a where
- billingEmail :: Lens' s a
class HasCustomerId s a | s -> a where
- customerId :: Lens' s a
class HasCustomerReference s a | s -> a where
- customerReference :: Lens' s a
class HasDueDate s a | s -> a where
- dueDate :: Lens' s a
class HasIssuer s a | s -> a where
- issuer :: Lens' s a
class HasMandateId s a | s -> a where
- mandateId :: Lens' s a
class HasRedirectUrl s a | s -> a where
- redirectUrl :: Lens' s a
class HasSequenceType s a | s -> a where
- sequenceType :: Lens' s a
class HasShippingAddress s a | s -> a where
- shippingAddress :: Lens' s a
class HasWebhookUrl s a | s -> a where
- webhookUrl :: Lens' s a
data Payment = Payment {
- _paymentId :: PaymentId
- _paymentMode :: Mode
- _paymentCreatedAt :: UTCTime
- _paymentStatus :: PaymentStatus
- _paymentIsCancelable :: Bool
- _paymentPaidAt :: Maybe UTCTime
- _paymentCanceledAt :: Maybe UTCTime
- _paymentExpiredAt :: Maybe UTCTime
- _paymentFailedAt :: Maybe UTCTime
- _paymentAmount :: Amount
- _paymentAmountRefunded :: Maybe Amount
- _paymentAmountRemaining :: Maybe Amount
- _paymentDescription :: Text
- _paymentRedirectUrl :: Maybe Text
- _paymentMollieUrl :: Maybe Text
- _paymentWebhookUrl :: Maybe Text
- _paymentMethod :: Maybe PaymentMethod
- _paymentMetadata :: Maybe Value
- _paymentLocale :: Maybe Text
- _paymentCountryCode :: Maybe Text
- _paymentProfileId :: Text
- _paymentSettlementAmount :: Maybe Amount
- _paymentSettlementId :: Maybe Text
- _paymentCustomerId :: Maybe CustomerId
- _paymentSequenceType :: Maybe SequenceType
- _paymentMandateId :: Maybe MandateId
- _paymentSubscriptionId :: Maybe SubscriptionId
- _paymentDetails :: Maybe Object
}
class HasAmountRefunded s a | s -> a where
- amountRefunded :: Lens' s a
class HasAmountRemaining s a | s -> a where
- amountRemaining :: Lens' s a
class HasCanceledAt s a | s -> a where
- canceledAt :: Lens' s a
class HasCountryCode s a | s -> a where
- countryCode :: Lens' s a
class HasExpiredAt s a | s -> a where
- expiredAt :: Lens' s a
class HasFailedAt s a | s -> a where
- failedAt :: Lens' s a
class HasIsCancelable s a | s -> a where
- isCancelable :: Lens' s a
class HasMollieUrl s a | s -> a where
- mollieUrl :: Lens' s a
class HasPaidAt s a | s -> a where
- paidAt :: Lens' s a
class HasProfileId s a | s -> a where
- profileId :: Lens' s a
class HasSettlementId s a | s -> a where
- settlementId :: Lens' s a
class HasSubscriptionId s a | s -> a where
- subscriptionId :: Lens' s a
data NewRefund = NewRefund {
- _newRefundAmount :: Maybe Amount
- _newRefundDescription :: Maybe Text
}
data RefundStatus
- = RefundQueued
- | RefundPending
- | RefundProcessing
- | RefundRefunded
- | RefundFailed
data Refund = Refund {
- _refundId :: Text
- _refundAmount :: Amount
- _refundSettlementAmount :: Maybe Amount
- _refundDescription :: Text
- _refundStatus :: RefundStatus
- _refundPaymentId :: PaymentId
- _refundCreatedAt :: UTCTime
}
data NewSubscription = NewSubscription {
- _newSubscriptionAmount :: Amount
- _newSubscriptionTimes :: Maybe Int
- _newSubscriptionInterval :: Text
- _newSubscriptionStartDate :: Maybe Text
- _newSubscriptionDescription :: Text
- _newSubscriptionMethod :: Maybe PaymentMethod
- _newSubscriptionWebhookUrl :: Maybe Text
}
class HasInterval s a | s -> a where
- interval :: Lens' s a
class HasStartDate s a | s -> a where
- startDate :: Lens' s a
class HasTimes s a | s -> a where
- times :: Lens' s a
data SubscriptionStatus
- = SubscriptionPending
- | SubscriptionActive
- | SubscriptionCancelled
- | SubscriptionSuspended
- | SubscriptionCompleted
data Subscription = Subscription {
- _subscriptionId :: Text
- _subscriptionMode :: Mode
- _subscriptionCreatedAt :: UTCTime
- _subscriptionStatus :: SubscriptionStatus
- _subscriptionAmount :: Amount
- _subscriptionTimes :: Maybe Int
- _subscriptionInterval :: Text
- _subscriptionStartDate :: Maybe Text
- _subscriptionDescription :: Text
- _subscriptionMethod :: Maybe PaymentMethod
- _subscriptionCanceledAt :: Maybe UTCTime
- _subscriptionWebhookUrl :: Maybe Text
}

Documentation

type MollieServantAPI = "v2" :> ToServantApi MollieAPI Source #

The fully combined Mollie API definition of Haskell.

data MollieAPI route Source #

All v2 endpoints of Mollie API.

Instances

Generic (MollieAPI route) Source #
Instance details Defined in Mollie.API Associated Types type Rep (MollieAPI route) :: Type -> Type # Methods from :: MollieAPI route -> Rep (MollieAPI route) x # to :: Rep (MollieAPI route) x -> MollieAPI route #
type Rep (MollieAPI route) Source #
Instance details Defined in Mollie.API type Rep (MollieAPI route) = D1 (MetaData "MollieAPI" "Mollie.API" "mollie-api-haskell-2.0.0.0-79op8QUDPdyAagRpBQOely" False) (C1 (MetaCons "MollieAPI" PrefixI True) ((S1 (MetaSel (Just "customerAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi CustomerAPI)) :: (S1 (MetaSel (Just "chargebackAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi ChargebackAPI)) :: S1 (MetaSel (Just "methodAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi MethodAPI)))) :: ((S1 (MetaSel (Just "mandateAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi MandateAPI)) :: S1 (MetaSel (Just "paymentAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi PaymentAPI))) :: (S1 (MetaSel (Just "refundAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi RefundAPI)) :: S1 (MetaSel (Just "subscriptionAPI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- ToServantApi SubscriptionAPI))))))

data HalJSON Source #

Mollie returns all API calls with "Content-Type: application/hal+json"

Instances

Accept HalJSON Source #
Instance details Defined in Mollie.API.Internal Methods contentType :: Proxy HalJSON -> MediaType # contentTypes :: Proxy HalJSON -> NonEmpty MediaType #
ToJSON a => MimeRender HalJSON a Source #
Instance details Defined in Mollie.API.Internal Methods mimeRender :: Proxy HalJSON -> a -> ByteString #
FromJSON a => MimeUnrender HalJSON a Source #
Instance details Defined in Mollie.API.Internal Methods mimeUnrender :: Proxy HalJSON -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy HalJSON -> MediaType -> ByteString -> Either String a #

chargebackClient :: ChargebackAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Chargeback API. Usage:

import Mollie.API
import Mollie.API.Chargebacks

env <- createEnv "test_mollieapikeyexample"
let chargebacksResult = runMollie env (getChargebacks chargebackClient)

customerClient :: CustomerAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Customer API. Usage:

import Mollie.API
import Mollie.API.Customers

env <- createEnv "test_mollieapikeyexample"
let customersResult = runMollie env (getCustomers customerClient)

mandateClient :: MandateAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Mandate API. Usage:

import Mollie.API
import Mollie.API.Mandates

env <- createEnv "test_mollieapikeyexample"
let mandatesResult = runMollie env ((getCustomerMandates mandateClient) "cst_eaaEuAnqW")

methodClient :: MethodAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Method API. Usage:

import Mollie.API
import Mollie.API.Methods

env <- createEnv "test_mollieapikeyexample"
let methodsResult = runMollie env (getMethods methodClient)

paymentClient :: PaymentAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Payments API. Usage:

import Mollie.API
import Mollie.API.Payments

env <- createEnv "test_mollieapikeyexample"
let paymentsResult = runMollie env (getPayments paymentClient)

refundClient :: RefundAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Refunds API. Usage:

import Mollie.API
import Mollie.API.Refunds

env <- createEnv "test_mollieapikeyexample"
let refundsResult = runMollie env (getRefunds refundClient)

subscriptionClient :: SubscriptionAPI (AsClientT ClientM) Source #

Record that holds the endpoints for the Subscriptions API. Usage:

import Mollie.API
import Mollie.API.Subscriptions

env <- createEnv "test_mollieapikeyexample"
let subscriptionsResult = runMollie env ((getCustomerSubscriptions refundClient) "cst_eaaEuAnqW")

createEnv Source #

Arguments

:: String	mollieApiKey
-> IO ClientEnv

Setup the environment for executing API calls

runMollie :: ClientEnv -> ClientM a -> IO (Either ResponseError a) Source #

Execute an API call to the Mollie API. Uses Servant under the hood.

class ToText a where Source #

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

Methods

toText :: a -> Text Source #

Instances

ToText Mode Source #
Instance details Defined in Mollie.API.Types Methods toText :: Mode -> Text Source #
ToText PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toText :: PaymentMethod -> Text Source #
ToText MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: MandateStatus -> Text Source #
ToText PaymentStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: PaymentStatus -> Text Source #
ToText SequenceType Source #
Instance details Defined in Mollie.API.Types Methods toText :: SequenceType -> Text Source #
ToText RefundStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: RefundStatus -> Text Source #
ToText SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: SubscriptionStatus -> Text Source #

type CustomerId = Text Source #

type PaymentId = Text Source #

type RefundId = Text Source #

type SubscriptionId = Text Source #

type ChargebackId = Text Source #

type MandateId = Text Source #

data Amount Source #

In v2 endpoints, an amount object is always represented as follows:

For more information see: https://docs.mollie.com/guides/common-data-types#amount-object

Constructors

Amount
Fields _amountCurrency :: Alpha An ISO 4217 currency code. The currencies supported depend on the payment methods that are enabled on your account. _amountValue :: Text A string containing the exact amount you want to charge in the given currency. Make sure to send the right amount of decimals

Instances

Eq Amount Source #
Instance details Defined in Mollie.API.Types Methods (==) :: Amount -> Amount -> Bool # (/=) :: Amount -> Amount -> Bool #
Show Amount Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Amount -> ShowS # show :: Amount -> String # showList :: [Amount] -> ShowS #
ToJSON Amount Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: Amount -> Value # toEncoding :: Amount -> Encoding # toJSONList :: [Amount] -> Value # toEncodingList :: [Amount] -> Encoding #
FromJSON Amount Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Amount # parseJSONList :: Value -> Parser [Amount] #
Default Amount Source #
Instance details Defined in Mollie.API.Types Methods def :: Amount #
HasValue Amount Text Source #
Instance details Defined in Mollie.API.Types Methods value :: Lens' Amount Text Source #
HasCurrency Amount Alpha Source #
Instance details Defined in Mollie.API.Types Methods currency :: Lens' Amount Alpha Source #
HasAmount Chargeback Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Chargeback Amount Source #
HasAmount NewPayment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewPayment Amount Source #
HasAmount Payment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Payment Amount Source #
HasAmount Refund Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Refund Amount Source #
HasAmount NewSubscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewSubscription Amount Source #
HasAmount Subscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Subscription Amount Source #
HasSettlementAmount Chargeback (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Chargeback (Maybe Amount) Source #
HasSettlementAmount Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Payment (Maybe Amount) Source #
HasSettlementAmount Refund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Refund (Maybe Amount) Source #
HasAmount NewRefund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewRefund (Maybe Amount) Source #
HasAmountRemaining Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRemaining :: Lens' Payment (Maybe Amount) Source #
HasAmountRefunded Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRefunded :: Lens' Payment (Maybe Amount) Source #

defaultAmount :: Double -> Amount Source #

Creates a Mollie amount given a Double

class HasCurrency s a | s -> a where Source #

Methods

currency :: Lens' s a Source #

Instances

HasCurrency Amount Alpha Source #
Instance details Defined in Mollie.API.Types Methods currency :: Lens' Amount Alpha Source #

class HasValue s a | s -> a where Source #

Methods

value :: Lens' s a Source #

Instances

HasValue Amount Text Source #
Instance details Defined in Mollie.API.Types Methods value :: Lens' Amount Text Source #

data Address Source #

Constructors

Address

Fields

_addressStreetAndNumber :: Text
The card holder’s street and street number
_addressStreetAdditional :: Maybe Text
_addressPostalCode :: Text
The card holder’s postal code
_addressCity :: Text
The card holder’s city
_addressRegion :: Maybe Text
The card holder’s region. Sometimes required for Paypal payments.
_addressCountry :: Text
The card holder’s country in ISO 3166-1 alpha-2 format

Instances

Show Address Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
ToJSON Address Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: Address -> Value # toEncoding :: Address -> Encoding # toJSONList :: [Address] -> Value # toEncodingList :: [Address] -> Encoding #
FromJSON Address Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Address # parseJSONList :: Value -> Parser [Address] #
Default Address Source #
Instance details Defined in Mollie.API.Types Methods def :: Address #
HasStreetAndNumber Address Text Source #
Instance details Defined in Mollie.API.Types Methods streetAndNumber :: Lens' Address Text Source #
HasPostalCode Address Text Source #
Instance details Defined in Mollie.API.Types Methods postalCode :: Lens' Address Text Source #
HasCountry Address Text Source #
Instance details Defined in Mollie.API.Types Methods country :: Lens' Address Text Source #
HasCity Address Text Source #
Instance details Defined in Mollie.API.Types Methods city :: Lens' Address Text Source #
HasStreetAdditional Address (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods streetAdditional :: Lens' Address (Maybe Text) Source #
HasRegion Address (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods region :: Lens' Address (Maybe Text) Source #
HasShippingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods shippingAddress :: Lens' NewPayment (Maybe Address) Source #
HasBillingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods billingAddress :: Lens' NewPayment (Maybe Address) Source #

class HasCity s a | s -> a where Source #

Methods

city :: Lens' s a Source #

Instances

HasCity Address Text Source #
Instance details Defined in Mollie.API.Types Methods city :: Lens' Address Text Source #

class HasCountry s a | s -> a where Source #

Methods

country :: Lens' s a Source #

Instances

HasCountry Address Text Source #
Instance details Defined in Mollie.API.Types Methods country :: Lens' Address Text Source #

class HasPostalCode s a | s -> a where Source #

Methods

postalCode :: Lens' s a Source #

Instances

HasPostalCode Address Text Source #
Instance details Defined in Mollie.API.Types Methods postalCode :: Lens' Address Text Source #

class HasRegion s a | s -> a where Source #

Methods

region :: Lens' s a Source #

Instances

HasRegion Address (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods region :: Lens' Address (Maybe Text) Source #

class HasStreetAdditional s a | s -> a where Source #

Methods

streetAdditional :: Lens' s a Source #

Instances

HasStreetAdditional Address (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods streetAdditional :: Lens' Address (Maybe Text) Source #

class HasStreetAndNumber s a | s -> a where Source #

Methods

streetAndNumber :: Lens' s a Source #

Instances

HasStreetAndNumber Address Text Source #
Instance details Defined in Mollie.API.Types Methods streetAndNumber :: Lens' Address Text Source #

data Link Source #

Constructors

Link
Fields _linkHref :: Text

Instances

Show Link Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Link -> ShowS # show :: Link -> String # showList :: [Link] -> ShowS #
FromJSON Link Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Link # parseJSONList :: Value -> Parser [Link] #
HasHref Link Text Source #
Instance details Defined in Mollie.API.Types Methods href :: Lens' Link Text Source #
HasSelf ListLinks Link Source #
Instance details Defined in Mollie.API.Types Methods self :: Lens' ListLinks Link Source #
HasDocumentation ErrorLinks Link Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ErrorLinks Link Source #
HasPrevious ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods previous :: Lens' ListLinks (Maybe Link) Source #
HasNext ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods next :: Lens' ListLinks (Maybe Link) Source #
HasDocumentation ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ListLinks (Maybe Link) Source #

class HasHref s a | s -> a where Source #

Methods

href :: Lens' s a Source #

Instances

HasHref Link Text Source #
Instance details Defined in Mollie.API.Types Methods href :: Lens' Link Text Source #

data Mode Source #

All available API modes.

Constructors

Live
Test

Instances

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

data ListLinks Source #

Important links associated with List responses.

Constructors

ListLinks
Fields _listLinksSelf :: Link The URL to the current set of objects.. _listLinksNext :: Maybe Link The previous set of objects, if available. _listLinksPrevious :: Maybe Link The next set of objects, if available. _listLinksDocumentation :: Maybe Link URL to the documentation of the current endpoint.

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] #
HasSelf ListLinks Link Source #
Instance details Defined in Mollie.API.Types Methods self :: Lens' ListLinks Link Source #
HasPrevious ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods previous :: Lens' ListLinks (Maybe Link) Source #
HasNext ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods next :: Lens' ListLinks (Maybe Link) Source #
HasDocumentation ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ListLinks (Maybe Link) Source #
HasLinks (List a) ListLinks Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' (List a) ListLinks Source #

class HasDocumentation s a | s -> a where Source #

Methods

documentation :: Lens' s a Source #

Instances

HasDocumentation ErrorLinks Link Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ErrorLinks Link Source #
HasDocumentation ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ListLinks (Maybe Link) Source #

class HasNext s a | s -> a where Source #

Methods

next :: Lens' s a Source #

Instances

HasNext ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods next :: Lens' ListLinks (Maybe Link) Source #

class HasPrevious s a | s -> a where Source #

Methods

previous :: Lens' s a Source #

Instances

HasPrevious ListLinks (Maybe Link) Source #
Instance details Defined in Mollie.API.Types Methods previous :: Lens' ListLinks (Maybe Link) Source #

class HasSelf s a | s -> a where Source #

Methods

self :: Lens' s a Source #

Instances

HasSelf ListLinks Link Source #
Instance details Defined in Mollie.API.Types Methods self :: Lens' ListLinks Link Source #

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 _listCount :: Int The number of objects found in `_embedded`, which is either the requested number (with a maximum of 250) or the default number. _listEmbedded :: [a] The actual data you’re looking for. _listLinks :: ListLinks Links to help navigate through the lists of objects.

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] #
HasLinks (List a) ListLinks Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' (List a) ListLinks Source #
HasCount (List a) Int Source #
Instance details Defined in Mollie.API.Types Methods count :: Lens' (List a) Int Source #
HasEmbedded (List a) [a] Source #
Instance details Defined in Mollie.API.Types Methods embedded :: Lens' (List a) [a] Source #

class HasCount s a | s -> a where Source #

Methods

count :: Lens' s a Source #

Instances

HasCount (List a) Int Source #
Instance details Defined in Mollie.API.Types Methods count :: Lens' (List a) Int Source #

class HasEmbedded s a | s -> a where Source #

Methods

embedded :: Lens' s a Source #

Instances

HasEmbedded (List a) [a] Source #
Instance details Defined in Mollie.API.Types Methods embedded :: Lens' (List a) [a] Source #

class HasLinks s a | s -> a where Source #

Methods

links :: Lens' s a Source #

Instances

HasLinks Error (Maybe ErrorLinks) Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' Error (Maybe ErrorLinks) Source #
HasLinks (List a) ListLinks Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' (List a) ListLinks Source #

data ErrorLinks Source #

Error data representations.

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

Constructors

ErrorLinks
Fields _errorLinksDocumentation :: Link

Instances

Show ErrorLinks Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> ErrorLinks -> ShowS # show :: ErrorLinks -> String # showList :: [ErrorLinks] -> ShowS #
FromJSON ErrorLinks Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser ErrorLinks # parseJSONList :: Value -> Parser [ErrorLinks] #
HasDocumentation ErrorLinks Link Source #
Instance details Defined in Mollie.API.Types Methods documentation :: Lens' ErrorLinks Link Source #
HasLinks Error (Maybe ErrorLinks) Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' Error (Maybe ErrorLinks) Source #

data Error Source #

Constructors

Error
Fields _errorTitle :: Text _errorDetail :: Text _errorField :: Maybe Text _errorLinks :: Maybe ErrorLinks

Instances

Show Error Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
FromJSON Error Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Error # parseJSONList :: Value -> Parser [Error] #
HasTitle Error Text Source #
Instance details Defined in Mollie.API.Types Methods title :: Lens' Error Text Source #
HasDetail Error Text Source #
Instance details Defined in Mollie.API.Types Methods detail :: Lens' Error Text Source #
HasLinks Error (Maybe ErrorLinks) Source #
Instance details Defined in Mollie.API.Types Methods links :: Lens' Error (Maybe ErrorLinks) Source #
HasField Error (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods field :: Lens' Error (Maybe Text) Source #

class HasDetail s a | s -> a where Source #

Methods

detail :: Lens' s a Source #

Instances

HasDetail Error Text Source #
Instance details Defined in Mollie.API.Types Methods detail :: Lens' Error Text Source #

class HasField s a | s -> a where Source #

Methods

field :: Lens' s a Source #

Instances

HasField Error (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods field :: Lens' Error (Maybe Text) Source #

class HasTitle s a | s -> a where Source #

Methods

title :: Lens' s a Source #

Instances

HasTitle Error Text Source #
Instance details Defined in Mollie.API.Types Methods title :: Lens' Error Text Source #

data PaymentMethod Source #

All possible payment methods.

Constructors

Bancontact
Banktransfer
Belfius
Bitcoin
Creditcard
Directdebit
Eps
Giftcard
Giropay
Ideal
Inghomepay
Kbc
Paypal
Paysafecard
Sofort
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] #
ToHttpApiData PaymentMethod Source #
Instance details Defined in Mollie.API.Internal Methods toUrlPiece :: PaymentMethod -> Text # toEncodedUrlPiece :: PaymentMethod -> Builder # toHeader :: PaymentMethod -> ByteString # toQueryParam :: PaymentMethod -> Text #
ToText PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toText :: PaymentMethod -> Text Source #
HasId Method PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Method PaymentMethod Source #
HasMethod NewMandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewMandate PaymentMethod Source #
HasMethod Mandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Mandate PaymentMethod Source #
HasRecentlyUsedMethods Customer [PaymentMethod] Source #
Instance details Defined in Mollie.API.Types Methods recentlyUsedMethods :: Lens' Customer [PaymentMethod] Source #
HasMethod NewPayment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewPayment (Maybe PaymentMethod) Source #
HasMethod Payment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Payment (Maybe PaymentMethod) Source #
HasMethod NewSubscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewSubscription (Maybe PaymentMethod) Source #
HasMethod Subscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Subscription (Maybe PaymentMethod) Source #

data ResponseError Source #

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error
ServerError Int
UnexpectedResponse Text

Instances

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

data Chargeback Source #

Constructors

Chargeback

Fields

_chargebackId :: ChargebackId
Mollies reference to the chargeback.
_chargebackAmount :: Amount
The amount charged back by the consumer.
_chargebackSettlementAmount :: Maybe Amount
The amount that will be deducted from your account
_chargebackCreatedAt :: UTCTime
The date and time the chargeback was issued.
_chargebackReversedAt :: Maybe UTCTime
The date and time the chargeback was reversed.
_chargebackPaymentId :: PaymentId
The unique identifier of the payment this chargeback was issued for.

Instances

FromJSON Chargeback Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Chargeback # parseJSONList :: Value -> Parser [Chargeback] #
HasPaymentId Chargeback PaymentId Source #
Instance details Defined in Mollie.API.Types Methods paymentId :: Lens' Chargeback PaymentId Source #
HasId Chargeback ChargebackId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Chargeback ChargebackId Source #
HasCreatedAt Chargeback UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Chargeback UTCTime Source #
HasAmount Chargeback Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Chargeback Amount Source #
HasSettlementAmount Chargeback (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Chargeback (Maybe Amount) Source #
HasReversedAt Chargeback (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods reversedAt :: Lens' Chargeback (Maybe UTCTime) Source #

class HasAmount s a | s -> a where Source #

Methods

amount :: Lens' s a Source #

Instances

HasAmount Chargeback Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Chargeback Amount Source #
HasAmount NewPayment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewPayment Amount Source #
HasAmount Payment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Payment Amount Source #
HasAmount Refund Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Refund Amount Source #
HasAmount NewSubscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewSubscription Amount Source #
HasAmount Subscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Subscription Amount Source #
HasAmount NewRefund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewRefund (Maybe Amount) Source #

class HasCreatedAt s a | s -> a where Source #

Methods

createdAt :: Lens' s a Source #

Instances

HasCreatedAt Chargeback UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Chargeback UTCTime Source #
HasCreatedAt Customer UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Customer UTCTime Source #
HasCreatedAt Mandate UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Mandate UTCTime Source #
HasCreatedAt Payment UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Payment UTCTime Source #
HasCreatedAt Refund UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Refund UTCTime Source #
HasCreatedAt Subscription UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Subscription UTCTime Source #

class HasId s a | s -> a where Source #

Methods

id :: Lens' s a Source #

Instances

HasId Chargeback ChargebackId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Chargeback ChargebackId Source #
HasId Customer CustomerId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Customer CustomerId Source #
HasId Mandate MandateId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Mandate MandateId Source #
HasId Method PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Method PaymentMethod Source #
HasId Payment PaymentId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Payment PaymentId Source #
HasId Refund Text Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Refund Text Source #
HasId Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Subscription Text Source #

class HasPaymentId s a | s -> a where Source #

Methods

paymentId :: Lens' s a Source #

Instances

HasPaymentId Chargeback PaymentId Source #
Instance details Defined in Mollie.API.Types Methods paymentId :: Lens' Chargeback PaymentId Source #
HasPaymentId Refund PaymentId Source #
Instance details Defined in Mollie.API.Types Methods paymentId :: Lens' Refund PaymentId Source #

class HasReversedAt s a | s -> a where Source #

Methods

reversedAt :: Lens' s a Source #

Instances

HasReversedAt Chargeback (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods reversedAt :: Lens' Chargeback (Maybe UTCTime) Source #

class HasSettlementAmount s a | s -> a where Source #

Methods

settlementAmount :: Lens' s a Source #

Instances

HasSettlementAmount Chargeback (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Chargeback (Maybe Amount) Source #
HasSettlementAmount Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Payment (Maybe Amount) Source #
HasSettlementAmount Refund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Refund (Maybe Amount) Source #

data NewCustomer Source #

Structure to request a new customer with.

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

Constructors

NewCustomer
Fields _newCustomerName :: Maybe Text Set the full name of the customer. _newCustomerEmail :: Maybe Text Set the email address. _newCustomerLocale :: Maybe Text Set the language to use for this customer during checkout, _newCustomerMetadata :: Maybe Value Set any additional data in JSON format.

Instances

Show NewCustomer Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewCustomer -> ShowS # show :: NewCustomer -> String # showList :: [NewCustomer] -> ShowS #
ToJSON NewCustomer Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewCustomer -> Value # toEncoding :: NewCustomer -> Encoding # toJSONList :: [NewCustomer] -> Value # toEncodingList :: [NewCustomer] -> Encoding #
Default NewCustomer Source #
Instance details Defined in Mollie.API.Types Methods def :: NewCustomer #
HasName NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods name :: Lens' NewCustomer (Maybe Text) Source #
HasMetadata NewCustomer (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' NewCustomer (Maybe Value) Source #
HasLocale NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' NewCustomer (Maybe Text) Source #
HasEmail NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods email :: Lens' NewCustomer (Maybe Text) Source #

class HasEmail s a | s -> a where Source #

Methods

email :: Lens' s a Source #

Instances

HasEmail NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods email :: Lens' NewCustomer (Maybe Text) Source #
HasEmail Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods email :: Lens' Customer (Maybe Text) Source #

class HasLocale s a | s -> a where Source #

Methods

locale :: Lens' s a Source #

Instances

HasLocale NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' NewCustomer (Maybe Text) Source #
HasLocale Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' Customer (Maybe Text) Source #
HasLocale NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' NewPayment (Maybe Text) Source #
HasLocale Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' Payment (Maybe Text) Source #

class HasMetadata s a | s -> a where Source #

Methods

metadata :: Lens' s a Source #

Instances

HasMetadata NewCustomer (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' NewCustomer (Maybe Value) Source #
HasMetadata Customer (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' Customer (Maybe Value) Source #
HasMetadata NewPayment (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' NewPayment (Maybe Value) Source #
HasMetadata Payment (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' Payment (Maybe Value) Source #

class HasName s a | s -> a where Source #

Methods

name :: Lens' s a Source #

Instances

HasName NewCustomer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods name :: Lens' NewCustomer (Maybe Text) Source #
HasName Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods name :: Lens' Customer (Maybe Text) Source #

data Customer Source #

Representation of an customer available at Mollie.

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

Constructors

Customer

Fields

_customerId :: CustomerId
Mollies reference to the customer.
_customerMode :: Mode
The mode in which this customer was created.
_customerName :: Maybe Text
The customers full name.
_customerEmail :: Maybe Text
The cusomters email address.
_customerLocale :: Maybe Text
The locale used for this customer during checkout.
_customerMetadata :: Maybe Value
Custom privided data for this customer.
_customerRecentlyUsedMethods :: [PaymentMethod]
The payment methods this customer recently used.
_customerCreatedAt :: UTCTime
The creation date of this customer.

Instances

Show Customer Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Customer -> ShowS # show :: Customer -> String # showList :: [Customer] -> ShowS #
FromJSON Customer Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Customer # parseJSONList :: Value -> Parser [Customer] #
HasId Customer CustomerId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Customer CustomerId Source #
HasCreatedAt Customer UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Customer UTCTime Source #
HasMode Customer Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Customer Mode Source #
HasName Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods name :: Lens' Customer (Maybe Text) Source #
HasMetadata Customer (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' Customer (Maybe Value) Source #
HasLocale Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' Customer (Maybe Text) Source #
HasEmail Customer (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods email :: Lens' Customer (Maybe Text) Source #
HasRecentlyUsedMethods Customer [PaymentMethod] Source #
Instance details Defined in Mollie.API.Types Methods recentlyUsedMethods :: Lens' Customer [PaymentMethod] Source #

class HasMode s a | s -> a where Source #

Methods

mode :: Lens' s a Source #

Instances

HasMode Customer Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Customer Mode Source #
HasMode Payment Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Payment Mode Source #
HasMode Subscription Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Subscription Mode Source #

class HasRecentlyUsedMethods s a | s -> a where Source #

Methods

recentlyUsedMethods :: Lens' s a Source #

Instances

HasRecentlyUsedMethods Customer [PaymentMethod] Source #
Instance details Defined in Mollie.API.Types Methods recentlyUsedMethods :: Lens' Customer [PaymentMethod] 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

_newMandateMethod :: PaymentMethod
Set the payment method of the mandate. Currently only directdebit is supported.
_newMandateConsumerName :: Text
Set the consumer's name.
_newMandateConsumerAccount :: Text
Set the consumer's IBAN.
_newMandateConsumerBic :: Maybe Text
Set the consumer's bank BIC/SWIFT code.
_newMandateSignatureDate :: Maybe Text
Set the date the mandate was signed in `YYYY-MM-DD` format.
_newMandateMandateReference :: 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 #
Default NewMandate Source #
Instance details Defined in Mollie.API.Types Methods def :: NewMandate #
HasMethod NewMandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewMandate PaymentMethod Source #
HasConsumerName NewMandate Text Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' NewMandate Text Source #
HasConsumerAccount NewMandate Text Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' NewMandate Text Source #
HasSignatureDate NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods signatureDate :: Lens' NewMandate (Maybe Text) Source #
HasMandateReference NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mandateReference :: Lens' NewMandate (Maybe Text) Source #
HasConsumerBic NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerBic :: Lens' NewMandate (Maybe Text) Source #

class HasConsumerAccount s a | s -> a where Source #

Methods

consumerAccount :: Lens' s a Source #

Instances

HasConsumerAccount NewMandate Text Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' NewMandate Text Source #
HasConsumerAccount MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' MandateDetails (Maybe Text) Source #
HasConsumerAccount NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' NewPayment (Maybe Text) Source #

class HasConsumerBic s a | s -> a where Source #

Methods

consumerBic :: Lens' s a Source #

Instances

HasConsumerBic NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerBic :: Lens' NewMandate (Maybe Text) Source #
HasConsumerBic MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerBic :: Lens' MandateDetails (Maybe Text) Source #

class HasConsumerName s a | s -> a where Source #

Methods

consumerName :: Lens' s a Source #

Instances

HasConsumerName NewMandate Text Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' NewMandate Text Source #
HasConsumerName MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' MandateDetails (Maybe Text) Source #
HasConsumerName NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' NewPayment (Maybe Text) Source #

class HasMandateReference s a | s -> a where Source #

Methods

mandateReference :: Lens' s a Source #

Instances

HasMandateReference NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mandateReference :: Lens' NewMandate (Maybe Text) Source #
HasMandateReference Mandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mandateReference :: Lens' Mandate (Maybe Text) Source #

class HasMethod s a | s -> a where Source #

Methods

method :: Lens' s a Source #

Instances

HasMethod NewMandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewMandate PaymentMethod Source #
HasMethod Mandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Mandate PaymentMethod Source #
HasMethod NewPayment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewPayment (Maybe PaymentMethod) Source #
HasMethod Payment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Payment (Maybe PaymentMethod) Source #
HasMethod NewSubscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewSubscription (Maybe PaymentMethod) Source #
HasMethod Subscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Subscription (Maybe PaymentMethod) Source #

class HasSignatureDate s a | s -> a where Source #

Methods

signatureDate :: Lens' s a Source #

Instances

HasSignatureDate NewMandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods signatureDate :: Lens' NewMandate (Maybe Text) Source #
HasSignatureDate Mandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods signatureDate :: Lens' Mandate (Maybe Text) Source #

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 #
HasStatus Mandate MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Mandate MandateStatus Source #

data MandateDetails Source #

Details which might be available on Mandates.

Constructors

MandateDetails

Fields

_mandateDetailsConsumerName :: Maybe Text
The direct debit account holder's name.
_mandateDetailsConsumerAccount :: Maybe Text
The direct debit account IBAN.
_mandateDetailsConsumerBic :: Maybe Text
The direct debit account BIC.
_mandateDetailsCardHolder :: Maybe Text
The credit card holder's name.
_mandateDetailsCardNumber :: Maybe Text
The last 4 digits of the credit card number.
_mandateDetailsCardLabel :: Maybe Text
The credit card's label.
_mandateDetailsCardFingerprint :: Maybe Text
Unique alphanumeric representation of a credit card. Usable to identify returning customers.
_mandateDetailsCardExpiryDate :: 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] #
HasConsumerName MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' MandateDetails (Maybe Text) Source #
HasConsumerBic MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerBic :: Lens' MandateDetails (Maybe Text) Source #
HasConsumerAccount MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' MandateDetails (Maybe Text) Source #
HasCardNumber MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardNumber :: Lens' MandateDetails (Maybe Text) Source #
HasCardLabel MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardLabel :: Lens' MandateDetails (Maybe Text) Source #
HasCardHolder MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardHolder :: Lens' MandateDetails (Maybe Text) Source #
HasCardFingerprint MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardFingerprint :: Lens' MandateDetails (Maybe Text) Source #
HasCardExpiryDate MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardExpiryDate :: Lens' MandateDetails (Maybe Text) Source #
HasDetails Mandate (Maybe MandateDetails) Source #
Instance details Defined in Mollie.API.Types Methods details :: Lens' Mandate (Maybe MandateDetails) Source #

class HasCardExpiryDate s a | s -> a where Source #

Methods

cardExpiryDate :: Lens' s a Source #

Instances

HasCardExpiryDate MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardExpiryDate :: Lens' MandateDetails (Maybe Text) Source #

class HasCardFingerprint s a | s -> a where Source #

Methods

cardFingerprint :: Lens' s a Source #

Instances

HasCardFingerprint MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardFingerprint :: Lens' MandateDetails (Maybe Text) Source #

class HasCardHolder s a | s -> a where Source #

Methods

cardHolder :: Lens' s a Source #

Instances

HasCardHolder MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardHolder :: Lens' MandateDetails (Maybe Text) Source #

class HasCardLabel s a | s -> a where Source #

Methods

cardLabel :: Lens' s a Source #

Instances

HasCardLabel MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardLabel :: Lens' MandateDetails (Maybe Text) Source #

class HasCardNumber s a | s -> a where Source #

Methods

cardNumber :: Lens' s a Source #

Instances

HasCardNumber MandateDetails (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods cardNumber :: Lens' MandateDetails (Maybe Text) Source #

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

_mandateId :: MandateId
Mollies reference to the mandate.
_mandateStatus :: MandateStatus
The status of the mandate.
_mandateMethod :: PaymentMethod
The payment method of the mandate.
_mandateDetails :: Maybe MandateDetails
The mandate details.
_mandateMandateReference :: Maybe Text
The custom reference set for this mandate.
_mandateSignatureDate :: Maybe Text
Set the date the mandate was signed in `YYYY-MM-DD` format.
_mandateCreatedAt :: 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] #
HasId Mandate MandateId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Mandate MandateId Source #
HasCreatedAt Mandate UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Mandate UTCTime Source #
HasMethod Mandate PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Mandate PaymentMethod Source #
HasStatus Mandate MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Mandate MandateStatus Source #
HasSignatureDate Mandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods signatureDate :: Lens' Mandate (Maybe Text) Source #
HasMandateReference Mandate (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mandateReference :: Lens' Mandate (Maybe Text) Source #
HasDetails Mandate (Maybe MandateDetails) Source #
Instance details Defined in Mollie.API.Types Methods details :: Lens' Mandate (Maybe MandateDetails) Source #

class HasDetails s a | s -> a where Source #

Methods

details :: Lens' s a Source #

Instances

HasDetails Mandate (Maybe MandateDetails) Source #
Instance details Defined in Mollie.API.Types Methods details :: Lens' Mandate (Maybe MandateDetails) Source #
HasDetails Payment (Maybe Object) Source #
Instance details Defined in Mollie.API.Types Methods details :: Lens' Payment (Maybe Object) Source #

class HasStatus s a | s -> a where Source #

Methods

status :: Lens' s a Source #

Instances

HasStatus Mandate MandateStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Mandate MandateStatus Source #
HasStatus Payment PaymentStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Payment PaymentStatus Source #
HasStatus Refund RefundStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Refund RefundStatus Source #
HasStatus Subscription SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Subscription SubscriptionStatus Source #

data MethodImage Source #

Images associated with a payment method.

Constructors

MethodImage
Fields _methodImageSize1x :: Text Normal method icon, 32x24 pixels. _methodImageSize2x :: Text Bigger method icon, 64x48px pixels. _methodImageSvg :: Text Vector icon, can scale to any size.

Instances

Show MethodImage Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> MethodImage -> ShowS # show :: MethodImage -> String # showList :: [MethodImage] -> ShowS #
FromJSON MethodImage Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser MethodImage # parseJSONList :: Value -> Parser [MethodImage] #
HasSvg MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods svg :: Lens' MethodImage Text Source #
HasSize2x MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods size2x :: Lens' MethodImage Text Source #
HasSize1x MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods size1x :: Lens' MethodImage Text Source #
HasImage Method MethodImage Source #
Instance details Defined in Mollie.API.Types Methods image :: Lens' Method MethodImage Source #

class HasSize1x s a | s -> a where Source #

Methods

size1x :: Lens' s a Source #

Instances

HasSize1x MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods size1x :: Lens' MethodImage Text Source #

class HasSize2x s a | s -> a where Source #

Methods

size2x :: Lens' s a Source #

Instances

HasSize2x MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods size2x :: Lens' MethodImage Text Source #

class HasSvg s a | s -> a where Source #

Methods

svg :: Lens' s a Source #

Instances

HasSvg MethodImage Text Source #
Instance details Defined in Mollie.API.Types Methods svg :: Lens' MethodImage Text Source #

data Method Source #

Representation of a payment method available at Mollie.

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

Constructors

Method
Fields _methodId :: PaymentMethod Mollies reference to the method. _methodDescription :: Text Full name of the method. This value changes based on requested locale. _methodImage :: MethodImage Icons for this method.

Instances

Show Method Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
FromJSON Method Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
HasId Method PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Method PaymentMethod Source #
HasImage Method MethodImage Source #
Instance details Defined in Mollie.API.Types Methods image :: Lens' Method MethodImage Source #
HasDescription Method Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Method Text Source #

class HasDescription s a | s -> a where Source #

Methods

description :: Lens' s a Source #

Instances

HasDescription Method Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Method Text Source #
HasDescription NewPayment Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewPayment Text Source #
HasDescription Payment Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Payment Text Source #
HasDescription Refund Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Refund Text Source #
HasDescription NewSubscription Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewSubscription Text Source #
HasDescription Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Subscription Text Source #
HasDescription NewRefund (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewRefund (Maybe Text) Source #

class HasImage s a | s -> a where Source #

Methods

image :: Lens' s a Source #

Instances

HasImage Method MethodImage Source #
Instance details Defined in Mollie.API.Types Methods image :: Lens' Method MethodImage Source #

data PaymentStatus Source #

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.
PaymentCanceled	Customer has canceled 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.

Instances

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

data SequenceType Source #

All available recurring types.

Constructors

First
Recurring
Oneoff

Instances

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

data NewPayment Source #

Structure to request a new payment with.

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

Constructors

NewPayment

Fields

_newPaymentAmount :: Amount
Set the amount to charge. Minimum based on available payment methods.
_newPaymentDescription :: Text
Set the description. Will be shown on card or bank statement.
_newPaymentRedirectUrl :: Maybe Text
Set the url the customer will be redirected to after the payment process.
_newPaymentWebhookUrl :: Maybe Text
Set a specific webhook for this payment.
_newPaymentMethod :: Maybe PaymentMethod
Set a specific payment method for this payment. The customer will not have a choice when this is set.
_newPaymentMetadata :: Maybe Value
Set any additional data in JSON format.
_newPaymentLocale :: Maybe Text
Force the payment screen language.
_newPaymentSequenceType :: Maybe SequenceType
Set the equence type, default to Oneoff. For more information see: https://www.mollie.com/en/docs/reference/customers/create-payment.
_newPaymentCustomerId :: Maybe CustomerId
Set a customer account for this payment.
_newPaymentMandateId :: Maybe MandateId
Set the ID of a specific Mandate. May be supplied to indicate which of the consumer’s accounts should be credited. IDEAL fields
_newPaymentIssuer :: Maybe Text
_newPaymentBillingAddress :: Maybe Address
Set card holder's address. This is to improve the credit card fraude protection. CREDIT CARD & PAYPAL
_newPaymentShippingAddress :: Maybe Address
Set the shipping address. This is to improve fraude protection. BANK TRANSFER
_newPaymentBillingEmail :: 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.
_newPaymentDueDate :: 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.
_newPaymentConsumerName :: Maybe Text
Set the beneficiary name of the account holder.
_newPaymentConsumerAccount :: Maybe Text
Set the account holders IBAN. PAYSAFECARD
_newPaymentCustomerReference :: Maybe Text
Set an identifier for the customer.

Instances

Show NewPayment Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewPayment -> ShowS # show :: NewPayment -> String # showList :: [NewPayment] -> ShowS #
ToJSON NewPayment Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewPayment -> Value # toEncoding :: NewPayment -> Encoding # toJSONList :: [NewPayment] -> Value # toEncodingList :: [NewPayment] -> Encoding #
Default NewPayment Source #
Instance details Defined in Mollie.API.Types Methods def :: NewPayment #
HasAmount NewPayment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewPayment Amount Source #
HasDescription NewPayment Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewPayment Text Source #
HasMetadata NewPayment (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' NewPayment (Maybe Value) Source #
HasLocale NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' NewPayment (Maybe Text) Source #
HasMethod NewPayment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewPayment (Maybe PaymentMethod) Source #
HasConsumerName NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerName :: Lens' NewPayment (Maybe Text) Source #
HasConsumerAccount NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods consumerAccount :: Lens' NewPayment (Maybe Text) Source #
HasWebhookUrl NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' NewPayment (Maybe Text) Source #
HasShippingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods shippingAddress :: Lens' NewPayment (Maybe Address) Source #
HasSequenceType NewPayment (Maybe SequenceType) Source #
Instance details Defined in Mollie.API.Types Methods sequenceType :: Lens' NewPayment (Maybe SequenceType) Source #
HasRedirectUrl NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods redirectUrl :: Lens' NewPayment (Maybe Text) Source #
HasMandateId NewPayment (Maybe MandateId) Source #
Instance details Defined in Mollie.API.Types Methods mandateId :: Lens' NewPayment (Maybe MandateId) Source #
HasIssuer NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods issuer :: Lens' NewPayment (Maybe Text) Source #
HasDueDate NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods dueDate :: Lens' NewPayment (Maybe Text) Source #
HasCustomerReference NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods customerReference :: Lens' NewPayment (Maybe Text) Source #
HasCustomerId NewPayment (Maybe CustomerId) Source #
Instance details Defined in Mollie.API.Types Methods customerId :: Lens' NewPayment (Maybe CustomerId) Source #
HasBillingEmail NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods billingEmail :: Lens' NewPayment (Maybe Text) Source #
HasBillingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods billingAddress :: Lens' NewPayment (Maybe Address) Source #

class HasBillingAddress s a | s -> a where Source #

Methods

billingAddress :: Lens' s a Source #

Instances

HasBillingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods billingAddress :: Lens' NewPayment (Maybe Address) Source #

class HasBillingEmail s a | s -> a where Source #

Methods

billingEmail :: Lens' s a Source #

Instances

HasBillingEmail NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods billingEmail :: Lens' NewPayment (Maybe Text) Source #

class HasCustomerId s a | s -> a where Source #

Methods

customerId :: Lens' s a Source #

Instances

HasCustomerId NewPayment (Maybe CustomerId) Source #
Instance details Defined in Mollie.API.Types Methods customerId :: Lens' NewPayment (Maybe CustomerId) Source #
HasCustomerId Payment (Maybe CustomerId) Source #
Instance details Defined in Mollie.API.Types Methods customerId :: Lens' Payment (Maybe CustomerId) Source #

class HasCustomerReference s a | s -> a where Source #

Methods

customerReference :: Lens' s a Source #

Instances

HasCustomerReference NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods customerReference :: Lens' NewPayment (Maybe Text) Source #

class HasDueDate s a | s -> a where Source #

Methods

dueDate :: Lens' s a Source #

Instances

HasDueDate NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods dueDate :: Lens' NewPayment (Maybe Text) Source #

class HasIssuer s a | s -> a where Source #

Methods

issuer :: Lens' s a Source #

Instances

HasIssuer NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods issuer :: Lens' NewPayment (Maybe Text) Source #

class HasMandateId s a | s -> a where Source #

Methods

mandateId :: Lens' s a Source #

Instances

HasMandateId NewPayment (Maybe MandateId) Source #
Instance details Defined in Mollie.API.Types Methods mandateId :: Lens' NewPayment (Maybe MandateId) Source #
HasMandateId Payment (Maybe MandateId) Source #
Instance details Defined in Mollie.API.Types Methods mandateId :: Lens' Payment (Maybe MandateId) Source #

class HasRedirectUrl s a | s -> a where Source #

Methods

redirectUrl :: Lens' s a Source #

Instances

HasRedirectUrl NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods redirectUrl :: Lens' NewPayment (Maybe Text) Source #
HasRedirectUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods redirectUrl :: Lens' Payment (Maybe Text) Source #

class HasSequenceType s a | s -> a where Source #

Methods

sequenceType :: Lens' s a Source #

Instances

HasSequenceType NewPayment (Maybe SequenceType) Source #
Instance details Defined in Mollie.API.Types Methods sequenceType :: Lens' NewPayment (Maybe SequenceType) Source #
HasSequenceType Payment (Maybe SequenceType) Source #
Instance details Defined in Mollie.API.Types Methods sequenceType :: Lens' Payment (Maybe SequenceType) Source #

class HasShippingAddress s a | s -> a where Source #

Methods

shippingAddress :: Lens' s a Source #

Instances

HasShippingAddress NewPayment (Maybe Address) Source #
Instance details Defined in Mollie.API.Types Methods shippingAddress :: Lens' NewPayment (Maybe Address) Source #

class HasWebhookUrl s a | s -> a where Source #

Methods

webhookUrl :: Lens' s a Source #

Instances

HasWebhookUrl NewPayment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' NewPayment (Maybe Text) Source #
HasWebhookUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' Payment (Maybe Text) Source #
HasWebhookUrl NewSubscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' NewSubscription (Maybe Text) Source #
HasWebhookUrl Subscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' Subscription (Maybe Text) Source #

data Payment Source #

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

_paymentId :: PaymentId
Mollie's reference to the payment resource.
_paymentMode :: Mode
The mode used to create this payment.
_paymentCreatedAt :: UTCTime
The date on which the payment was created.
_paymentStatus :: PaymentStatus
The current status.
_paymentIsCancelable :: Bool
Whether or not the payment can be canceled.
_paymentPaidAt :: Maybe UTCTime
The date on which the payment was paid.
_paymentCanceledAt :: Maybe UTCTime
The date on which the payment was canceled.
_paymentExpiredAt :: Maybe UTCTime
The date on which the payment expired.
_paymentFailedAt :: Maybe UTCTime
The date on which the payment failed.
_paymentAmount :: Amount
The amount charged for this payment.
_paymentAmountRefunded :: Maybe Amount
The amount which has been refunded.
_paymentAmountRemaining :: Maybe Amount
The amount which remained after refunding.
_paymentDescription :: Text
The payment description, as show on the bank or card statement.
_paymentRedirectUrl :: Maybe Text
The URL your customer will be redirected to after completing or canceling the payment process
_paymentMollieUrl :: Maybe Text
The payment screen URL your customer should visit to make the payment. This is where you should redirect the customer to.
_paymentWebhookUrl :: Maybe Text
The URL Mollie will call as soon an important status change takes place.
_paymentMethod :: Maybe PaymentMethod
The payment method used.
_paymentMetadata :: Maybe Value
Custom privided metadata.
_paymentLocale :: Maybe Text
The language used during checkout.
_paymentCountryCode :: Maybe Text
This optional field contains your customer’s ISO 3166-1 alpha-2 country code, detected during checkout.
_paymentProfileId :: Text
Identifier for the profile this payment was created on.
_paymentSettlementAmount :: Maybe Amount
The amount that will be settled to your account.
_paymentSettlementId :: Maybe Text
The identifier referring to the settlement this payment was settled with.
_paymentCustomerId :: Maybe CustomerId
Identifier for the customer this payment was created for.
_paymentSequenceType :: Maybe SequenceType
Indicates which type of payment this is in a recurring sequence. Set to oneoff by default.
_paymentMandateId :: Maybe MandateId
Identifier for the mandate used for this payment if it's recurring.
_paymentSubscriptionId :: Maybe SubscriptionId
Identifier for the subscription used for this payment. TODO: Add payment specific details, see: https://www.mollie.com/nl/docs/reference/payments/get
_paymentDetails :: Maybe Object

Instances

Show Payment Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Payment -> ShowS # show :: Payment -> String # showList :: [Payment] -> ShowS #
FromJSON Payment Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Payment # parseJSONList :: Value -> Parser [Payment] #
HasId Payment PaymentId Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Payment PaymentId Source #
HasCreatedAt Payment UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Payment UTCTime Source #
HasAmount Payment Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Payment Amount Source #
HasMode Payment Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Payment Mode Source #
HasStatus Payment PaymentStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Payment PaymentStatus Source #
HasDescription Payment Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Payment Text Source #
HasProfileId Payment Text Source #
Instance details Defined in Mollie.API.Types Methods profileId :: Lens' Payment Text Source #
HasIsCancelable Payment Bool Source #
Instance details Defined in Mollie.API.Types Methods isCancelable :: Lens' Payment Bool Source #
HasSettlementAmount Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Payment (Maybe Amount) Source #
HasMetadata Payment (Maybe Value) Source #
Instance details Defined in Mollie.API.Types Methods metadata :: Lens' Payment (Maybe Value) Source #
HasLocale Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods locale :: Lens' Payment (Maybe Text) Source #
HasMethod Payment (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Payment (Maybe PaymentMethod) Source #
HasDetails Payment (Maybe Object) Source #
Instance details Defined in Mollie.API.Types Methods details :: Lens' Payment (Maybe Object) Source #
HasWebhookUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' Payment (Maybe Text) Source #
HasSequenceType Payment (Maybe SequenceType) Source #
Instance details Defined in Mollie.API.Types Methods sequenceType :: Lens' Payment (Maybe SequenceType) Source #
HasRedirectUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods redirectUrl :: Lens' Payment (Maybe Text) Source #
HasMandateId Payment (Maybe MandateId) Source #
Instance details Defined in Mollie.API.Types Methods mandateId :: Lens' Payment (Maybe MandateId) Source #
HasCustomerId Payment (Maybe CustomerId) Source #
Instance details Defined in Mollie.API.Types Methods customerId :: Lens' Payment (Maybe CustomerId) Source #
HasSubscriptionId Payment (Maybe SubscriptionId) Source #
Instance details Defined in Mollie.API.Types Methods subscriptionId :: Lens' Payment (Maybe SubscriptionId) Source #
HasSettlementId Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods settlementId :: Lens' Payment (Maybe Text) Source #
HasPaidAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods paidAt :: Lens' Payment (Maybe UTCTime) Source #
HasMollieUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mollieUrl :: Lens' Payment (Maybe Text) Source #
HasFailedAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods failedAt :: Lens' Payment (Maybe UTCTime) Source #
HasExpiredAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods expiredAt :: Lens' Payment (Maybe UTCTime) Source #
HasCountryCode Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods countryCode :: Lens' Payment (Maybe Text) Source #
HasCanceledAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods canceledAt :: Lens' Payment (Maybe UTCTime) Source #
HasAmountRemaining Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRemaining :: Lens' Payment (Maybe Amount) Source #
HasAmountRefunded Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRefunded :: Lens' Payment (Maybe Amount) Source #

class HasAmountRefunded s a | s -> a where Source #

Methods

amountRefunded :: Lens' s a Source #

Instances

HasAmountRefunded Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRefunded :: Lens' Payment (Maybe Amount) Source #

class HasAmountRemaining s a | s -> a where Source #

Methods

amountRemaining :: Lens' s a Source #

Instances

HasAmountRemaining Payment (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amountRemaining :: Lens' Payment (Maybe Amount) Source #

class HasCanceledAt s a | s -> a where Source #

Methods

canceledAt :: Lens' s a Source #

Instances

HasCanceledAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods canceledAt :: Lens' Payment (Maybe UTCTime) Source #
HasCanceledAt Subscription (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods canceledAt :: Lens' Subscription (Maybe UTCTime) Source #

class HasCountryCode s a | s -> a where Source #

Methods

countryCode :: Lens' s a Source #

Instances

HasCountryCode Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods countryCode :: Lens' Payment (Maybe Text) Source #

class HasExpiredAt s a | s -> a where Source #

Methods

expiredAt :: Lens' s a Source #

Instances

HasExpiredAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods expiredAt :: Lens' Payment (Maybe UTCTime) Source #

class HasFailedAt s a | s -> a where Source #

Methods

failedAt :: Lens' s a Source #

Instances

HasFailedAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods failedAt :: Lens' Payment (Maybe UTCTime) Source #

class HasIsCancelable s a | s -> a where Source #

Methods

isCancelable :: Lens' s a Source #

Instances

HasIsCancelable Payment Bool Source #
Instance details Defined in Mollie.API.Types Methods isCancelable :: Lens' Payment Bool Source #

class HasMollieUrl s a | s -> a where Source #

Methods

mollieUrl :: Lens' s a Source #

Instances

HasMollieUrl Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods mollieUrl :: Lens' Payment (Maybe Text) Source #

class HasPaidAt s a | s -> a where Source #

Methods

paidAt :: Lens' s a Source #

Instances

HasPaidAt Payment (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods paidAt :: Lens' Payment (Maybe UTCTime) Source #

class HasProfileId s a | s -> a where Source #

Methods

profileId :: Lens' s a Source #

Instances

HasProfileId Payment Text Source #
Instance details Defined in Mollie.API.Types Methods profileId :: Lens' Payment Text Source #

class HasSettlementId s a | s -> a where Source #

Methods

settlementId :: Lens' s a Source #

Instances

HasSettlementId Payment (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods settlementId :: Lens' Payment (Maybe Text) Source #

class HasSubscriptionId s a | s -> a where Source #

Methods

subscriptionId :: Lens' s a Source #

Instances

HasSubscriptionId Payment (Maybe SubscriptionId) Source #
Instance details Defined in Mollie.API.Types Methods subscriptionId :: Lens' Payment (Maybe SubscriptionId) Source #

data NewRefund Source #

Structure to request a refund.

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

Constructors

NewRefund
Fields _newRefundAmount :: Maybe Amount The amount to refund. For some payments, it can be up to €25.00 more than the original transaction amount. _newRefundDescription :: Maybe Text Set the description. Will be shown on card or bank statement.

Instances

Show NewRefund Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewRefund -> ShowS # show :: NewRefund -> String # showList :: [NewRefund] -> ShowS #
ToJSON NewRefund Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewRefund -> Value # toEncoding :: NewRefund -> Encoding # toJSONList :: [NewRefund] -> Value # toEncodingList :: [NewRefund] -> Encoding #
Default NewRefund Source #
Instance details Defined in Mollie.API.Types Methods def :: NewRefund #
HasAmount NewRefund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewRefund (Maybe Amount) Source #
HasDescription NewRefund (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewRefund (Maybe Text) Source #

data RefundStatus Source #

All possible statusses a refund could be assigned.

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

Constructors

RefundQueued	The refund will be processed once you have enough balance. You can still cancel this refund.
RefundPending	The refund will be processed soon (usually the next business day). You can still cancel this refund.
RefundProcessing	The refund is being processed. Cancellation is no longer possible.
RefundRefunded	The refund has been paid out to your customer.
RefundFailed	The refund has failed during processing.

Instances

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

data Refund Source #

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

_refundId :: Text
Mollies reference to the refund.
_refundAmount :: Amount
The amount refunded to your customer with this refund.
_refundSettlementAmount :: Maybe Amount
This optional field will contain the amount that will be deducted from your account balance.
_refundDescription :: Text
The description of the refund that may be shown to your customer.
_refundStatus :: RefundStatus
The status in which this refund currently is.
_refundPaymentId :: PaymentId
The unique identifier of the payment this refund was created for.
_refundCreatedAt :: UTCTime
The date and time the refund was issued.

Instances

Show Refund Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Refund -> ShowS # show :: Refund -> String # showList :: [Refund] -> ShowS #
FromJSON Refund Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Refund # parseJSONList :: Value -> Parser [Refund] #
HasPaymentId Refund PaymentId Source #
Instance details Defined in Mollie.API.Types Methods paymentId :: Lens' Refund PaymentId Source #
HasId Refund Text Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Refund Text Source #
HasCreatedAt Refund UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Refund UTCTime Source #
HasAmount Refund Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Refund Amount Source #
HasStatus Refund RefundStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Refund RefundStatus Source #
HasDescription Refund Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Refund Text Source #
HasSettlementAmount Refund (Maybe Amount) Source #
Instance details Defined in Mollie.API.Types Methods settlementAmount :: Lens' Refund (Maybe Amount) Source #

data NewSubscription Source #

Structure to request a new subscription with.

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

Constructors

NewSubscription

Fields

_newSubscriptionAmount :: Amount
Set the amount you want to charge each subscription cycle.
_newSubscriptionTimes :: Maybe Int
Set the total number of charges for the subscription to complete. Leave empty for ongoing subscriptions.
_newSubscriptionInterval :: Text
Set the interval to wait between charges like `1 month(s)`, `2 weeks` or `14 days`.
_newSubscriptionStartDate :: Maybe Text
Set the start date of the subscription in YYYY-MM-DD format. This is the first day on which your customer will be charged. When this parameter is not provided, the current date will be used instead.
_newSubscriptionDescription :: Text
Set the description which will be included in the payment description along with the carge date in `Y-m-d` format.
_newSubscriptionMethod :: Maybe PaymentMethod
Force the payment method, leave empty to use one of the customers valid mandates.
_newSubscriptionWebhookUrl :: Maybe Text
Set a webhook URL for all subscription payments.

Instances

Show NewSubscription Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewSubscription -> ShowS # show :: NewSubscription -> String # showList :: [NewSubscription] -> ShowS #
ToJSON NewSubscription Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewSubscription -> Value # toEncoding :: NewSubscription -> Encoding # toJSONList :: [NewSubscription] -> Value # toEncodingList :: [NewSubscription] -> Encoding #
Default NewSubscription Source #
Instance details Defined in Mollie.API.Types Methods def :: NewSubscription #
HasAmount NewSubscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' NewSubscription Amount Source #
HasDescription NewSubscription Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' NewSubscription Text Source #
HasInterval NewSubscription Text Source #
Instance details Defined in Mollie.API.Types Methods interval :: Lens' NewSubscription Text Source #
HasMethod NewSubscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' NewSubscription (Maybe PaymentMethod) Source #
HasWebhookUrl NewSubscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' NewSubscription (Maybe Text) Source #
HasTimes NewSubscription (Maybe Int) Source #
Instance details Defined in Mollie.API.Types Methods times :: Lens' NewSubscription (Maybe Int) Source #
HasStartDate NewSubscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods startDate :: Lens' NewSubscription (Maybe Text) Source #

class HasInterval s a | s -> a where Source #

Methods

interval :: Lens' s a Source #

Instances

HasInterval NewSubscription Text Source #
Instance details Defined in Mollie.API.Types Methods interval :: Lens' NewSubscription Text Source #
HasInterval Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods interval :: Lens' Subscription Text Source #

class HasStartDate s a | s -> a where Source #

Methods

startDate :: Lens' s a Source #

Instances

HasStartDate NewSubscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods startDate :: Lens' NewSubscription (Maybe Text) Source #
HasStartDate Subscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods startDate :: Lens' Subscription (Maybe Text) Source #

class HasTimes s a | s -> a where Source #

Methods

times :: Lens' s a Source #

Instances

HasTimes NewSubscription (Maybe Int) Source #
Instance details Defined in Mollie.API.Types Methods times :: Lens' NewSubscription (Maybe Int) Source #
HasTimes Subscription (Maybe Int) Source #
Instance details Defined in Mollie.API.Types Methods times :: Lens' Subscription (Maybe Int) Source #

data SubscriptionStatus Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods (==) :: SubscriptionStatus -> SubscriptionStatus -> Bool # (/=) :: SubscriptionStatus -> SubscriptionStatus -> Bool #
Read SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods readsPrec :: Int -> ReadS SubscriptionStatus # readList :: ReadS [SubscriptionStatus] # readPrec :: ReadPrec SubscriptionStatus # readListPrec :: ReadPrec [SubscriptionStatus] #
Show SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> SubscriptionStatus -> ShowS # show :: SubscriptionStatus -> String # showList :: [SubscriptionStatus] -> ShowS #
FromJSON SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser SubscriptionStatus # parseJSONList :: Value -> Parser [SubscriptionStatus] #
ToText SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: SubscriptionStatus -> Text Source #
HasStatus Subscription SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Subscription SubscriptionStatus Source #

data Subscription Source #

Representation of a subscription available at Mollie.

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

Constructors

Subscription

Fields

_subscriptionId :: Text
Mollies reference to the subscription.
_subscriptionMode :: Mode
The mode used to create this subscription
_subscriptionCreatedAt :: UTCTime
The date on which this subscription was created.
_subscriptionStatus :: SubscriptionStatus
The subscriptions status.
_subscriptionAmount :: Amount
The amount charged with each payment for this subscription.
_subscriptionTimes :: Maybe Int
The total number or charges for the subscription to complete.
_subscriptionInterval :: Text
The interval to wait between charges.
_subscriptionStartDate :: Maybe Text
Set the start date of the subscription in YYYY-MM-DD format.
_subscriptionDescription :: Text
The description for the payments made with this subscription.
_subscriptionMethod :: Maybe PaymentMethod
The payment method used for this subscription.
_subscriptionCanceledAt :: Maybe UTCTime
The date on which this subscription was canceled.
_subscriptionWebhookUrl :: Maybe Text
The URL Mollie will call as soon a payment status change takes place.

Instances

Show Subscription Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #
FromJSON Subscription Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Subscription # parseJSONList :: Value -> Parser [Subscription] #
HasId Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods id :: Lens' Subscription Text Source #
HasCreatedAt Subscription UTCTime Source #
Instance details Defined in Mollie.API.Types Methods createdAt :: Lens' Subscription UTCTime Source #
HasAmount Subscription Amount Source #
Instance details Defined in Mollie.API.Types Methods amount :: Lens' Subscription Amount Source #
HasMode Subscription Mode Source #
Instance details Defined in Mollie.API.Types Methods mode :: Lens' Subscription Mode Source #
HasStatus Subscription SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods status :: Lens' Subscription SubscriptionStatus Source #
HasDescription Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods description :: Lens' Subscription Text Source #
HasInterval Subscription Text Source #
Instance details Defined in Mollie.API.Types Methods interval :: Lens' Subscription Text Source #
HasMethod Subscription (Maybe PaymentMethod) Source #
Instance details Defined in Mollie.API.Types Methods method :: Lens' Subscription (Maybe PaymentMethod) Source #
HasWebhookUrl Subscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods webhookUrl :: Lens' Subscription (Maybe Text) Source #
HasCanceledAt Subscription (Maybe UTCTime) Source #
Instance details Defined in Mollie.API.Types Methods canceledAt :: Lens' Subscription (Maybe UTCTime) Source #
HasTimes Subscription (Maybe Int) Source #
Instance details Defined in Mollie.API.Types Methods times :: Lens' Subscription (Maybe Int) Source #
HasStartDate Subscription (Maybe Text) Source #
Instance details Defined in Mollie.API.Types Methods startDate :: Lens' Subscription (Maybe Text) Source #