Debt

Debt management

DEBT_GB_INDICATOR_CHANGED

• The debt API triggers the DEBT_GB_INDICATOR_CHANGED notification when the value of the good/bad indicator changes for a contract.

• Event parameters are eventTypeCode/routing_code: ext.debts.contracts.gb-indicators.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_GB_INDICATOR_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:12:26.026Z",
  "data": {
    "contractId": "ID-1000",
    "indicatorValueCode": "GB_01",
    "indicatorFlagCode": "GOOD",
    "endDate": "2025-01-09",
    "generationDtime": "2021-02-23T08:32:33.0759819Z"
  }
}

DEBT_CONTRACT_CHANGED

• The debt API triggers the DEBT_CONTRACT_CHANGED notification when a new contract is created or debt status is changed.

• Event parameters are eventTypeCode/routing_code: ext.debts.contracts.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_CONTRACT_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:22:16.662Z",
  "data": {
    "contractId": "ID-1000",
    "debtStatusLevelCode": "string",
    "debtStatusReasonTypeCode": "CLERK_DECISION",
    "lastNotificationSent": "RL1",
    "nonPerforming": false,
    "oldestOverdueInvoiceDueDate": "2022-01-01",
    "oldestOverdueInvoiceId": "ID-1000",
    "personId": "ID-1000",
    "statusCode": "ACTIVE"
  }
}

DEBT_LETTER_CREATED

• The payment API triggers the DEBT_LETTER_CREATED notification when the debt letter is created.

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_LETTER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:28:20.042Z",
  "data": {
    "letterHeader": {
      "productType": "LOAN_PRODUCT_01",
      "letterType": "RL1",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "birthDate": "1960-01-15",
      "deathDate": "2021-03-15",
      "email": "[e-mail]",
      "phoneNumber": "[phone]",
      "language": "en",
      "deliveryMethodCode": "POST",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ]
    },
    "contractInfo": {
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "amounts": [
        {
          "contextTypeCode": "CURRENT_BALANCE",
          "contextDate": "2021-05-01",
          "money": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "debtMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          }
        }
      ]
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "dueDate": "2021-04-01"
    },
    "invoiceInfo": [
      {
        "invoiceId": "R000000001105",
        "invoiceNumber": "R000000001105",
        "billingDate": "2021-04-30",
        "dueDate": "2021-05-21",
        "money": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "debtMoney": {
          "amount": 1.22,
          "currencyCode": "EUR"
        }
      }
    ]
  }
}