Skip to main content

CreatePartnerResponse

idstringrequired

Partner ID

Possible values: non-empty

Example: 8fkjh5
namestringrequired

Partner name

Possible values: non-empty

Example: First Partner
emailstringnullable

Partner email

Example: partner@example.de
redirectUrlsstring[]nullable

Array of OAuth2 redirect URLs

Example: ["https://example.de/sample_redirect_url1","https://example.de/sample_redirect_url2"]
userTokenExpirySecondsint32

User access token validity time in seconds

Example: 3600
permissionsstring[]nullable

Permissions

Example: ["partner:create","user:create"]
isDeletedboolean

If true, the partner is deleted

Example: false
uiSettings objectnullable

PayData UI settings for the partner

redirectUrlsstring[]nullable

Array of allowed redirect URLs

A redirect URL specified in CreateAccountUi should be in this list

Example: ["https://example.de/ui_redirect_url1","https://example.de/ui_redirect_url2"]
styling objectnullable
headerColorstringnullable

Color of the header background. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: #81c784
headerLogoUrlstringnullable

URI of the header logo.

Example: https://paydata-api.com/paytrans-api-wAssets/img/PayData-Logo_final_powered_by.png
bodyColorstringnullable

Color of the body background. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: #c8e6c9
textColorstringnullable

Color of the body text. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: #000000
accordionFocusedOutlineColorstringnullable

Color of accordions outline when focused. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgba(175, 230, 201, 0.5)
accordionExpandedColorstringnullable

Color of accordions background when expanded. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(154, 211, 177)
accordionExpandedTextColorstringnullable

Color of accordions text when expanded. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
accordionCollapsedBgColorstringnullable

Color of accordions background when collapsed. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(154, 211, 177)
accordionCollapsedTextColorstringnullable

Color of accordions text when collapsed. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
accordionBodyColorstringnullable

Color of accordions body. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: white
backButtonBorderColorstringnullable

Color of the back button border. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
backButtonBgColorstringnullable

Color of the back button background. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
backButtonTextColorstringnullable

Color of the back button text. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
cancelButtonBorderColorstringnullable

Color of the cancel button border. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
cancelButtonBgColorstringnullable

Color of the cancel button background. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
cancelButtonTextColorstringnullable

Color of the cancel button text. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextButtonBorderColorstringnullable

Color of the next button border. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextButtonBgColorstringnullable

Color of the next button background. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextButtonTextColorstringnullable

Color of the next button text. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextDisabledButtonBorderColorstringnullable

Color of the next button border when disabled. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextDisabledButtonBgColorstringnullable

Color of the next button background when disabled. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
nextDisabledButtonTextColorstringnullable

Color of the next button text when disabled. Should be valid CSS color value.

Possible values: <= 30 characters, Value must match regular expression [a-zA-Z0-9%/#,.() +-:]+

Example: rgb(255, 255, 255)
token objectnullable
idstringnullable

Token ID

Example: 9fkgh6
namestringnullable

Token name

createdAtdate-timerequired

Token creation date and time

Example: 2022-12-21T10:01:11.123
expiresInint32required

Token validity period in seconds

Example: 3600
expiresAtdate-timerequired

Token expiry date and time

Example: 2022-12-21T10:01:11.123
isRevokedbooleanrequired

If the value is true, the token has been revoked

isExpiredbooleanrequired

If the value is true, the token has expired

isValidbooleanrequired

If the value is true, the token is valid

The token is not valid if it is either revoked or expired. Only valid tokens can be used to access the API.

scopestringrequired

Scopes, delimited with space

Possible values: non-empty

Example: partner:create user:create
lastUsedAtdate-timenullable

Date and time when the token was last used

Example: 2023-04-21T10:01:11.123
revokedAtdate-timenullable

Date and time when the token was revoked

Example: 2023-04-21T10:01:11.123
accessTokenstringrequired

Access token

Possible values: non-empty

Example: zxMbx_TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5TREuRHc6a8X30RrGBTyqV9h26KJHcLKJbZ
CreatePartnerResponse
{
  "id": "8fkjh5",
  "name": "First Partner",
  "email": "partner@example.de",
  "redirectUrls": [
    "https://example.de/sample_redirect_url1",
    "https://example.de/sample_redirect_url2"
  ],
  "userTokenExpirySeconds": 3600,
  "permissions": [
    "partner:create",
    "user:create"
  ],
  "isDeleted": false,
  "uiSettings": {
    "redirectUrls": [
      "https://example.de/ui_redirect_url1",
      "https://example.de/ui_redirect_url2"
    ],
    "styling": {
      "headerColor": "#81c784",
      "headerLogoUrl": "https://paydata-api.com/paytrans-api-wAssets/img/PayData-Logo_final_powered_by.png",
      "bodyColor": "#c8e6c9",
      "textColor": "#000000",
      "accordionFocusedOutlineColor": "rgba(175, 230, 201, 0.5)",
      "accordionExpandedColor": "rgb(154, 211, 177)",
      "accordionExpandedTextColor": "rgb(255, 255, 255)",
      "accordionCollapsedBgColor": "rgb(154, 211, 177)",
      "accordionCollapsedTextColor": "rgb(255, 255, 255)",
      "accordionBodyColor": "white",
      "backButtonBorderColor": "rgb(255, 255, 255)",
      "backButtonBgColor": "rgb(255, 255, 255)",
      "backButtonTextColor": "rgb(255, 255, 255)",
      "cancelButtonBorderColor": "rgb(255, 255, 255)",
      "cancelButtonBgColor": "rgb(255, 255, 255)",
      "cancelButtonTextColor": "rgb(255, 255, 255)",
      "nextButtonBorderColor": "rgb(255, 255, 255)",
      "nextButtonBgColor": "rgb(255, 255, 255)",
      "nextButtonTextColor": "rgb(255, 255, 255)",
      "nextDisabledButtonBorderColor": "rgb(255, 255, 255)",
      "nextDisabledButtonBgColor": "rgb(255, 255, 255)",
      "nextDisabledButtonTextColor": "rgb(255, 255, 255)"
    }
  },
  "token": {
    "id": "9fkgh6",
    "name": "string",
    "createdAt": "2022-12-21T10:01:11.123",
    "expiresIn": 3600,
    "expiresAt": "2022-12-21T10:01:11.123",
    "isRevoked": true,
    "isExpired": true,
    "isValid": true,
    "scope": "partner:create user:create",
    "lastUsedAt": "2023-04-21T10:01:11.123",
    "revokedAt": "2023-04-21T10:01:11.123",
    "accessToken": "zxMbx_TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5TREuRHc6a8X30RrGBTyqV9h26KJHcLKJbZ"
  }
}