Get profile

Profiles API v2
GEThttps://api.mollie.com/v2/profiles/*id*

Retrieve details of a profile, using the profile’s identifier.

Parameters

Replace id in the endpoint URL by the profile’s ID, for example pfl_v9hTwCvYqw.

Response

200 application/json

resourcestring
Indicates the response contains a profile object. Will always contain profile for this endpoint.
idstring
The identifier uniquely referring to this profile, for example pfl_v9hTwCvYqw.
modestring

Indicates whether the profile is in test or production mode.

Possible values:

  • live: The profile is verified.
  • test: The profile has not been verified yet and can only be used to create test payments.
namestring
The profile’s name, this will usually reflect the trade name or brand name of the profile’s website or application.
websitestring
The URL to the profile’s website or application.
emailstring
The email address associated with the profile’s trade name or brand.
phonephone number
The phone number associated with the profile’s trade name or brand.
categoryCodeinteger

Warning

Be aware that from September the categoryCode parameter will be deprecated and replaced by a new business category parameter. We will continue to provide support for the categoryCode parameter until 2022, but please revisit our documentation in September to learn how to update your API calls.

The industry associated with the profile’s trade name or brand.

Possible values:

  • 5192 Books, magazines and newspapers
  • 5262 Marketplaces, crowdfunding, donation platforms
  • 5399 General merchandise
  • 5499 Food and drinks
  • 5533 Automotive Products
  • 5641 Children Products
  • 5651 Clothing & Shoes
  • 5712 Home furnishing
  • 5732 Electronics, computers and software
  • 5734 Hosting/VPN services
  • 5735 Entertainment
  • 5815 Credits/vouchers/giftcards
  • 5921 Alcohol
  • 5944 Jewelry & Accessories
  • 5945 Hobby, Toy, and Game Shops
  • 5977 Health & Beauty products
  • 6012 Financial services
  • 6051 Crypto currency
  • 7299 Consultancy
  • 7922 Events, conferences, concerts, tickets
  • 7997 Gyms, membership fee based sports
  • 7999 Travel, rental and transportation
  • 8111 Lawyers and legal advice
  • 8299 Advising/coaching/training
  • 8398 Charity and donations
  • 8699 Political parties
  • 9399 Government services
  • 0 Other
statusstring

The profile status determines whether the profile is able to receive live payments.

Possible values:

  • unverified: The profile has not been verified yet and can only be used to create test payments.
  • verified: The profile has been verified and can be used to create live payments and test payments.
  • blocked: The profile is blocked and can thus no longer be used or changed.
reviewobject

The presence of a review object indicates changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved automatically, unless a switch to a live profile has been requested. The review object will therefore usually be null in test mode.

Show child parameters

statusstring

The status of the requested profile changes.

Possible values:

  • pending: The changes are pending review. We will review your changes soon.
  • rejected: We have reviewed and rejected your changes.
createdAtdatetime
The profile’s date and time of creation, in ISO 8601 format.
_linksobject

An object with several URL objects relevant to the profile. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the profile itself.
dashboardURL object
Direct link to the profile in the Mollie Dashboard.
chargebacksURL object
The API resource URL of the chargebacks that belong to this profile.
methodsURL object
The API resource URL of the methods that are enabled for this profile.
paymentsURL object
The API resource URL of the payments that belong to this profile.
refundsURL object
The API resource URL of the refunds that belong to this profile.
checkoutPreviewUrlURL object
The Checkout preview URL. You need to be logged in to access this page.
documentationURL object
The URL to the profile retrieval endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/profiles/pfl_v9hTwCvYqw \
   -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$profile = $mollie->profiles->get("pfl_v9hTwCvYqw");
1
2
3
4
5
6
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_access_token('access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ')

profile = mollie_client.profiles.get('pfl_v9hTwCvYqw')
1
2
3
4
5
6
7
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'
end

profile = Mollie::Profile.get('pfl_v9hTwCvYqw')
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
46
47
48
49
50
51
52
HTTP/1.1 200 OK
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": "verified",
    "review": {
        "status": "pending"
    },
    "createdAt": "2018-03-20T09:28:37+00:00",
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/profiles/pfl_v9hTwCvYqw",
            "type": "application/hal+json"
        },
        "dashboard": {
            "href": "https://www.mollie.com/dashboard/org_123456789/settings/profiles/pfl_v9hTwCvYqw",
            "type": "text/html"
        },
        "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"
        }
    }
}