Deposit

Deposit management

DEPOSIT_EVENT_CREATED

• The deposit API triggers the DEPOSIT_EVENT_CREATED event if any of the deposit creation-related events is created (for example, INTEREST_INCREASE or FUND_DEPOSIT).

• Event parameters are eventTypeCode/routing_code: ext.deposits.events.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_EVENT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "eventId": "string",
    "headerId": "string",
    "versionId": "string",
    "componentTypeCode": "string",
    "eventTypeCode": "string",
    "postingDate": "2023-07-21",
    "valueDate": "2023-07-21",
    "initialBalanceMoney": {
      "amount": 0,
      "currencyCode": "str"
    },
    "eventMoney": {
      "amount": 0,
      "currencyCode": "str"
    },
    "balanceDirectionCode": "string",
    "details": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "countryCode": "string",
    "depositGroupCode": "string",
    "depositClassCode": "string",
    "contractNumber": "string",
    "bankingDate": "2023-07-21",
    "eventDTime": "2023-07-21T07:47:15.254Z",
    "reversedEventId": "string"
  }
}

DEPOSIT_OFFER_PRESENTED_V2

• The deposit API triggers the DEPOSIT_OFFER_PRESENTED_V2 event when a deposit offer is presented, and its status is set to PRESENTED.

• Event parameters are eventTypeCode/routing_code: ext.deposits.offersV2.presented.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_OFFER_PRESENTED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T07:01:05.142Z",
  "data": {
    "interestRate": 0,
    "groupable": true,
    "taxExempt": true,
    "period": 0,
    "bankingDate": "2024-08-14",
    "endDate": "2024-08-14",
    "lastValidDate": "2024-08-14",
    "maturityDate": "2024-08-14",
    "postingDate": "2024-08-14",
    "offeredMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "returnMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "messageDTime": "2024-08-14T07:01:05.142Z",
    "accountId": "string",
    "applicationId": "string",
    "channelCode": "string",
    "countryCode": "string",
    "depositTypeCode": "string",
    "interestPaymentFreqCode": "string",
    "offerId": "string",
    "periodTypeCode": "string",
    "personId": "string",
    "personTypeCode": "string",
    "prolongationCode": "string",
    "reasonCode": "string",
    "statusCode": "string",
    "taxResidencyCountryCode": "string",
    "tenantCode": "string",
    "uniqueId": "string"
  }
}

Deposit contract

DEPOSIT_CONTRACT_ACTIVATED_V2

• The deposit API triggers the DEPOSIT_CONTRACT_ACTIVATED_V2 event when a deposit contract is activated, and its status is set to ACTIVE.

• Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.activated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_ACTIVATED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:15:21.415Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}

DEPOSIT_CONTRACT_PROLONGED_V2

• The deposit API triggers the DEPOSIT_CONTRACT_PROLONGED_V2 event when a deposit contract is prolonged, and its status is set to PROLONGED.

• Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.prolonged.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_PROLONGED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:31:37.763Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}

DEPOSIT_CONTRACT_TERMINATED_V2

• The deposit API triggers the DEPOSIT_CONTRACT_TERMINATED_V2 event when a deposit contract is terminated, and its status is set to TERMINATED.

• Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.terminated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_TERMINATED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:38:50.424Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}

DEPOSIT_CONTRACT_CLOSED_V2

• The deposit API triggers the DEPOSIT_CONTRACT_CLOSED_V2 event when a deposit contract is closed, and its status is set to CLOSED.

• Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.closed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_CLOSED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:25:39.174Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}

Deposit custom field

DEPOSIT_CUSTOM_FIELD_CHANGED

• The deposit API triggers the DEPOSIT_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }

}

DEPOSIT_CUSTOM_FIELD_REMOVED

• The deposit API triggers the DEPOSIT_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}