Account

Account application

ACCOUNT_APPLICATION_CREATED
  • The account API triggers ACCOUNT_APPLICATION_CREATED event when a new account application is inserted, and its status is set to INSERTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.inserted.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:34:00.008Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "INSERTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_CONFIRMED
  • The account API triggers ACCOUNT_APPLICATION_CONFIRMED event when an account application is prepared, and its status is set to PREPARED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.prepared.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CONFIRMED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:36:14.298Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PREPARED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_PENDING
  • The account API triggers ACCOUNT_APPLICATION_PENDING event when an account application is pended, and its status is set to PENDING.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.pending

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_PENDING",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:49:36.193Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PENDING",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_ACCEPTED
  • The account API triggers ACCOUNT_APPLICATION_ACCEPTED event when an account application is accepted, and its status is set to ACCEPTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.accepted

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:05:22.293Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACCEPTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_CANCELLED
  • The account API triggers ACCOUNT_APPLICATION_CANCELLED event when an account application is canceled, and its status is set to CANCELLED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.cancelled

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CANCELLED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:27:18.115Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "CANCELLED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_REJECTED
  • The account API triggers ACCOUNT_APPLICATION_REJECTED event when an account application is rejected, and its status is set to REJECTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.rejected.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_REJECTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:58:09.062Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "REJECTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_PROCESSED
  • The account API triggers ACCOUNT_APPLICATION_PROCESSED event when an account application is processed, and its status is set to PROCESSED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:54:43.887Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PROCESSED",
    "statusReasonCode": "ON_HOLD"
  }
}

Account management

ACCOUNT_CREATED
  • The account API triggers ACCOUNT_CREATED event when a new account is created, and its status is set to CREATED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:09:45.310Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_ACTIVATED
  • The account API triggers ACCOUNT_ACTIVATED event when a new account is activated, and its status is set to ACTIVE.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.activated.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:15:21.289Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_CHANGED
  • The account-API triggers the ACCOUNT_CHANGED event if account details have been changed. For example, changing the interest method, account access, class code, and other similar changes.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:16:30.390Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_BLOCKED
  • The account API triggers ACCOUNT_BLOCKED event when an account is blocked, and its status is set to BLOCKED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.blocked.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_BLOCKED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:17:24.712Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_CLOSED
  • The account API triggers ACCOUNT_CLOSED event when an account is closed, and its status is set to CLOSED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.closed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CLOSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:18:27.880Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_NUMBER_CREATED
  • The account API triggers the ACCOUNT_NUMBER_CREATED event when a new bank account number is generated. This event occurs when a new account is created or additional account numbers are added to an existing account.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.account-numbers.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:19:36.617Z",
  "data": {
    "accountId": "ID-1000",
    "accountNumberId": "ID-1000",
    "accountNumber": {
      "value": "DE89370400440532013000",
      "type": "IBAN"
    },
    "accountNumberSubtype": "BANKGIRO",
    "financialInstitutionId": {
      "value": "MAINDE2XXXX",
      "type": "BIC"
    },
    "countryCode": "EE",
    "defaultCurrencyCode": "EUR",
    "externalSyncEnabled": false,
    "statusCode": "ENABLED",
    "validityRange": {
      "startTime": "2025-05-16T11:19:36.618Z",
      "endTime": "2025-05-16T11:19:36.618Z"
    }
  }
}
ACCOUNT_NUMBER_CHANGED
  • The account-API triggers the ACCOUNT_NUMBER_CHANGED event if an unnecessary or unused account number or ALIAS identifier is invalidated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.account-numbers.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:20:31.653Z",
  "data": {
    "accountId": "ID-1000",
    "accountNumberId": "ID-1000",
    "accountNumber": {
      "value": "DE89370400440532013000",
      "type": "IBAN"
    },
    "accountNumberSubtype": "BANKGIRO",
    "financialInstitutionId": {
      "value": "MAINDE2XXXX",
      "type": "BIC"
    },
    "countryCode": "EE",
    "defaultCurrencyCode": "EUR",
    "externalSyncEnabled": false,
    "statusCode": "ENABLED",
    "validityRange": {
      "startTime": "2025-05-16T11:20:31.653Z",
      "endTime": "2025-05-16T11:20:31.653Z"
    }
  }
}

Account reservation

ACCOUNT_RESERVATION_CREATED_V3
  • The account API triggers ACCOUNT_RESERVATION_CREATED_V3 event if a new reservation at account was created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.reserved.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_CREATED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:34:47.767Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:34:47.767Z",
    "releasedTime": "2024-12-20T11:34:47.767Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_RESERVATION_CHANGED_V3
  • The account API triggers ACCOUNT_RESERVATION_CHANGED_V3 event if an existing reservation was changed.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_CHANGED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:28:32.506Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:28:32.506Z",
    "releasedTime": "2024-12-20T11:28:32.506Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_RESERVATION_RELEASED_V3
  • The account API triggers ACCOUNT_RESERVATION_RELEASED_V3 event if an existing reservation was released.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.released.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_RELEASED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:32:16.751Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:32:16.751Z",
    "releasedTime": "2024-12-20T11:32:16.751Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}

Account transaction

