Skip to main content

Partners and Child-Partners

Partners group users and, optionally, child-partners together and define which API features are available to them.

Main Partner​

The access token you received is for your main PayData API partner. This partner is used to manage the settings, access tokens, child-partners and users.

Use the GetPartnerSelf endpoint to view your current partner.

GET /partners/self
GetPartnerSelf
GET /partner/v2/partners/self HTTP/1.1
Host: sandbox.paydata-api.com
Authorization: Bearer {PartnerToken}
Response — HTTP/1.1 200
{
  "partnerStatistics": {
    "userCount": 3
  },
  "id": "abc123",
  "name": "Test",
  "email": "info@example.com",
  "redirectUrls": [
    "https://redirect.example.com/oauth"
  ],
  "userTokenExpirySeconds": 3600,
  "permissions": [
    "partner:read",
    "partner:update",
    "user:all"
  ],

Permissions​

Your partner has a set of permissions that define the features that can be used and are allowed as access token scopes.

"permissions": [
    "account:all",
    "partner:all",
    "transaction:all",
    "user:all",
    "webhook:all"
]

The features were determined during contract negotiations and can only be changed upon request. Please contact PayData support in that case.

Child-Partners​

Child-partners let you delegate user management to another party or an on-premise system, without giving that party access to your main partner or its other child-partners.

info

Your main partner needs the permission partner:create to create child-partners. Contact PayData support if that is not the case.

Child-partners can be created using the CreatePartner method. The child-partner inherits the permissions defined on your main partner. The initial child-partner access token will contain all available scopes.

A child-partner should manage its own tokens to avoid losing access — see Partner Tokens for the endpoints, both for a child-partner managing its own tokens and for the main partner managing a child-partner's tokens on its behalf.

tip

You may also decide that your system that manages the main partner will provide a short-lived child-partner token after the child-partner authenticates itself. This authentication is outside the scope of the PayData API.

Settings​

The current settings can be requested using the get partner self and get partner endpoints.

Use the update partner self and update partner endpoints to update the settings.

NamePurpose
emailCurrently unused. But will receive important information or used as a login in the future. Change will be announced.
redirectUrlsWhitelist of URLs allowed for the OAuth account authorization redirect. PayData will redirect to the first URL after completing an OAuth flow.
userTokenExpirySecondsLifetime of the access tokens for users. See Token Management.
uiSettingsSeparate redirect URIs and styling settings for the Account UI.
warning

The update endpoints will reset unspecified settings to their defaults or null. Make sure to pass the full partner settings.