Skip to main content

CreateTestAccountTypeEventResponse

notifications object[]

Array of notifications

  • Array [
    • eventType stringrequired

    Event Type

    Possible values: [AccountCreated, AccountDeleted, AccountUpdated, AccountTypeUpdated, TransactionsImported]

    eventData object

    Account event details

    partnerIdstringnullable

    Partner ID

    userIdstringnullable

    User ID

    account object

    Account details

    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
    • Error
    • ErrorCredentialsFailed
    • ErrorCredentialsMissing

    Possible values: non-empty

    Example: Idle
    elementStatistics object

    Element statistics

    countinteger<int32>

    The number of elements

    Example: 123
    firststring<date-time>nullable

    First element date

    Example: 2021-11-17T12:15:16
    laststring<date-time>nullable

    Last element date

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

    Account fields

    The fields list depends on the account type

    property name*stringnullable
    errors object[]

    List of errors currently active on the account.

  • Array [
    • typestring

    Type or general classification of the error.

    Example: AccountCredentialsInvalid
    messagestring

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

    List of warnings currently active on the account.

  • Array [
    • typestring

    Type or general classification of the error.

    Example: AccountCredentialsInvalid
    messagestring

    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
  • ]
    • idstring

    Notification Id

    webhookIdstring

    Webhook Id

    eventRaisedAtstring<date-time>

    Date and time when the event was triggered

    eventData object

    Account type event details

    partnerIdstringnullable

    Partner ID

    accountType object

    Account type details

    idstringrequired

    Account type ID

    The value is used as the accountTypeId parameter for the CreateAccount method

    Possible values: non-empty

    Example: amazon
    namestringrequired

    Account type name

    Possible values: non-empty

    Example: Amazon account
    logos object

    Logos of the account type.

    A dictionary of logos of different styles. The key is the logo style (standard, gray, etc.), the value is the URL of the Logo

    property name*string
    helpUrls object

    A dictionary of help URLs. The key is the help type.

    Setupstring
    Accountingstring
    Troubleshootingstring
    deprecatedboolean

    If the value is true, accounts of this type cannot be created.

    A better alternative account type is available for the provider and should be used instead. The metadata for existing accounts of deprecated account types is still required.

    Example: false
    connectionTestSupportedboolean

    If the value is true, accounts of this type support a connection test against the provider

    hasPspReportsboolean

    true for accounts types where the PSP provides settlement/transaction reports.

    For these report based account types, the reports can be listed using the GetReports method. A single report can be retrieved using the GetReport method. Report IDs can be used along with other parameters to retrieve transactions using the GetTransactions method.

    For non-report based accounts the GetReports and GetReport methods are not available and return a 400 Bad Request.

    Example: true
    accountFields object[]

    Available and required fields for the account type.

    Fields in this array describe the accountFields dictionary, that should be provided in the request for the CreateAccount method

    It is advisable to use the information in this array to dynamically create the user interface for the chosen account type. In this case new account types can automatically be made available to the partner software without additional coding.

  • Array [
    • idstringrequired

    Field ID

    Used as the key for corresponding element of the accountFields dictionary when calling the CreateAccount method

    Possible values: non-empty

    Example: metadata-field
    namestringrequired

    User visible name of the field.

    Possible values: non-empty

    Example: Payment metadata field
    shortDescriptionstringnullable

    Short description of the field that can be displayed under or next to input fields.

    Example: Start date
    descriptionstringnullable

    Detailed description of the field.

    Example: Transactions are downloaded beginning from that date
    requiredboolean

    Whether or not the field is required.

    If true, the field shold be present in the accountFields dictionary when calling the CreateAccount method

    Example: false
    requiredDuringAuthboolean

    For account types with an OAuth flow, this defines if the value must be provided during creation of the OAuth URL.

    Example: false
    typeCredentialFieldType

    Data type of the field.

    • Auth: Accounts of that type require OAuth2 authentication.
    • Selection: The value of the field should be selected from the values array.

    Possible values: [Text, Url, Auth, Password, Date, TextLine, Checkbox, Selection, File]

    Example: Text
    generatedboolean

    If true, the value of the field is generated when the account is created.

    Used for API keys and other credentials. The partner software should store the generated values and use them for future calls as values of account fields, provided while creating or updating an account.

    Example: true
    readOnlyboolean

    The value of the field is read-only and cannot be changed.

    Example: true
    defaultValuestringnullable

    Optional default value of the field that can be used to pre-fill the user input.

    Example: 2021.11.29T00:00:00
    values object[]

    If type is Selection then this array contains the available values.

  • Array [
    • namestring

    Human readable name of the selection value.

    Example: Market place
    valuestring

    Value of the selection for API usage.

    Example: amazon.de
  • ]
    • minValuestringnullable

    Minimum value.

    Example: -100
    maxValuestringnullable

    Maximum value.

    Example: 100
    requiredFieldsstring[]deprecated

    If type is Auth then the referenced fields are required in order to obtain the redirect URL.

    Example: ["start-date"]
    isDeprecatedboolean

    Whether the field is deprecated and should not be used anymore.

    Example: false
    deprecationReasonstringnullable

    Reason for the field deprecation and replacement.

  • ]
    • transactionFields object[]

    Transaction fields for the account type.

    Each field is a description of the corresponding transaction field, returned by the GetTransactions method

    Currently the following field types are used:

    • uniqueId Unique transaction identifier
    • bookingDate Booking date
    • valueDate Value date
    • reportDepositDate Report deposit date
    • payerBankCode Payer bank code (Bankleitzahl)
    • payerBic International payer bank code
    • payerAccountNumber Payer account number
    • payerIban Payer IBAN
    • payerName1 Payer name 1 (first name, company or email)
    • payerName2 Payer name 2 (first name, company or email)
    • invoiceNumber Invoice number
    • orderNumber Order number
    • transactionId Transaction id specified by provider
    • customerId Customer identification (ID, name or number)
    • reference1 - reference4 Transaction reference 1 - 4 (various information)
    • marketplace Marketplace
    • paymentType Payment type

    For each account type this array returns fields that are applicable to that account type. The names and descriptions of some fields for some account types can be different, these specific names and descriptions are also returned in the array

  • Array [
    • idstringrequired

    Transaction field ID

    Possible values: non-empty

    Example: bookingDate
    namestringrequired

    Transaction field name

    Possible values: non-empty

    Example: Booking date
    descriptionstringnullable

    Transaction field Description

    Example: Date the transaction was performed
    isDeprecatedboolean

    Whether the field is deprecated and should not be used anymore.

    Example: false
    deprecationReasonstringnullable

    Reason for the field deprecation and replacement.

  • ]
    • errors object[]

    List of errors currently active on the account type.

  • Array [
    • typestring

    Type or general classification of the error.

    Example: AccountCredentialsInvalid
    messagestring

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

    List of warnings currently active on the account type.

  • Array [
    • typestring

    Type or general classification of the error.

    Example: AccountCredentialsInvalid
    messagestring

    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
  • ]
    • statestring

    Account type state

    Ok, Degraded, Down, Maintenance or Disabled

    authOptionalboolean

    If true, authentication is optional and can be skipped during account creation. Default is false (authentication is required).

    Example: false
  • ]
    • CreateTestAccountTypeEventResponse
    {
      "notifications": [
        {
          "eventData": {
            "partnerId": "string",
            "accountType": {
              "id": "amazon",
              "name": "Amazon account",
              "logos": {},
              "helpUrls": {
                "Setup": "string",
                "Accounting": "string",
                "Troubleshooting": "string"
              },
              "deprecated": false,
              "connectionTestSupported": true,
              "hasPspReports": true,
              "accountFields": [
                {
                  "id": "metadata-field",
                  "name": "Payment metadata field",
                  "shortDescription": "Start date",
                  "description": "Transactions are downloaded beginning from that date",
                  "required": false,
                  "requiredDuringAuth": false,
                  "type": "Text",
                  "generated": true,
                  "readOnly": true,
                  "defaultValue": "2021.11.29T00:00:00",
                  "values": [
                    {
                      "name": "Market place",
                      "value": "amazon.de"
                    }
                  ],
                  "minValue": "-100",
                  "maxValue": "100",
                  "isDeprecated": false,
                  "deprecationReason": "string"
                }
              ],
              "transactionFields": [
                {
                  "id": "bookingDate",
                  "name": "Booking date",
                  "description": "Date the transaction was performed",
                  "isDeprecated": false,
                  "deprecationReason": "string"
                }
              ],
              "errors": [
                {
                  "Message": "Authentication with the payment provider is currently not possible",
                  "Type": "LoginFailure",
                  "IsUserActionRequired": false
                },
                {
                  "Message": "Authentication with the payment provider is currently not possible",
                  "Type": "LoginFailure",
                  "IsUserActionRequired": false
                }
              ],
              "warnings": [
                {
                  "type": "AccountCredentialsInvalid",
                  "message": "string",
                  "providerMessage": "string",
                  "isUserActionRequired": true,
                  "isTemporary": false
                }
              ],
              "state": "string",
              "authOptional": false
            }
          },
          "eventType": "string",
          "id": "string",
          "webhookId": "string",
          "eventRaisedAt": "2024-07-29T15:51:28.071Z"
        }
      ]
    }