LogoLogo
Developer portal
  • Welcome
    • About cookbooks
  • Authentication
    • About authentication
    • Authenticate employee
    • Create customer credentials
    • Authenticate customer
    • Refresh JSON Web Token
    • Invalidate customer credentials
    • Export-import roles
      • Export selected roles
      • Import selected roles
      • Import all roles
  • Header parameters
    • About header parameters
    • Mandatory parameters
    • Optional parameters
      • Requests with same request ID
      • Requests without request ID
  • Employee
    • Create employee
    • Find employee by ID
    • Find employee by username
  • Person
    • Create private person
    • Create legal person
    • Activate person
    • Find person
      • Find person details
      • Find person addresses
    • Create person document
    • Update personal info
    • Update person address
    • Create customer group
    • Create additional contact
    • Assign person to group
    • Create person representation
    • Close person representation
    • Create person financial data
    • Inactivate person
    • Reactivate person
    • Reactivate person
    • Forget person
    • Remove person restoration key
  • ACCOUNTS
    • Create currency account
    • Create internal account
    • Create virtual account
    • Create account application
    • Set account access rights
    • Create account limit code
    • Create account limit type
    • Create account limit
    • Create account class code
    • Create account type class rule
    • Find person accounts
    • Search account transactions
  • Reports
    • Reports
    • Request to generate account transactions report
      • Account transactions report parameters
  • Check report generation status
  • Download requested report
  • DEPOSITS
    • Deposit product management
      • Create deposit class code
      • Create deposit product
      • Update deposit product
      • Activate deposit product
      • Find deposit product
      • Inactivate deposit product
    • Deposit flow
      • Create deposit application
      • Find deposit application
      • Create deposit offer
      • Find deposit offer
      • Edit deposit offer
      • Accept deposit offer
      • Decline deposit offer
      • Find deposit contract
    • Deposit contract management
      • Change payout details
      • Change contract prolongation status
      • Update contract header
      • Adjust deposit contract interest
      • Make premature termination
  • Payments
    • Create outgoing payments
      • Create SEPA payment
      • Create SWIFT payment
      • Create domestic UK payment
      • Create domestic US payment
    • Change payment
    • Cancel payment
    • Confirm payment
    • Find AML information of a payment
    • Find settled SEPA transaction
    • Create payment template
    • Initialise FX quote request
    • Get FX quote response
    • Initiate FX order
  • LOANS
    • Create loan application
    • Accept loan application
    • Find loan application offers
    • Create loan offer
    • Accept loan offer
    • Find person contracts
    • Accept loan contract
    • Disburse loan contract
    • Create contract fee booking
    • Default loan contract
  • CARDS
    • Create price list
    • Create price for the price list
    • Card counting and summing groups
      • Create counting group
      • Create summing group
      • Find counting values for card
      • Find summing values for account
    • Add BIN
    • Create upper limit group
    • Create upper usage group
    • Create card design
    • Create debit card product
    • Activate card product
    • Create debit card application
    • Create credit product
    • Create credit card offer
    • Accept credit card offer
  • Interest base rates
    • Add interest base rate type - periodic
    • Add interest base rate type - instant
  • Interest rate caps
    • Add interest rate cap type
  • Webhooks
    • About webhooks
    • Find available webhooks
    • Enable or disable notification for webhook
      • Enable with notification type and channel code
      • Enable with notification ID
      • Disable with notification type and channel code
      • Disable with notification ID
    • Search subscribed webhooks
    • Subscribe webhook
    • Update webhook subscription
    • Unsubscribe webhook
    • Webhooks with payloads
      • Person
      • Account
      • Deposit
      • Payments
      • AML processes
      • Loan
      • Card
      • Debt
      • Finance
      • Reports
      • Processes
  • Lookups
    • About lookups
    • Find existing lookup groups
    • Find lookup values
      • Find entities
      • Find lookup type codes
      • Find lookup types
      • Find translation of lookup type
    • Create lookup values
      • Create lookup type and codes
      • Create lookup code for existing type
      • Create lookup translation
    • Manage lookup values
      • Mark lookup code as default
      • Remove default lookup code
      • Delete lookup code
  • Custom fields
    • About custom fields
    • Create custom fields
      • Create field set
      • Create fields
      • Create fields with copied values
    • Find custom fields
      • Find field sets
      • Find fields
      • Search custom field sources
      • Get custom field value
    • Update custom fields
      • Update field set
      • Update field
      • Update custom field value
    • Manage custom fields
      • Insert custom field values
      • Copy custom field values
      • Deactivate field
      • Delete custom field value
  • Holidays
    • Create holiday
    • Search existing holidays
    • Search holiday by ID
    • Delete holiday
