Settings API Reference mollie v0.7.2

Documentation for Mollie.

The Client module sets up the endpoint and authorization used in the Mollie API. Every API needs a client.

Mollie Connect is a set of APIs and tools that allows you to connect multiple Mollie accounts together.

Creates a simple minimal representation of a customer in the Mollie API to use for the Mollie Checkout and Recurring features. These customers will appear in your Mollie Dashboard where you can manage their details, and also see their payments and subscriptions.

Mandates allow you to charge a customer’s credit card, PayPal account or bank account recurrently.

Linking customers to payments enables a number of Mollie Checkout features, including

With subscriptions, you can schedule recurring payments to take place at regular intervals.

Retrieve details of an invoice. To retrieve details of an invoice by its invoice number, use list/2 with the reference parameter.

Retrieve enabled payment methods for the authorized organization. To list all available payment methods use list_all/2.

Rertrieve or submit data that is used for onboarding organizations onto your merchant account. Please note that the data you submit will only be processed when the onboarding status is needs-data.

Using the Orders API is the preferred approach when integrating the Mollie API into e-commerce applications such as webshops. If you want to use 'pay after delivery' methods such as Klarna Pay later, using the Orders API is mandatory.

Cancel one or more order lines that were previously authorized using a pay after delivery payment method.

Create refunds on a payment. The refunded amount is credited to your customer.

The Shipment API is used to ship order lines created by the Create order.

Retrieve organization info. You can only retrieve organizations that the authenticated organization is connected to.

Payment creation is elemental to the Mollie API: this is where most payment implementations start off.

Captures are used for payments that have the authorize-then-capture flow. The only payment methods at the moment that have this flow are Klarna Pay later and Klarna Slice it.

List chargebacks for your orgnaization or retrieve a single chargeback by its ID. Note the original payment’s ID is needed as well.

Create refunds on a Payment. The refunded amount is credited to your customer.

All API actions through OAuth are by default protected for privacy and/or money related reasons and therefore require specific permissions. These permissions can be requested by apps during the OAuth authorization flow. The Permissions resource allows the app to check whether an API action is (still) allowed by the authorization.

In order to process payments, you need to create a website profile. A website profile can easily be created via the Dashboard manually. However, the Mollie API also allows automatic profile creation via the Profiles API.

Enable or disable a payment method on a specific profile to use it with payments

Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule.