GetPartnersResponse

partners object[]nullable

Array of partners

Array [

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"]

userTokenExpirySecondsinteger<int32>

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)

partnerStatistics objectnullable

Partner statistics

userCountinteger<int32>

Number of users

Example: 123

]

pagination objectnullable

Pagination info

pageNumberinteger<int32>

Returned page number

Example: 1

previousPageReferencestringnullable

Reference to get the previous page

nextPageReferencestringnullable

Reference to get the next page

previousPagestring<uri>nullable

URL of the previous page

nextPagestring<uri>nullable

URL of the next page

pageSizeinteger<int32>

Number of items per page

Example: 25

pagesCountinteger<int32>nullable

Total number of pages

Example: 5

totalCountinteger<int32>

Total number of items

Example: 125

GetPartnersResponse

{
  "partners": [
    {
      "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)"
        }
      },
      "partnerStatistics": {
        "userCount": 123
      }
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
  }
}