Powered by GitBook

© Tuum 2024

On this page
  • Loan application
  • Loan offer
  • Loan contract
  • Loan type
  • Loan repayment management
  • Loan death notification
  • Loan outgoing transfer

Was this helpful?

Export as PDF
  1. Webhooks
  2. Webhooks with payloads

Loan

Loan application

LOAN_APPLICATION_ACCEPTED
  • 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"
  }
}
LOAN_APPLICATION_DECLINED
  • 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

LOAN_OFFER_ACCEPTED
  • 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"
  }
}
LOAN_OFFER_PRESENTED
  • 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

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_ACCEPTED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "activeVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_WAITING_FOR_ACTIVATION
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_WAITING_FOR_ACTIVATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T14:55:30.293Z",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_ACTIVATED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "applicationId": "ID-1000",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_IMPORTED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_IMPORTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_REPLACED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_REPLACED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_BLOCKED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_BLOCKED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "applicationId": "ID-1000",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_CANCELED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_CANCELED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}

Loan type

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_TYPE_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T15:33:12.180Z",
  "data": {
    "loanTypeCode": "string",
    "tenantCode": "string",
    "statusCode": "string",
    "bankingDate": "2025-01-30"
  }
}

Loan repayment management

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_RECEIVABLE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivable": {
      "receivableId": "R000000001028",
      "contractId": "ID-1643361137",
      "receivableGroupCode": "INVOICE",
      "receivableTypeCode": "PERIODIC",
      "invoiceReason": "PERIODIC",
      "receivableNumber": "R000000001028",
      "statusCode": "CREATED",
      "billingDate": "2022-02-09",
      "dueDate": "2022-02-09",
      "receivableAmountMoney": {
        "amount": 0,
        "currencyCode": "str"
      },
      "billingPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "interestPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "description": "Testing",
      "previousReceivableId": "string",
      "solvencyLevelCode": "string",
      "changeReasonCode": "string",
      "generationDtime": "2022-02-01T11:20:11.248524Z"
    },
    "contract": {
      "contractNumber": "TEST_DK_R-1010",
      "productType": "TEST_DK_1.0_RECE",
      "countryCode": "DK",
      "personId": "ID-1010",
      "referenceNumber": "RF1550048",
      "invoiceDeliveryMethodCode": "POST",
      "repaymentChannelCode": "TRUSTLY"
    },
    "receivableLines": [
      {
        "receivableLineId": "R000000001000",
        "creditedReceivableLineId": "string",
        "lineTypeCode": "COF",
        "lineSubtypeCode": "string",
        "description": "string",
        "amountMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "source": {
          "sourceName": "string",
          "sourceRef": "string"
        },
        "originalSource": {
          "sourceName": "string",
          "sourceRef": "string"
        }
      }
    ]
  }
}

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

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "invoiceHeader": {
      "productType": "LOAN_PRODUCT_01",
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "invoiceId": "ID-1000",
      "invoiceType": "PERIODIC",
      "invoiceNumber": "R000000001105",
      "invoiceReason": "PERIODIC",
      "language": "en",
      "billingDate": "2021-04-30",
      "dueDate": "2021-05-21",
      "billingPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "interestPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "monthlyRepaymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      },
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "paymentFreeMonths": [
          "FEBRUARY",
          "JULY"
        ]
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "deliveryMethodCode": "POST",
      "email": "customer@gmail.com",
      "phoneNumber": "+3721234123",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ],
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "paymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      }
    },
    "lines": [
      {
        "lineGroupCode": "INVOICE_LINE",
        "lineTypeCode": "PRI",
        "lineSubtypeCode": "INTEREST_STATEMENT",
        "lineText": "string",
        "lineMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "lineRate": {
          "baseRate": -0.254,
          "marginRate": 7.265,
          "rate": 7.011,
          "periodRange": {
            "startDate": "2023-07-21",
            "endDate": "2023-07-21"
          },
          "referenceRateType": "EURIBOR-3M"
        },
        "lineDate": "2021-04-30",
        "additionalData": {
          "dueInvoiceNumber": "INV-10000234"
        }
      }
    ]
  }
}

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CREDIT_NOTE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "creditNoteHeader": {
      "creditNoteId": "ID-1000",
      "creditNoteReason": "AUTOMATIC",
      "creditedInvoiceId": "R000000001105",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "language": "en",
      "billingDate": "2021-04-30",
      "dueDate": "2021-05-21",
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "additionalData": {
        "paymentFreeMonths": [
          "FEBRUARY",
          "JULY"
        ]
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "deliveryMethodCode": "POST",
      "email": "customer@gmail.com",
      "phoneNumber": "+3721234123",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ],
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "paymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      }
    },
    "lines": [
      {
        "lineGroupCode": "INVOICE_LINE",
        "lineTypeCode": "PRI",
        "lineSubtypeCode": "INTEREST_STATEMENT",
        "lineText": "string",
        "lineMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "lineRate": {
          "baseRate": -0.254,
          "marginRate": 7.265,
          "rate": 7.011,
          "periodRange": {
            "startDate": "2023-07-21",
            "endDate": "2023-07-21"
          },
          "referenceRateType": "EURIBOR-3M"
        },
        "lineDate": "2021-04-30",
        "additionalData": {
          "dueInvoiceNumber": "INV-10000234"
        }
      }
    ]
  }
}

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_REPAYMENT_REGISTERED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivableEventTypeCode": "INCOMING",
    "contractId": "ID-1619519590",
    "referenceNumber": "referenceNumber",
    "cashId": "R000000001059",
    "valueDate": "2023-07-21",
    "postingDate": "2023-07-21",
    "description": "string",
    "money": {
      "amount": 0,
      "currencyCode": "str"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "originalSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "accountSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "payerName": "John Smith",
    "paymentChannelCode": "TRUSTLY",
    "endToEndId": "12345678"
  }
}
LOAN_REPAYMENT_CONFIRMED
  • 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.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_REPAYMENT_CONFIRMED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivableEventTypeCode": "PREMATURE_REPAYMENT",
    "valueDate": "2023-07-21",
    "postingDate": "2023-07-21",
    "description": "string",
    "money": {
      "amount": 0,
      "currencyCode": "str"
    },
    "cashEventId": "string",
    "balanceDirectionCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "originalSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "cash": {
      "contractId": "string",
      "referenceNumber": "string",
      "cashId": "string",
      "statusCode": "string",
      "balanceAmount": {
        "amount": 0,
        "currencyCode": "str"
      },
      "source": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "originalSource": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "accountSource": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "endToEndId": "string"
    },
    "receivableEvent": {
      "receivableEventId": "string",
      "receivableId": "string",
      "receivableLineId": "string",
      "itemTypeCode": "string"
    }
  }
}