ACCOUNT_TRANSACTION_CREATED_V3
  • The account API triggers ACCOUNT_TRANSACTION_CREATED_V3 event if a transaction was created at an account.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.transactionsV3.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_TRANSACTION_CREATED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:38:30.197Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "accountTransactionId": "ID-102920",
    "postingDate": "2021-06-21",
    "valueDate": "2021-06-21",
    "transactionTypeCode": "CARD_CASH_MC_EU",
    "transactionSubtypeCode": "TRANS_SUB",
    "directionCode": "OUT",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "counterpartyIban": "string",
    "counterpartyName": "Edythe",
    "counterpartyBic": "string",
    "details": "string",
    "referenceNumber": "string",
    "countryCode": "FI",
    "merchantInfo": "string",
    "metaInfo": "string",
    "reconciliationReference": "ID-1515",
    "reconciliationReferenceSource": "PAYMENT",
    "tenantCode": "MB",
    "paymentCountryCode": "FI",
    "transactionDTime": "2021-04-30T09:04:37.108561Z",
    "reversedTransactionId": "ID-12992",
    "reversed": true,
    "reversal": true,
    "bankingDate": "2021-05-12",
    "virtualAccountId": "ID-1000",
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reservationId": "ID-1001",
    "usingLimit": false,
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_TRANSACTION_REVERSED_V3
  • The account API triggers ACCOUNT_TRANSACTION_REVERSED_V3 event if a transaction was reversed.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.transactionsV3.reversed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_GENERATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:41:36.715Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "accountTransactionId": "ID-102920",
    "postingDate": "2021-06-21",
    "valueDate": "2021-06-21",
    "transactionTypeCode": "CARD_CASH_MC_EU",
    "transactionSubtypeCode": "TRANS_SUB",
    "directionCode": "OUT",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "counterpartyIban": "string",
    "counterpartyName": "Edythe",
    "counterpartyBic": "string",
    "details": "string",
    "referenceNumber": "string",
    "countryCode": "FI",
    "merchantInfo": "string",
    "metaInfo": "string",
    "reconciliationReference": "ID-1515",
    "reconciliationReferenceSource": "PAYMENT",
    "tenantCode": "MB",
    "paymentCountryCode": "FI",
    "transactionDTime": "2021-04-30T09:04:37.108561Z",
    "reversedTransactionId": "ID-12992",
    "reversed": true,
    "reversal": true,
    "bankingDate": "2021-05-12",
    "virtualAccountId": "ID-1000",
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reservationId": "ID-1001",
    "usingLimit": false,
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}

Account balance

ACCOUNT_BALANCE_CHANGED
  • The account-API triggers the ACCOUNT_BALANCE_CHANGED event in scenarios such as:

    • Account transaction creation, update, or cancellation,

    • Reservation creation, update, release, or cancellation,

    • Overdraft limit updates.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_BALANCE_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:20:31.669Z",
  "data": {
    "balanceId": "ID-1000",
    "accountId": "ID-2000",
    "personId": "ID-3000",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDED",
    "balanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservedAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "overdraftLimitAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "availableBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "availableBalanceInDefaultCcy": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "defaultCurrencyCode": "EUR"
  }
}

Account right

ACCOUNT_RIGHT_CREATED
  • The account API triggers ACCOUNT_RIGHT_CREATED event if an account access right was created or updated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.rights.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RIGHT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:42:39.259Z",
  "data": {
    "accountRightId": "string",
    "accountId": "string",
    "personId": "string",
    "rightCode": "string",
    "validityRange": {
      "startTime": "2024-06-03T08:42:39.259Z",
      "endTime": "2024-06-03T08:42:39.259Z"
    }
  }
}
ACCOUNT_RIGHT_REMOVED
  • The account API triggers ACCOUNT_RIGHT_REMOVED event if an existing access right was changed or terminated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.rights.closed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RIGHT_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:45:41.595Z",
  "data": {
    "accountRightId": "string",
    "accountId": "string",
    "personId": "string",
    "rightCode": "string",
    "validityRange": {
      "startTime": "2024-06-03T08:45:41.595Z",
      "endTime": "2024-06-03T08:45:41.595Z"
    }
  }
}

Account custom field

ACCOUNT_CUSTOM_FIELD_CHANGED
  • The account API triggers ACCOUNT_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.custom-fields.fields.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:21:55.169Z",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }
}
ACCOUNT_CUSTOM_FIELD_REMOVED
  • The account API triggers ACCOUNT_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.custom-fields.fields.deleted.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:26:33.236Z",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}

Account import

ACCOUNT_IMPORT_PROCESS_PROCESSED
  • The account API triggers the ACCOUNT_IMPORT_PROCESS_PROCESSED event when the account data import process is complete, and all imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:17:57.322Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}
ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED
  • The account API triggers the ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED event when the account data import process is partially successful and only part of imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.partially-processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T10:01:58.546Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}
ACCOUNT_IMPORT_PROCESS_ERROR
  • The account API triggers an ACCOUNT_IMPORT_PROCESS_ERROR event when the account data import process completes with failure, and no imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.error.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_ERROR",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T09:53:00.375Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}

Last updated

Was this helpful?