Get profile
Profiles API

GET
https://api.mollie.nl/v1/profiles/id
Authentication: OAuth 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.

Includes

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

  • No includes supported for this endpoint.

Response

200
application/json; charset=utf-8
resource
string

Indicates the response contains a profile.

Possible values: profile

id
string

The payment profile's unique identifier, for example pfl_3RkSN1zuPE.

mode
string

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

Possible values: live test

name
string

The payment profile's name, this will usually reflect the tradename or brand name of the profile's website or application.

website
string

The URL to the profile's website or application.

email
string

The email address associated with the profile's tradename or brand.

phone
string

The phone number associated with the profile's tradename or brand.

categoryCode
integer

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

Possible values:

  • 5399 General merchandise
  • 5732 Electronics, computers and software
  • 4121 Travel, rental and transportation
  • 6012 Financial services
  • 5499 Food and drinks
  • 7999 Events, festivals and recreation
  • 5192 Books, magazines and newspapers
  • 7299 Personal services
  • 8398 Charity and donations
  • 0 Other
status
string

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.
review
object | null

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.

status
string

The status of the requested profile changes.

Possible values:

  • pending The changes are pending review. We will review your changes soon.
  • rejected We've reviewed and rejected your changes.
createdDatetime
datetime

The payment profile's date and time of creation, in ISO 8601 format.

updatedDatetime
datetime

The date and time of the payment profile's last edit, in ISO 8601 format.

links
object

Useful URLs to related resources.

apikeys
string

The URL to the nested API keys resource.

checkoutPreviewUrl
string

The Checkout preview URL. You need to be logged in to access this page.

Example

Request code

// Not implemented. Create a pull request: https://github.com/mollie/mollie-api-php

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "resource": "profile",
    "id": "pfl_v9hTwCvYqw",
    "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": "2017-10-19T15:15:14.0Z",
    "updatedDatetime": "2017-10-19T15:15:14.0Z",
    "links": {
        "apikeys": "https://api.mollie.nl/v1/profiles/pfl_v9hTwCvYqw/apikeys",
        "checkout": "https://www.mollie.com/beheer/account_profielen/preview-payscreen/1337"
    }
}