MOmollie
Profiles API

Create profile

Changed on

Create a profile to process payments on.

Profiles are required for payment processing. Normally they are created via the Mollie dashboard. Alternatively, you can use this endpoint to automate profile creation.

post/v2/profiles

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/profiles
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: profiles.write

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

resourcestring

Indicates the response contains a profile object. Will always contain the string profile for this endpoint.

idstring

The identifier uniquely referring to this profile. Example: pfl_v9hTwCvYqw.

mode'live' | 'test'

Whether this entity was created in live mode or in test mode.

namestring required

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

websitestring required

The URL to the profile's website or application. Only https or http URLs are allowed. No @ signs are allowed.

emailstring required

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

If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.

phonestring required

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

descriptionstring

The products or services offered by the profile's website or application.

countriesOfActivitystring[]

A list of countries where you expect that the majority of the profile's customers reside, in ISO 3166-1 alpha-2 format.

businessCategorystring nullable

The industry associated with the profile's trade name or brand. Please refer to the business category list for all possible options.

status'unverified' | 'verified' | 'blocked'

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

  • 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 no longer be used or changed.
createdAtstring

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

Example request

{
  "resource": "profile",
  "id": "pfl_QkEhN94Ba",
  "mode": "live",
  "name": "My website name",
  "website": "https://example.com",
  "email": "test@mollie.com",
  "phone": "+31208202070",
  "description": "My website description",
  "countriesOfActivity": [
    "NL",
    "GB"
  ],
  "businessCategory": "OTHER_MERCHANDISE",
  "status": "unverified",
  "review": {
    "status": "pending"
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "...",
      "type": "application/hal+json"
    },
    "dashboard": {
      "href": "https://www.mollie.com/dashboard/org_7049691/settings/profiles/pfl_2q3RyuMGry",
      "type": "text/html"
    },
    "chargebacks": {
      "href": "https://api.mollie.com/v2/chargebacks?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "methods": {
      "href": "https://api.mollie.com/v2/methods?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "payments": {
      "href": "https://api.mollie.com/v2/payments?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "refunds": {
      "href": "https://api.mollie.com/v2/refunds?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "checkoutPreviewUrl": {
      "href": "https://www.mollie.com/checkout/preview/pfl_2q3RyuMGry",
      "type": "text/html"
    },
    "documentation": {
      "href": "...",
      "type": "text/html"
    }
  }
}

Response

The newly created profile object.

resourcestring required

Indicates the response contains a profile object. Will always contain the string profile for this endpoint.

idstring required

The identifier uniquely referring to this profile. Example: pfl_v9hTwCvYqw.

mode'live' | 'test' required

Whether this entity was created in live mode or in test mode.

namestring required

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

websitestring required

The URL to the profile's website or application. Only https or http URLs are allowed. No @ signs are allowed.

emailstring required

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

If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.

phonestring required

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

descriptionstring

The products or services offered by the profile's website or application.

countriesOfActivitystring[]

A list of countries where you expect that the majority of the profile's customers reside, in ISO 3166-1 alpha-2 format.

businessCategorystring nullable required

The industry associated with the profile's trade name or brand. Please refer to the business category list for all possible options.

status'unverified' | 'verified' | 'blocked' required

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

  • 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 no longer be used or changed.
createdAtstring required

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

Example response

{
  "resource": "profile",
  "id": "pfl_QkEhN94Ba",
  "mode": "live",
  "name": "My website name",
  "website": "https://example.com",
  "email": "test@mollie.com",
  "phone": "+31208202070",
  "description": "My website description",
  "countriesOfActivity": [
    "NL",
    "GB"
  ],
  "businessCategory": "OTHER_MERCHANDISE",
  "status": "unverified",
  "review": {
    "status": "pending"
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "...",
      "type": "application/hal+json"
    },
    "dashboard": {
      "href": "https://www.mollie.com/dashboard/org_7049691/settings/profiles/pfl_2q3RyuMGry",
      "type": "text/html"
    },
    "chargebacks": {
      "href": "https://api.mollie.com/v2/chargebacks?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "methods": {
      "href": "https://api.mollie.com/v2/methods?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "payments": {
      "href": "https://api.mollie.com/v2/payments?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "refunds": {
      "href": "https://api.mollie.com/v2/refunds?profileId=pfl_2q3RyuMGry",
      "type": "application/hal+json"
    },
    "checkoutPreviewUrl": {
      "href": "https://www.mollie.com/checkout/preview/pfl_2q3RyuMGry",
      "type": "text/html"
    },
    "documentation": {
      "href": "...",
      "type": "text/html"
    }
  }
}

Changes

  • 19423176b0c3Revision changes
    • breaking

      the response property //// became nullable for the status

    • info

      the request property //// became nullable

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status