MOmollie
Organizations API

Get partner status

Changed on

Retrieve partnership details about the currently authenticated organization. Only relevant for so-called partner accounts.

get/v2/organizations/me/partner

Request

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

Headers

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

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

Response

The partner status object.

resourcestring required

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

partnerType'oauth' | 'signuplink' | 'useragent' nullable required

Indicates the type of partner. Will be null if the currently authenticated organization is not enrolled as a partner.

isCommissionPartnerboolean

Whether the current organization is receiving commissions.

partnerContractSignedAtstring nullable

The date the partner contract was signed, in ISO 8601 format. Omitted if no contract has been signed (yet).

partnerContractUpdateAvailableboolean

Whether an update to the partner contract is available and requiring the organization's agreement.

partnerContractExpiresAtstring

The expiration date of the signed partner contract, in ISO 8601 format. Omitted if contract has no expiration date (yet).

Example response

{
  "resource": "partner",
  "partnerType": "oauth",
  "isCommissionPartner": true,
  "userAgentTokens": [
    {
      "token": "...",
      "startsAt": "2024-01-01T00:00:00+00:00",
      "endsAt": "2024-12-31T23:59:59+00:00"
    }
  ],
  "partnerContractSignedAt": "2024-01-15T10:00:00+00:00",
  "partnerContractExpiresAt": "2025-01-15T10:00:00+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "signuplink": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API