Loan

Loan application

chevron-rightLOAN_APPLICATION_ACCEPTEDhashtag
  • The loan-api triggers a LOAN_APPLICATION_ACCEPTED event when a loan application is accepted and its status is set to ACCEPTED.

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_APPLICATION_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}
chevron-rightLOAN_APPLICATION_DECLINEDhashtag
  • The loan-api triggers a LOAN_APPLICATION_DECLINED event when a loan application is declined and its status is set to DECLINED.

  • Event parameters are eventTypeCode/routing_code: ext.loans.applications.declined.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_APPLICATION_DECLINED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}

Loan offer

chevron-rightLOAN_OFFER_ACCEPTEDhashtag
  • The loan-api triggers a LOAN_OFFER_ACCEPTED event when a loan offer is accepted.

  • Event parameters are eventTypeCode/routing_code: ext.loans.offers.accepted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_OFFER_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "offerId": "ID-1619519375",
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}
chevron-rightLOAN_OFFER_PRESENTEDhashtag
  • The loan API triggers a LOAN_OFFER_PRESENTED event when a loan offer is presented.

  • Event parameters are eventTypeCode/routing_code: ext.loans.offers.presented.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_OFFER_PRESENTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T14:34:18.165Z",
  "data": {
    "offerId": "ID-1619519375",
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}

Loan contract

chevron-rightLOAN_CONTRACT_CREATEDhashtag
  • The loan-api triggers a LOAN_CONTRACT_CREATED event when a loan contract is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.created.

chevron-rightLOAN_CONTRACT_ACCEPTEDhashtag
  • The loan-api triggers a LOAN_CONTRACT_ACCEPTED event when a loan contract is accepted.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.accepted.

chevron-rightLOAN_CONTRACT_WAITING_FOR_ACTIVATIONhashtag
  • The loan-api triggers a LOAN_CONTRACT_WAITING_FOR_ACTIVATION event if a loan contract is ready for activation and contract status set to WAITING_FOR_ACTIVATION.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.waiting-for-activation.

chevron-rightLOAN_CONTRACT_ACTIVATEDhashtag
  • The loan-api triggers a LOAN_CONTRACT_ACTIVATED event when a loan contract is activated.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.activated.

chevron-rightLOAN_CONTRACT_IMPORTEDhashtag
  • The loan-api triggers a LOAN_CONTRACT_IMPORTED event when a loan contract is successfully imported.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.imported.

chevron-rightLOAN_CONTRACT_REPLACEDhashtag
  • The loan API triggers a LOAN_CONTRACT_REPLACED event when a loan contract version is replaced and is set to the REPLACED status.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.replaced.

chevron-rightLOAN_CONTRACT_BLOCKEDhashtag
  • The loan API triggers a LOAN_CONTRACT_BLOCKED event when a loan contract is blocked.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.blocked.

chevron-rightLOAN_CONTRACT_CANCELEDhashtag
  • The loan-api triggers a LOAN_CONTRACT_CANCELED event when a loan contract is canceled.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.canceled.

chevron-rightLOAN_CONTRACT_DEFAULTEDhashtag
  • When enabled and configured, the loan-api triggers the LOAN_CONTRACT_DEFAULTED event when a loan contract defaults.

Loan type

chevron-rightLOAN_TYPE_CHANGEDhashtag
  • The loan-api triggers a LOAN_TYPE_CHANGED event if loan product settings was changed.

  • Event parameters are eventTypeCode/routing_code: ext.loans.products.loan-type.changed.

Loan repayment management

chevron-rightLOAN_RECEIVABLE_CREATEDhashtag
  • The loan-api triggers a LOAN_RECEIVABLE_CREATED event with details of a receivable if it is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.receivable.created.

chevron-rightLOAN_INVOICE_CREATEDhashtag
  • The loan-api triggers a LOAN_INVOICE_CREATED event if invoice created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.invoices.created.

chevron-rightLOAN_CREDIT_NOTE_CREATEDhashtag
  • The loan-api triggers a LOAN_CREDIT_NOTE_CREATED event when a credit note is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.credit-note.created.

chevron-rightLOAN_REPAYMENT_REGISTEREDhashtag
  • The loan-api triggers a LOAN_REPAYMENT_REGISTERED event if a loan contract repayment is registered.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.cash-events.repayments.registered.

chevron-rightLOAN_REPAYMENT_CONFIRMEDhashtag
  • The loan-api triggers a LOAN_REPAYMENT_CONFIRMED event if a loan contract repayment is confirmed.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.cash-events.repayments.confirmed.

Loan death notification

chevron-rightLOAN_CUSTOMER_DEATH_NOTIFICATIONhashtag
  • The loan-api triggers a LOAN_CUSTOMER_DEATH_NOTIFICATION notification in the event when a customer's death is detected, provided there are active loan contracts with an outstanding balance greater than zero.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.letters.created.

Loan outgoing transfer

chevron-rightLOAN_OUTGOING_TRANSFERhashtag
  • The payment-router API triggers the LOAN_OUTGOING_TRANSFER event when an outgoing payment as the loan disbursement has been sent and the payment transfer status is set to SENT.

  • Event parameters are eventTypeCode/routing_code: ext.paymentRouters.transfers.sent.

Last updated

Was this helpful?