Get partner

Organizations API v2
GEThttps://api.mollie.com/v2/organizations/me/partner

Retrieve details about the partner status of the currently authenticated organization.

Parameters

No parameters applicable for this endpoint.

Response

200 application/hal+json

resourcestring
Indicates the response contains a partner object. Will always contain partner for this endpoint.
partnerTypestring

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

Possible values: oauth signuplink useragent

isCommissionPartnerbooleanoptional
Will be true if partner is receiving commissions. Will be omitted otherwise.
userAgentTokensarrayoptional

Array of user agent token objects. Present if the partner is of type useragent or if the partner has had user agent tokens in the past. Will be omitted otherwise.

Show child parameters

tokenstring
The unique user agent token.
startsAtdate
The date and time from which the token is active, in ISO 8601 format.
endsAtdate
The date and time after which the token is no longer active, in ISO 8601 format. Will be null if no end date has been set.
partnerContractSignedAtdateoptional
The date and time the contract was signed, in ISO 8601 format. Will be omitted if the contract has not yet been signed, or if partnerType is null.
partnerContractUpdateAvailablebooleanoptional
Will be true if an updated contract is available, requiring the partner’s agreement. Will be omitted otherwise.
_linksobject

An object with several URL objects relevant to the partner resource. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the partner itself.
documentationURL object
The URL to the documentation of this endpoint.
signuplinkURL objectoptional
The URL that can be used to have new organizations sign up and be automatically linked to this partner. Will be omitted if the partner is not of type signuplink.

Example

1
2
curl -X GET https://api.mollie.com/v2/organizations/me/partner \
   -H "Authorization: Bearer access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

Response

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

{
    "resource": "partner",
    "partnerType": "signuplink",
    "partnerContractSignedAt": "2018-03-20T13:13:37+00:00",
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/organizations/me/partner",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/organizations-api/get-partner",
            "type": "text/html"
        },
        "signuplink": {
            "href": "https://www.mollie.com/dashboard/signup/myCode?lang=en",
            "type": "text/html"
        }
    }
}