Create profile

Profiles API v2
POSThttps://api.mollie.com/v2/profiles

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.

Parameters

name

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

website

string
required
The URL to the profile’s website or application. The URL should start with https:// or http://.

email

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

phone

phone number
required
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
  • 0 Other

mode

string
optional

Creating a test profile by setting this parameter to test, enables you to start using the API without having to provide all your business info just yet. Defaults to live.

Possible values: live test

Response

201 application/json

A profile object is returned, as described in Get profile.

Example

cURLPHPPythonRubyNode.js
1
2
3
4
5
6
7
8
curl -X POST https://api.mollie.com/v2/profiles \
   -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ" \
   -d "name=My website name" \
   -d "website=https://www.mywebsite.com" \
   -d "email=info@mywebsite.com" \
   -d "phone=+31208202070" \
   -d "categoryCode=5399" \
   -d "mode=live"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$profile = $mollie->profiles->create([
"name" => "My website name",
"website" => "https://www.mywebsite.com",
"email" => "info@mywebsite.com",
"phone" => "+31208202070",
"categoryCode" => "5399",
"mode" => "live",
]);
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 Ruby 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
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
HTTP/1.1 201 Created
Content-Type: application/hal+json

{
    "resource": "profile",
    "id": "pfl_v9hTwCvYqw",
    "mode": "live",
    "name": "My website name",
    "website": "https://www.mywebsite.com",
    "email": "info@mywebsite.com",
    "phone": "+31208202070",
    "categoryCode": 5399,
    "status": "unverified",
    "createdAt": "2018-03-20T09:28:37+00:00",
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/profiles/pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "chargebacks": {
            "href": "https://api.mollie.com/v2/chargebacks?profileId=pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "methods": {
            "href": "https://api.mollie.com/v2/methods?profileId=pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "payments": {
            "href": "https://api.mollie.com/v2/payments?profileId=pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "refunds": {
            "href": "https://api.mollie.com/v2/refunds?profileId=pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "checkoutPreviewUrl": {
            "href": "https://www.mollie.com/payscreen/preview/pfl_v9hTwCvYqw",
            "type": "text/html"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/profiles-api/create-profile",
            "type": "text/html"
        }
    }
}