Get profile

Profiles API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for retrieving profiles in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/profiles/*id*
Authentication:App access tokens

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

Parameters

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

Response

200 application/json

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

Indicates whether the payment profile is in test or production mode.

Possible values: live test

namestring
The payment 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.
phonestring
The phone number associated with the profile’s trade name or brand.
categoryCodeinteger

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

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.

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 payment 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.
createdDatetimedatetime
The payment profile’s date and time of creation, in ISO 8601 format.
updatedDatetimedatetime
The date and time of the payment profile’s last edit, in ISO 8601 format.
linksobject

Useful URLs to related resources.

Show child parameters

apikeysstring
The URL to the nested API keys resource.
checkoutPreviewUrlstring
The Checkout preview URL. You need to be logged in to access this page.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/profiles/pfl_v9hTwCvYqw \
    -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "profile",
    "id": "pfl_8tv5FmWcn4",
    "mode": "live",
    "name": "My website name",
    "website": "https://www.mywebsite.com",
    "email": "info@mywebsite.com",
    "phone": "31123456789",
    "categoryCode": 5399,
    "status": "unverified",
    "review": {
        "status": "pending"
    },
    "createdDatetime": "2018-03-16T18:46:21.0Z",
    "updatedDatetime": "2018-03-16T18:46:21.0Z",
    "links": {
        "apikeys": "https://api.mollie.com/v1/profiles/pfl_8tv5FmWcn4/apikeys",
        "checkout": "https://www.mollie.com/payscreen/preview/pfl_8tv5FmWcn4"
    }
}