Safe Haskell | None |
---|---|
Language | Haskell2010 |
- customersPath :: Text
- newCustomer :: Text -> Text -> NewCustomer
- createCustomer :: NewCustomer -> Mollie (Either ResponseError Customer)
- getCustomer :: Text -> Mollie (Either ResponseError Customer)
- getCustomers :: Int -> Int -> Mollie (Either ResponseError (List Customer))
- createCustomerPayment :: Text -> NewPayment -> Mollie (Either ResponseError Payment)
- getCustomerPayments :: Text -> Int -> Int -> Mollie (Either ResponseError (List Payment))
- data NewCustomer = NewCustomer {}
- data Customer = Customer {}
- data Mode
- data PaymentStatus
- data PaymentMethod
- data RecurringType
- data NewPayment = NewPayment {
- newPayment_amount :: Double
- newPayment_description :: Text
- newPayment_redirectUrl :: Maybe Text
- newPayment_webhookUrl :: Maybe Text
- newPayment_method :: Maybe PaymentMethod
- newPayment_metadata :: Maybe Value
- newPayment_locale :: Maybe Text
- newPayment_recurringType :: Maybe RecurringType
- newPayment_customerId :: Maybe Text
- newPayment_issuer :: Maybe Text
- newPayment_billingAddress :: Maybe Text
- newPayment_billingCity :: Maybe Text
- newPayment_billingRegion :: Maybe Text
- newPayment_billingPostal :: Maybe Text
- newPayment_billingCountry :: Maybe Text
- newPayment_shippingAddress :: Maybe Text
- newPayment_shippingCity :: Maybe Text
- newPayment_shippingRegion :: Maybe Text
- newPayment_shippingPostal :: Maybe Text
- newPayment_shippingCountry :: Maybe Text
- newPayment_billingEmail :: Maybe Text
- newPayment_dueDate :: Maybe Text
- newPayment_consumerName :: Maybe Text
- newPayment_consumerAccount :: Maybe Text
- newPayment_customerReference :: Maybe Text
- data Payment = Payment {
- payment_id :: Text
- payment_mode :: Mode
- payment_createdDatetime :: UTCTime
- payment_status :: PaymentStatus
- payment_paidDatetime :: Maybe UTCTime
- payment_cancelledDatetime :: Maybe UTCTime
- payment_expiredDatetime :: Maybe UTCTime
- payment_expiryPeriod :: Maybe Text
- payment_amount :: Text
- payment_amountRefunded :: Maybe Text
- payment_amountRemaining :: Maybe Text
- payment_description :: Text
- payment_method :: Maybe PaymentMethod
- payment_metadata :: Maybe Value
- payment_locale :: Maybe Text
- payment_profileId :: Text
- payment_customerId :: Maybe Text
- payment_mandateId :: Maybe Text
- payment_settlementId :: Maybe Text
- payment_links :: PaymentLinks
- payment_details :: Maybe Object
- data PaymentLinks = PaymentLinks {}
- data List a = List {
- list_totalCount :: Int
- list_offset :: Int
- list_count :: Int
- list_data :: [a]
- list_links :: Maybe ListLinks
- data ListLinks = ListLinks {}
- data ResponseError
Documentation
customersPath :: Text Source #
Customer resource's path, relative to API's versioned url.
createCustomer :: NewCustomer -> Mollie (Either ResponseError Customer) Source #
Handler to create a new customer.
For more information see: https://www.mollie.com/en/docs/reference/customers/create.
:: Text | customerId |
-> Mollie (Either ResponseError Customer) |
Handler to get a customer by its identifier.
For more information see: https://www.mollie.com/en/docs/reference/customers/get.
Handler to get a list of customers. Because the list endpoint is paginated this handler requires an offset and a count. The maximum amount of customers returned with a single call is 250.
For more information see: https://www.mollie.com/en/docs/reference/customers/list.
createCustomerPayment Source #
:: Text | customerId |
-> NewPayment | |
-> Mollie (Either ResponseError Payment) |
Handler to create a new payment for a specific customer.
For more information see: https://www.mollie.com/en/docs/reference/customers/create-payment.
Handler to get a list of payments for a specific customer. Because the list endpoint is paginated this handler requires an offset and a count. The maximum amount of payments returned with a single call is 250.
For more information see: https://www.mollie.com/en/docs/reference/customers/list-payments.
data NewCustomer Source #
Structure to request a new customer with.
For more information see: https://www.mollie.com/en/docs/reference/customers/create.
NewCustomer | |
|
Representation of an customer available at Mollie.
For more information see: https://www.mollie.com/en/docs/reference/customers/get.
Customer | |
|
All available API modes.
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.
PaymentOpen | Payment has been created. This is the initial status. |
PaymentCancelled | Customer has cancelled the payment. |
PaymentPending | The payment process has been started. No notification. |
PaymentExpired | The payment has expired. Some payment methods (like |
PaymentFailed | The payment can't be completed. |
PaymentPaid | The payment was successful. This is the success status. |
PaymentPaidout | Mollie has transfered the payment to your bankaccount. No notification. |
PaymentRefunded | You requested a refund for the payment. |
PaymentChargedBack | The customer dispute the payment. This is possible with |
data PaymentMethod Source #
All possible payment methods.
data RecurringType Source #
All available recurring types.
data NewPayment Source #
Structure to request a new payment with.
For more information see: https://www.mollie.com/en/docs/reference/payments/create.
NewPayment | |
|
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.
Payment | |
|
data PaymentLinks Source #
Important links used for a payment.
PaymentLinks | |
|
List response for any resource with metadata.
For more information see: https://www.mollie.com/nl/docs/reference/payments/list.
List | |
|
Important links associated with List responses.
ListLinks | |
|
data ResponseError Source #
Response errors which could happen when requesting resources from Mollie.