Skip to main content

UserUi

intent stringrequired

Possible values: [LoginOrRegistration, CreateAccount]

intentUserIdstringnullable

An optional user ID to use for the user UI session.

idstringrequired

User UI session ID

This ID should be used to get the user creation status

Possible values: non-empty

Example: kjsd7bwu5
secretstringnullable

Session secret needed to get the status of the session.

statusUserUiStatusrequired

User UI session status

Possible values: [Unopened, Opened, Completed, Canceled, Expired]

Example: Success
expiresIninteger<int32>required

User UI session validity period in seconds

Example: 3600
createdAtstring<date-time>required

User UI session creation date and time

Example: 2023-01-26T10:01:11.123
expiresAtstring<date-time>nullable

User UI session expiry date and time if the session is unopened or opened. Is null if the session is completed, canceled, or already expired.

Example: 2023-01-26T10:21:11.123
userIdstringnullable

Created user ID (available after user creation)

Example: 5dshw36
user objectnullable
idstringrequired

User ID

Possible values: non-empty

Example: 8fkjh5
namestringrequired

User name

Possible values: non-empty

Example: User-123
registrationstring<date-time>required

Registration date

Example: 2021-12-01T10:01:11.123
lastTransferstring<date-time>nullable

Last transfer date

Example: 2021-12-01T10:01:11.123
lastExportstring<date-time>nullable

Last export date

Example: 2021-12-01T10:01:11.123
deletedAtstring<date-time>nullable

User deletion date

Example: 2023-11-21T10:01:11.123
isDeletedboolean

If true, the user is deleted

Example: false
isActiveboolean

If true, the user is active

Example: false
emailstringnullable

User Email

Example: partner@example.de
token object
idstringnullable

Token ID

Example: 9fkgh6
namestringnullable

Token name

createdAtstring<date-time>required

Token creation date and time

Example: 2022-12-21T10:01:11.123
expiresIninteger<int32>required

Token validity period in seconds

Example: 3600
expiresAtstring<date-time>required

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
lastUsedAtstring<date-time>nullable

Date and time when the token was last used

Example: 2023-04-21T10:01:11.123
revokedAtstring<date-time>nullable

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
accountIdstringnullable

Created account ID (available after account creation)

Example: 5dshw36
urlstringrequired

User UI URL

the user should open This URL.

Possible values: non-empty

Example: https://customer-center.paydata-api.com/session/kjsd7bwu5
UserUi
{
  "intent": "LoginOrRegistration",
  "id": "kjsd7bwu5",
  "secret": "string",
  "status": "Success",
  "expiresIn": 3600,
  "createdAt": "2023-01-26T10:01:11.123",
  "expiresAt": "2023-01-26T10:21:11.123",
  "userId": "5dshw36",
  "user": {
    "id": "8fkjh5",
    "name": "User-123",
    "registration": "2021-12-01T10:01:11.123",
    "lastTransfer": "2021-12-01T10:01:11.123",
    "lastExport": "2021-12-01T10:01:11.123",
    "deletedAt": "2023-11-21T10:01:11.123",
    "isDeleted": false,
    "isActive": false,
    "email": "partner@example.de",
    "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"
    }
  },
  "accountId": "5dshw36",
  "url": "https://customer-center.paydata-api.com/session/kjsd7bwu5"
}