search
Developer portal

Account

hashtag
Account application

chevron-rightACCOUNT_APPLICATION_CREATEDhashtag

  • 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"
  }
}
chevron-rightACCOUNT_APPLICATION_CONFIRMEDhashtag

  • 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"
  }
}
chevron-rightACCOUNT_APPLICATION_PENDINGhashtag

  • 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"
  }
}
chevron-rightACCOUNT_APPLICATION_ACCEPTEDhashtag

  • 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"
  }
}
chevron-rightACCOUNT_APPLICATION_CANCELLEDhashtag

  • 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"
  }
}
chevron-rightACCOUNT_APPLICATION_REJECTEDhashtag

  • 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.

chevron-rightACCOUNT_APPLICATION_PROCESSEDhashtag

  • 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.

hashtag
Account management

chevron-rightACCOUNT_CREATEDhashtag

  • 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.

chevron-rightACCOUNT_ACTIVATEDhashtag

  • 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.

chevron-rightACCOUNT_CHANGEDhashtag

  • 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.

chevron-rightACCOUNT_BLOCKEDhashtag

  • 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.

chevron-rightACCOUNT_CLOSEDhashtag

  • 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.

chevron-rightACCOUNT_NUMBER_CREATEDhashtag

  • 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.

chevron-rightACCOUNT_NUMBER_CHANGEDhashtag

  • 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.

hashtag
Account overdraft

chevron-rightACCOUNT_OVERDRAFT_CONTRACT_ACTIVATEDhashtag

  • The account API triggers the ACCOUNT_OVERDRAFT_CONTRACT_ACTIVATED event whenever a new overdraft contract is created or when a new contract version is generated as a result of a modification or extension.

  • To correctly identify a modification or extension scenario, users should match the terminated and activated versions using the contractNumber field, which must have the same value in the ACCOUNT_OVERDRAFT_CONTRACT_TERMINATED notification.

chevron-rightACCOUNT_OVERDRAFT_CONTRACT_TERMINATEDhashtag

  • The account API triggers the ACCOUNT_OVERDRAFT_CONTRACT_TERMINATED event whenever an overdraft contract is terminated or otherwise becomes invalid, such as through modification or extension.

  • The content of the ACCOUNT_OVERDRAFT_CONTRACT_TERMINATED message, in the event of termination, consists of the following combination of parameter values:

    • statusCode = CLOSED

    • statusReasonCode equals to one of:

      • TERMINATED_BY_REQUEST

      • TERMINATED_EXPIRED

circle-exclamation

To correctly identify a modification or extension scenario, users should:

  • In the ACCOUNT_OVERDRAFT_CONTRACT_TERMINATED notification, check:

    • statusCode = CLOSED

    • statusReasonCode equals to one of:

      • PROLONGED

      • CHANGED

  • and match the terminated and activated versions using the contractNumber field, which must have the same value in the ACCOUNT_OVERDRAFT_CONTRACT_ACTIVATED notification.

hashtag
Account reservation

chevron-rightACCOUNT_RESERVATION_CREATED_V3hashtag

  • 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.

chevron-rightACCOUNT_RESERVATION_CHANGED_V3hashtag

  • 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.

chevron-rightACCOUNT_RESERVATION_RELEASED_V3hashtag

  • 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.

hashtag
Account transaction

chevron-rightACCOUNT_TRANSACTION_CREATED_V3hashtag

  • 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.

chevron-rightACCOUNT_TRANSACTION_REVERSED_V3hashtag

  • The account API triggers ACCOUNT_TRANSACTION_REVERSED_V3 event if a transaction was reversed.

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

hashtag
Account balance

chevron-rightACCOUNT_BALANCE_CHANGEDhashtag

  • 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.

hashtag
Account right

chevron-rightACCOUNT_RIGHT_CREATEDhashtag

  • 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.

chevron-rightACCOUNT_RIGHT_REMOVEDhashtag

  • 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.

hashtag
Account custom field

chevron-rightACCOUNT_CUSTOM_FIELD_CHANGEDhashtag

  • 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.

chevron-rightACCOUNT_CUSTOM_FIELD_REMOVEDhashtag

  • 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.

hashtag
Account import

chevron-rightACCOUNT_IMPORT_PROCESS_PROCESSEDhashtag

  • 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.

chevron-rightACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSEDhashtag

  • 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.

chevron-rightACCOUNT_IMPORT_PROCESS_ERRORhashtag

  • 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.

PreviousPersonNextDeposit

Last updated

Was this helpful?