Get partner¶
Organizations API v2
GET
https://api.mollie.com/v2/organizations/me/partner
Authentication:Organization access tokensApp access tokens
Retrieve details about the partner status of the currently authenticated organization.
Parameters¶
No parameters applicable for this endpoint.
Response¶
200
application/hal+json
resource
string
Indicates the response contains a partner object. Will always contain
partner
for this endpoint.partnerType
stringIndicates the type of partner. Will be null
if the currently authenticated organization is not enrolled as a
partner.
Possible values: oauth
signuplink
useragent
isCommissionPartner
booleanoptional
Will be true if partner is receiving commissions. Will be omitted otherwise.
userAgentTokens
arrayoptionalArray 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.
partnerContractSignedAt
dateoptional
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
.partnerContractUpdateAvailable
booleanoptional
Will be
true
if an updated contract is available, requiring the partner’s agreement. Will be omitted otherwise._links
objectAn object with several URL objects relevant to the partner resource. Every URL object will contain an href
and a
type
field.
self
URL object
The API resource URL of the partner itself.
documentation
URL object
The URL to the documentation of this endpoint.
signuplink
URL 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¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/organizations/me/partner \ -H "Authorization: Bearer access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" |
1 2 3 4 5 6 7 | require 'mollie-api-ruby' Mollie::Client.configure do |config| config.api_key = 'access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' end partner = Mollie::Partner.current |
1 2 3 4 | We don't have a PHP code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
1 2 3 4 | We don't have a Python code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
1 2 3 4 | We don't have a Node.js code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
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" } } } |