---
updatedAt: 2026-08-25T13:46:35.000Z
agentTools:
  projectIndex: https://docs.mollie.com/llms.txt
---

# Connect for Platforms: Onboarding customers

Next, we need to link new or existing customers to your OAuth app using Mollie Connect.

## Onboarding customers

> 📘 Note
>
> Mollie offers a *Postman collection* covering the latest version of the Mollie API. You can import this collection into your own Postman application to simplify your explorations of the Mollie API:
>
> * [Get the Mollie Postman collection](https://www.postman.com/molliedev/mollie-api/overview)
> * [Get Postman](https://postman.com/)

If your platform needs to connect new or existing customers *without pre-filling their business information*, choose our standard OAuth implementation:

1. Click **More** > **Developers**.
2. Select **Your apps** tab and copy `Client ID` and `Client Secret` of your application:

<Image align="center" border={true} src="https://files.readme.io/291ce22eae9f2a9b691f6bb317d38d807577bdf3081b35922690b3bd577ed9e2-Screenshot_2024-09-02_at_11.44.44.png" className="border" />

3. Construct an **authorization URL** with the parameters such as `clientId`, `scope`, `state` etc following the [URL parameters](https://docs.mollie.com/reference/authorize#url-parameters) section of the [Authorize article](https://docs.mollie.com/reference/authorize).\
   Then, you can send your customer to that URL to take them to the authorization screen (typically this redirect sits behind a **Connect with Mollie** button).
   <Callout icon="📘" theme="info">
     We recommend using [Client Links API to automate your onboarding](https://docs.mollie.com/docs/connect-platforms-onboarding-customers#automating-customer-onboarding) instead of manually constructing the URL. This ensures a more robust setup and helps avoid any manual errors.
   </Callout>
4. Once they follow the URL, the OAuth authorize screen pops up and asks your customers to connect to Mollie and grant the necessary permissions:

<Image align="center" border={true} src="https://files.readme.io/3e81e05f73b9be3e38a4f5aca7c536bf58419aecb7a2ab9fde3051c821f1afff-Connect_Mollie_account_1.png" className="border" />

5. After your customers finish the authorization steps, they are redirected back to the `redirect URL` you specified, which includes the `code` parameter with the `authorization_code`. This code expires after **30 seconds**.
6. You need to fetch the `authorization_code` from the client's request, and use it to send a request to the [Tokens API](https://docs.mollie.com/reference/generate-tokens) to generate a pair of credentials allowing you to create API requests on behalf of your customers: `access_token` and `refresh_token`.
   * The `access_token` you receive is temporary and expires after **60 minutes**.
   * The `refresh_token` is **persistent**, so make sure you encrypt and store it securely on your device.
7. Once your customers click the link and connect to your OAuth app, they appear under the **Partners** > **Clients** tab in your partner dashboard.

<Image align="center" border={true} src="https://files.readme.io/6a7f57bb1eb4464a756df92ed227e7a0aae69f16fa87fbc6e5d2757eb91a72cb-Screenshot_2024-08-29_at_14.46.07.png" className="border" />

You can check out each organization to see more details about the account, such as onboarding steps remaining, website profiles created, along with the payment methods enabled for those profiles etc.

## Automating customer onboarding

### Create an organization for your customer

For a seamless and automated Mollie onboarding experience of new customers, we will be using the [Client Links API](https://docs.mollie.com/reference/client-links-api) built on Mollie’s OAuth.

1. Send customer's information to the [Create Client Link endpoint](https://docs.mollie.com/reference/v2/client-links-api/create-client-link), with their business details. Pre-fillable data includes:

* Personal data of your customer:
  * `Email`
  * `Given Name`
  * `Family Name`
  * `Locale`
* `Organization name`
* `Address`
* `Registration number`
* `VAT number`

<Image align="center" border={true} src="https://files.readme.io/35f31bd9d436952c5d3e31fa7f90720b061998aac35f55298bef999d2cd76751-Screenshot_2024-08-30_at_15.21.34.png" className="border" />

2. The API returns a `clientLink` in the response, which you will need to add additional URL parameters to before sharing it with your customer. This includes `clientId`, `scope`, `state` etc following the [URL parameters](https://docs.mollie.com/reference/authorize#url-parameters) section of the [Authorize article](https://docs.mollie.com/reference/authorize).

   <br />

   <Image align="center" border={true} src="https://files.readme.io/196b2b80e7b5bc594b773c7d952ad6327343bdaae7e44edda5bf1d930ba95678-Screenshot_2024-08-30_at_15.26.00.png" className="border" />

   Once they follow the link, an organization is created with the **prefilled information** about their business:

   <br />

   <Image align="center" border={true} src="https://files.readme.io/b56dd567fdf0a43539eb2c4fbdb979c4fc657819de0cb39b038fb0c55467d241-image.png" className="border" />
3. After your customer clicks the link and creates an account, they are redirected back to the `redirect URL` you specified, which includes the `code` parameter with the `authorization_code`. This code expires after **30 seconds**.

   When the link is opened, Mollie sends an email to the specified address asking for email verification and password creation. After that, the user is logged into the Mollie Web app to finish any remaining onboarding steps.
4. You need to fetch the `authorization_code` from the client's request, and use it to send a request to the [Tokens API](https://docs.mollie.com/reference/generate-tokens) to generate a pair of credentials allowing you to create API requests on behalf of your customers: `access_token` and `refresh_token`.
   * The `access_token` you receive is temporary and expires after **60 minutes**.
   * The `refresh_token` is **persistent**, so make sure you encrypt and store it securely on your device.
5. Once your customers click the link and connect to your OAuth app, they appear under the **Partners** > **Clients** tab in your partner dashboard.

### Configure your customers' profiles

As your customers continue onboarding at Mollie, they will configure one or more website profiles.\
Profiles represent customer storefronts, allowing for multiple trade names or markets within one account. Payment methods and transactions are always associated with *specific profiles*.

For customers who already have a Mollie account, they may have already created and configured one or more profiles. We recommend asking them to select the profile that they wish to use to process payments through your platform. You can fetch a list of existing customer profiles via the [Profiles API](https://docs.mollie.com/reference/list-profiles), or you can create and configure a new profile on your customer's behalf:

* Send data to create a new profile for your customer using the [Create profile endpoint](https://docs.mollie.com/reference/v2/profiles-api/create-profile).
* [Enable payment methods through the API](https://docs.mollie.com/reference/v2/profiles-api/enable-method) (*some methods may require additional activation steps*).

### Wait for your customers to complete the onboarding

While waiting for your customers to complete their onboarding, use the [Onboarding status endpoint](/reference/get-onboarding-status) response to display the current status.

<Callout icon="🚧" theme="warn">
  Onboarding API will soon be deprecated. We suggest you migrate to the new [Capabilities API](https://docs.mollie.com/reference/list-capabilities), which offers improved performance, enhanced features, and ongoing support.
</Callout>

Possible statuses are `needs-data`, `in-review`, and `completed`.\
If `needs-data` is returned, Mollie requires more information and the API response contains a `_links/dashboard` deep link to the customer’s onboarding wizard. We recommend including the link in your application with a clear call-to-action.

Two milestones, `canReceivePayments` and `canReceiveSettlements`, indicate progress during onboarding. Display the following onboarding status messages:

| Status       | Payments enabled | Settlements enabled | Message you can show to your customer                                                                                                        |
| :----------- | :--------------- | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- |
| `needs-data` | false            | false               | Before you can receive payments, Mollie needs [more information](/docs/overview).                                                            |
| `needs-data` | true             | false               | You can start receiving payments. Before Mollie can pay out to your bank, you need to provide some [additional information](/docs/overview). |
| `in-review`  | false            | false               | Mollie has all the required information and is verifying your details.                                                                       |
| `in-review`  | true             | false               | You can start receiving payments. Mollie is verifying your details to enable settlements to your bank.                                       |
| `completed`  | true             | true                | Setup is complete!                                                                                                                           |

Once `canReceivePayments` flag is `true`, you can [create your first payment](/reference/create-payment) to test your integration.

You can also use the [Capabilities API](https://docs.mollie.com/reference/list-capabilities) to verify if `payments` and `settlements` have been enabled.

## Example

<Embed url="https://www.youtube.com/watch?v=2xNsz1eLnfw" href="https://www.youtube.com/watch?v=2xNsz1eLnfw" typeOfEmbed="youtube" html="%3Ciframe%20class%3D%22embedly-embed%22%20src%3D%22%2F%2Fcdn.embedly.com%2Fwidgets%2Fmedia.html%3Fsrc%3Dhttps%253A%252F%252Fwww.youtube.com%252Fembed%252F2xNsz1eLnfw%253Ffeature%253Doembed%26display_name%3DYouTube%26url%3Dhttps%253A%252F%252Fwww.youtube.com%252Fwatch%253Fv%253D2xNsz1eLnfw%26image%3Dhttps%253A%252F%252Fi.ytimg.com%252Fvi%252F2xNsz1eLnfw%252Fhqdefault.jpg%26type%3Dtext%252Fhtml%26schema%3Dyoutube%22%20width%3D%22640%22%20height%3D%22480%22%20scrolling%3D%22no%22%20title%3D%22YouTube%20embed%22%20frameborder%3D%220%22%20allow%3D%22autoplay%3B%20fullscreen%3B%20encrypted-media%3B%20picture-in-picture%3B%22%20allowfullscreen%3D%22true%22%3E%3C%2Fiframe%3E" />