MOmollie
Clients API

Get client

Retrieve a single client by its ID.

🔑 Access with

Advanced access token with clients.read

get/v2/clients/{organizationId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/clients/{organizationId}
  • Auth
    HTTP bearer

Query parameters

embedstring nullable
Example:organization

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

  • organization: Include the organization of the client. Available for signuplink partners, or for oauth partners with the organizations.read scope.
  • onboarding: Include the onboarding status of the client. Available for signuplink partners, or for oauth partners with the onboarding.read scope.
  • capabilities: Include the capabilities of the client organization. Available for oauth partners with the onboarding.read scope.

Response

The client object.

resourcestring required

Indicates the response contains a client object. Will always contain the string client for this resource type.

idstring required

The identifier uniquely referring to this client. Example: org_12345678.

organizationCreatedAtstring

The date and time the client organization was created, in ISO 8601 format.

Example response

{
  "id": "org_1234567",
  "commission": {
    "count": 10
  },
  "organizationCreatedAt": "2023-01-15T13:45:30+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "organization": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "onboarding": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  },
  "_embedded": {
    "organization": {
      "id": "org_1234567",
      "name": "My Online Store",
      "email": "example@mail.com",
      "locale": "en_US",
      "address": {
        "streetAndNumber": "Keizersgracht 126",
        "postalCode": "1015 CW",
        "city": "Amsterdam",
        "country": "NL"
      },
      "registrationNumber": "12345678",
      "vatNumber": "NL123456789B01",
      "vatRegulation": "dutch",
      "_links": {
        "self": {
          "href": "https://...",
          "type": "application/hal+json"
        },
        "dashboard": {
          "href": "https://...",
          "type": "application/hal+json"
        },
        "documentation": {
          "href": "https://...",
          "type": "application/hal+json"
        }
      }
    },
    "onboarding": {
      "name": "My webshop",
      "status": "completed",
      "canReceivePayments": true,
      "canReceiveSettlements": true,
      "signedUpAt": "2023-01-15T13:45:30+00:00",
      "_links": {
        "self": {
          "href": "https://...",
          "type": "application/hal+json"
        },
        "dashboard": {
          "href": "https://...",
          "type": "application/hal+json"
        },
        "organization": {
          "href": "https://...",
          "type": "application/hal+json"
        },
        "documentation": {
          "href": "https://...",
          "type": "application/hal+json"
        }
      }
    },
    "capabilities": [
      {
        "resource": "capability",
        "name": "payments",
        "status": "pending",
        "statusReason": "requirement-past-due",
        "requirements": [
          {
            "id": "needs-data",
            "status": "past-due",
            "dueDate": "2024-01-01T12:00:00+00:00",
            "_links": {
              "dashboard": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.