Loan death notification

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CUSTOMER_DEATH_NOTIFICATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "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": "customer@gmail.com",
      "phoneNumber": "+3721234123",
      "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": 0,
            "currencyCode": "str"
          },
          "balanceMoney": {
            "amount": 0,
            "currencyCode": "str"
          },
          "debtMoney": {
            "amount": 0,
            "currencyCode": "str"
          }
        }
      ]
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "dueDate": "2021-04-01"
    },
    "invoiceInfo": [
      {
        "invoiceId": "R000000001105",
        "invoiceNumber": "R000000001105",
        "billingDate": "2021-04-30",
        "dueDate": "2021-05-21",
        "money": {
          "amount": 0,
          "currencyCode": "str"
        },
        "debtMoney": {
          "amount": 0,
          "currencyCode": "str"
        }
      }
    ]
  }
}

Loan outgoing transfer

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

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_GENERATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-18T07:36:38.175Z",
  "data": {
    "transferId": "ID-1000",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "contractSource": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "creditor": {
      "iban": "string",
      "bic": "string",
      "name": "string",
      "accountNumber": "123456",
      "accountNumberCountryCode": "string",
      "bankCode": "string"
    },
    "details": "Details",
    "eventDTime": "2024-12-18T07:36:38.175Z",
    "referenceNumber": "12345",
    "paymentTypeCode": "Return"
  }
}
PreviousAML processesNextCard

Last updated 4 months ago

Was this helpful?