GetAccountsResponse

accounts object[]nullable

Accounts list

Array [

idstringrequired

Account identifier

Possible values: non-empty

Example: 5dshw36

accountTypeIdstringrequired

Account type identifier

Possible values: non-empty

Example: amazon

namestringnullable

Account name

Example: Connector to Amazon #1

statusstringrequired

Account status

• Idle - OK, no processing currently takes place
• Updating - OK, transactions are currently being downloaded
• PreparingUpdate - OK, transactions download is about to start
• OtherError
• ErrorCredentialsFailed
• ErrorCredentialsMissing

Possible values: non-empty

Example: Idle

elementStatistics objectnullable

Element statistics

countint32

The number of elements

Example: 123

firstdate-timenullable

First element date

Example: 2021-11-17T12:15:16

lastdate-timenullable

Last element date

Example: 2021-11-17T12:15:16

accountFields objectnullable

Account fields

The fields list depends on the account type

property name*stringnullable

errors object[]nullable

List of errors currently active on the account.

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

warnings object[]nullable

List of warnings currently active on the account.

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

]

GetAccountsResponse

{
  "accounts": [
    {
      "id": "5dshw36",
      "accountTypeId": "amazon",
      "name": "Connector to Amazon #1",
      "status": "Idle",
      "elementStatistics": {
        "count": 123,
        "first": "2021-11-17T12:15:16",
        "last": "2021-11-17T12:15:16"
      },
      "accountFields": {
        "start-date": "2021-11-29T00:00:00",
        "marketplace": "amazon.de"
      },
      "errors": [
        {
          "type": "AccountCredentialsInvalid",
          "message": "string",
          "providerMessage": "string",
          "isUserActionRequired": true,
          "isTemporary": false
        }
      ],
      "warnings": [
        {
          "Message": "Credentials are expiring on 2024-09-01",
          "Type": "CredentialsExpiration",
          "IsUserActionRequired": true
        }
      ]
    }
  ]
}