Submit onboarding data

Onboarding API v2
POSThttps://api.mollie.com/v2/onboarding/me
Authentication:Organization access tokensApp access tokens

Submit data that will be prefilled in the merchant’s onboarding. Please note that the data you submit will only be processed when the onboarding status is needs-data.

Note

Information that the merchant has entered in their dashboard will not be overwritten.

Parameters

Please note that even though all parameters are optional, at least one of them needs to be provided in the request.

organization

object
optional

Data of the organization you want to provide.

name

string
optional
 Name of the organization.

address

address object
optional

Address of the organization.

streetAndNumber

string
optional
 The street name and house number of the organization.

postalCode

string
optional
 The postal code of the organization.

city

string
optional
 The city of the organization.

country

string
optional
 The country of the address in ISO 3166-1 alpha-2 format.

registrationNumber

string
optional
 The Chamber of Commerce registration number of the company.

vatNumber

string
optional
 The VAT number of the company, if based in the European Union. The VAT number will be checked with the VIES service by Mollie.

vatRegulation

string
optional
 The organization’s VAT regulation, if based in the European Union. Either shifted (VAT is shifted) or dutch (Dutch VAT rate) is accepted.

profile

object
optional

Data of the payment profile you want to provide.

name

string
optional
 The profile’s name should reflect the tradename or brand name of the profile’s website or application.

url

string
optional
 The URL to the profile’s website or application. The URL must be compliant to RFC3986 with the exception that we only accept URLs with http:// or https:// schemes and domains that contain a TLD. URLs containing an @ are not allowed.

email

string
optional
 The email address associated with the profile’s tradename or brand.

description

string
optional
 A description of what kind of goods and/or products will be offered via the payment profile.

phone

string
optional
 The phone number associated with the profile’s trade name or brand. Must be in the E.164 format. For example +31208202070.

categoryCode

integer
optional

The industry associated with the profile’s tradename or brand.

Possible values:

  • 4121 Travel, rental and transportation
  • 5192 Books, magazines and newspapers
  • 5399 General merchandise
  • 5499 Food and drinks
  • 5533 Automotive Products
  • 5641 Children Products
  • 5651 Clothing & Shoes
  • 5732 Electronics, computers and software
  • 5735 Entertainment
  • 5815 Digital services
  • 5944 Jewelry & Accessories
  • 5977 Health & Beauty products
  • 6012 Financial services
  • 7299 Personal services
  • 7999 Events, festivals and recreation
  • 8398 Charity and donations

Example

cURLPHPPythonRubyNode.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl -X POST https://api.mollie.com/v2/onboarding/me \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
     -d '{
             "organization": {
                "name": "Mollie B.V.",
                "address": {
                   "streetAndNumber": "Keizersgracht 313",
                   "postalCode": "1018 EE",
                   "city": "Amsterdam",
                   "country": "NL"
                },
                "registrationNumber": "30204462",
                "vatNumber": "NL815839091B01"
             },
             "profile": {
                "name": "Mollie",
                "url": "https://www.mollie.com",
                "email": "info@mollie.com",
                "phone": "+31208202070",
                "categoryCode": 6012
             }
         }'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

$mollie->onboarding->submit([
    "organization" => [
        "name" => "Mollie B.V.",
        "address" => [
           "streetAndNumber" => "Keizersgracht 313",
           "postalCode" => "1018 EE",
           "city" => "Amsterdam",
           "country" => "NL",
        ],
        "registrationNumber" => "30204462",
        "vatNumber" => "NL815839091B01",
    ],
    "profile" => [
        "name" => "Mollie",
        "url" => "https://www.mollie.com",
        "email" => "info@mollie.com",
        "phone" => "+31208202070",
        "categoryCode" => 6012,
    ],
]);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

Mollie::Onboarding.submit(
  organization: {
    name: "Mollie B.V.",
    address: {
       streetAndNumber: "Keizersgracht 313",
       postalCode: "1016 EE",
       city: "Amsterdam",
       country: "NL"
    },
    registrationNumber: "30204462",
    vatNumber: "NL815839091B01"
  },
  profile: {
    name: "Mollie",
    url: "https://www.mollie.com",
    email: "info@mollie.com",
    phone: "+31208202070",
    categoryCode: 6012
  }
)

1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

Response

1
HTTP/1.1 204 No Content