NAV Navbar

Loan API v1.0

Scroll down for example requests and responses.

loan-contract-api-controller

Loan Contract Api Controller

searchContractsUsingGET

Code samples

GET /api/v1/contracts

searchContracts

Search loan contracts

Parameters

Parameter In Type Required Description
statusCodes query array[string] false Status code of contract - DRAFT, ACTIVE, ACCEPTED, REPLACED, CLOSED, WAITING_FOR_SIGNATURE, WAITING_FOR_ACTIVATION, WAITING_FOR_COLLATERAL
contractNumber query string false Contract number
preparationStart query string(date) false Contract preparation date interval start date
preparationEnd query string(date) false Contract preparation date interval end date
amountStart query number false Contract amount interval start amount
amountEnd query number false Contract amount interval end amount

Example responses

200 Response

{
  "data": [
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    },
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_ContractJson_

findContractUsingGET

Code samples

GET /api/v1/contracts/{contractId}

findContract

Get contract by contracts unique identifier

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

acceptContractUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/accept

acceptContract

Accept loan contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

activateContractUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/activate

activateContract

Activate loan contract and make automatic loan disbursement payment

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

prepareActivationUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/activation/prepare

prepareActivation

Prepare loan contract for activation

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

processContractClosingUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/close

processContractClosing

Close loan contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

prepareCollateralBindingUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/collateral/prepare

prepareCollateralBinding

Prepare loan contract for adding collateral

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

processContractDebtUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/debt-process

processContractDebt

Process loan contracts debt - initiate debt related procedures like late payment interest calculation, notification sending etc

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findContractEventsUsingGET

Code samples

GET /api/v1/contracts/{contractId}/events

findContractEvents

Find all loan contract related events. For example loan disubersement, interest accrual, late repayment interest, taking fees

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": [
    {
      "eventId": 6,
      "amount": 0.8008281904610115,
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "initialDebtAmount": 5.637376656633329,
      "postingDate": "2000-01-23",
      "headerId": 1,
      "fullyDeducted": true,
      "versionId": 7,
      "componentTypeCode": "componentTypeCode",
      "financeEventTypeCode": "financeEventTypeCode",
      "initialBalanceAmount": 5.962133916683182,
      "paymentId": 2,
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23",
      "debtDirectionCode": "debtDirectionCode"
    },
    {
      "eventId": 6,
      "amount": 0.8008281904610115,
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "initialDebtAmount": 5.637376656633329,
      "postingDate": "2000-01-23",
      "headerId": 1,
      "fullyDeducted": true,
      "versionId": 7,
      "componentTypeCode": "componentTypeCode",
      "financeEventTypeCode": "financeEventTypeCode",
      "initialBalanceAmount": 5.962133916683182,
      "paymentId": 2,
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23",
      "debtDirectionCode": "debtDirectionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_EventJson_

createContractEventUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/events

createContractEvent

Create events to contract which allows to manually accomodate various situations. For example undo late payment interest calculation which occured due to not being able to receice payment. Allowed event types - Administration fee repayment; Administration fee correction; Administration fee debt increase; Administration fee debt decrease; Administration fee future schedule; Administration fee future schedule reversal; Scheduled repayment liability; Penalty accrual; Penalty accrual reversal; Penalty accrual reversal; Penalty accrual; Accrued penalty correction (increase); Accrued penalty correction (decrease); Administration fee penalty repayment; Administration fee penalty correction; Available limit decrease; Available limit increase; Conclusion fee debt increase; Conclusion fee debt decrease; Conclusion fee repayment; Conclusion fee correction; Conclusion fee future schedule; Conclusion fee schedule reversal; Scheduled repayment liability; Penalty accrual; Penalty accrual reversal; Penalty accrual reversal; Penalty accrual; Accrued penalty correction (increase); Accrued penalty correction (decrease); Conclusion fee penalty repayment; Conclusion fee penalty correction; Interest accrual; Interest accrual decrease; Accrued interest correction (decrease); Accrued interest correction (increase); Interest accrual reversal; Interest accrual; Interest repayment; Interest repayment correction; Loan interest future schedule; Loan interest future schedule reversal; Loan interest future schedule reversal; Scheduled repayment liability; Increase liability; Decrease liability; Debt increase; Debt decrease; Repayment; Correction; Loan amount disbursement; Principal repayment; Principal repayment; Principal repayment correction; Loan principal future schedule; Loan principal future schedule reversal; Scheduled repayment liability; Increase liability; Decrease liability; Penalty accrual; Penalty accrual reversal; Penalty accrual reversal; Penalty accrual; Principal penalty repayment; Principal penalty correction; Accrued penalty correction (increase); Accrued penalty correction (decrease); Penalty accrual; Penalty accrual reversal; Penalty accrual reversal; Penalty accrual; Interest penalty repayment; Interest penalty correction; Accrued penalty correction (increase); Accrued penalty correction (decrease); Increase change fee ; Decrese change fee; Change fee repayment; Change fee reversal

Body parameter

{
  "amount": 0.8008281904610115,
  "componentTypeCode": "componentTypeCode",
  "eventTypeCode": "eventTypeCode",
  "regenerateSchedule": true,
  "details": "details",
  "currencyCode": "currencyCode",
  "effectiveDate": "2000-01-23"
}

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier
body body CreateEventJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

calculateContractInterestUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/interest-process

calculateContractInterest

Initiate interest accrual for loan contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findContractInterestsUsingGET

Code samples

GET /api/v1/contracts/{contractId}/interests

findContractInterests

Get calculated interest for loan contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": [
    {
      "amount": 0.8008281904610115,
      "componentTypeCode": "componentTypeCode",
      "calculationRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      },
      "numberOfDays": 6,
      "currencyCode": "currencyCode"
    },
    {
      "amount": 0.8008281904610115,
      "componentTypeCode": "componentTypeCode",
      "calculationRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      },
      "numberOfDays": 6,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_ContractInterestJson_

processPaymentsUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/payments/process

processPayments

Initiate loan repayment processing

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

prepareForRepaymentPeriodUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/repayment-period

prepareForRepaymentPeriod

Create claims for loan repayment in case of scheduled date

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

processContractScheduleUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/schedule-process

processContractSchedule

Process loan contract on scheduled date - interest accrual, reconcile payments, calculate late repayment interest ..

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

prepareSigningUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/signing/prepare

prepareSigning

Prepare loan contract for signing. Create contract template, upload to digital signing environment.

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

createNewVersionUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/versions

createNewVersion

Create new contract version. This allows to change schedules, fees, payment dates, restructure loans

Body parameter

{
  "changeTypeCode": "changeTypeCode"
}

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Contract unique identifier
body body CreateVersionJson true New contract version body

Example responses

200 Response

{
  "data": {
    "interestRate": 1.4894159098541704,
    "preparationDate": "2000-01-23",
    "gracePeriod": 7,
    "numberOfPayments": 4,
    "apr": 6.027456183070403,
    "components": [
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      },
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      }
    ],
    "period": 9,
    "endDate": "2000-01-23",
    "loanAmountRemaining": 1.1730742509559433,
    "principalDebtAmount": 6.683562403749608,
    "annuityAmount": 0.8008281904610115,
    "otherDebtAmount": 5.025004791520295,
    "headerId": 1,
    "loanAmount": 7.457744773683766,
    "versionNumber": 9,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "interestDebtAmount": 1.0246457001441578,
    "versionId": 8,
    "changeTypeCode": "changeTypeCode",
    "limitAmount": 6.84685269835264,
    "personId": 9,
    "activationDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractVersionJson_

findContractVersionUsingGET

Code samples

GET /api/v1/versions/{versionId}

findContractVersion

Get all loan contract by contracts unique identifier

Parameters

Parameter In Type Required Description
versionId path integer(int64) true Loan contract unique identifier

Example responses

200 Response

{
  "data": {
    "interestRate": 1.4894159098541704,
    "preparationDate": "2000-01-23",
    "gracePeriod": 7,
    "numberOfPayments": 4,
    "apr": 6.027456183070403,
    "components": [
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      },
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      }
    ],
    "period": 9,
    "endDate": "2000-01-23",
    "loanAmountRemaining": 1.1730742509559433,
    "principalDebtAmount": 6.683562403749608,
    "annuityAmount": 0.8008281904610115,
    "otherDebtAmount": 5.025004791520295,
    "headerId": 1,
    "loanAmount": 7.457744773683766,
    "versionNumber": 9,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "interestDebtAmount": 1.0246457001441578,
    "versionId": 8,
    "changeTypeCode": "changeTypeCode",
    "limitAmount": 6.84685269835264,
    "personId": 9,
    "activationDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractVersionJson_

updateVersionUsingPOST

Code samples

POST /api/v1/versions/{versionId}

updateVersion

Create a new contract version

Body parameter

{
  "activationSteps": [
    {
      "amount": 0.8008281904610115,
      "id": 6
    },
    {
      "amount": 0.8008281904610115,
      "id": 6
    }
  ],
  "firstInterestPaymentDate": "2000-01-23",
  "gracePeriod": 7,
  "components": [
    {
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "componentTypeCode": "componentTypeCode",
      "paymentIntervalMonths": 5,
      "paymentDay": 1,
      "rate": 5.637376656633329,
      "calculationDaysMonth": "calculationDaysMonth",
      "scheduleTypeCode": "scheduleTypeCode",
      "regularAmount": 2.3021358869347655
    },
    {
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "componentTypeCode": "componentTypeCode",
      "paymentIntervalMonths": 5,
      "paymentDay": 1,
      "rate": 5.637376656633329,
      "calculationDaysMonth": "calculationDaysMonth",
      "scheduleTypeCode": "scheduleTypeCode",
      "regularAmount": 2.3021358869347655
    }
  ],
  "period": 3,
  "scheduleDates": [
    {
      "date": "2000-01-23",
      "principal": true,
      "interest": true
    },
    {
      "date": "2000-01-23",
      "principal": true,
      "interest": true
    }
  ],
  "plannedActivationDate": "2000-01-23",
  "principalScheduleDefinitionTypeCode": "principalScheduleDefinitionTypeCode",
  "firstPrincipalPaymentDate": "2000-01-23",
  "loanAmount": 9.301444243932576
}

Parameters

Parameter In Type Required Description
versionId path integer(int64) true Loan contract version unique identifier
body body UpdateVersionJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findContractComponentsUsingGET

Code samples

GET /api/v1/versions/{versionId}/components

findContractComponents

Find contract components (principal, interest, principal late payment interest, administration fee, conclusion fee, ...) by loan contracts unique identifier

Parameters

Parameter In Type Required Description
versionId path integer(int64) true Loan contract unique identifier

Example responses

200 Response

{
  "data": [
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    },
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ComponentJson_

findContractScheduleUsingGET

Code samples

GET /api/v1/versions/{versionId}/schedule

findContractSchedule

Get loan contracts schedule by loan contract unique identifier

Parameters

Parameter In Type Required Description
versionId path integer(int64) true Loan contract version unique identifier

Example responses

200 Response

{
  "data": [
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    },
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ScheduleJson_

loan-person-api-controller

Loan Person Api Controller

findPersonApplicationsUsingGET

Code samples

GET /api/v1/persons/{personId}/applications

findPersonApplications

Get all customer's loan applications

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customers unique identifier

Example responses

200 Response

{
  "data": [
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ApplicationJson_

createPersonApplicationUsingPOST

Code samples

POST /api/v1/persons/{personId}/applications

createPersonApplication

Create new loan application for the customer

Body parameter

{
  "monthlyRepaymentAmount": 1.4658129805029452,
  "paymentDay": 5,
  "disbursementBic": "disbursementBic",
  "loanPurpose": "loanPurpose",
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "relatedAccountId": 5,
  "currencyCode": "currencyCode",
  "loanAmount": 0.8008281904610115,
  "loanPeriod": 6,
  "loanTypeCode": "loanTypeCode",
  "disbursementIban": "disbursementIban"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer unique identifier
body body CreateApplicationJson true Loan application

Example responses

200 Response

{
  "data": {
    "amount": 6.027456183070403,
    "purpose": "purpose",
    "disbursementBic": "disbursementBic",
    "overdraft": true,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "loanTypeCode": "loanTypeCode",
    "accountId": 0,
    "paymentDay": 5,
    "loanGroupCode": "loanGroupCode",
    "personId": 2,
    "applicationId": 1,
    "currencyCode": "currencyCode",
    "loanPeriod": 5,
    "applicationDate": "2000-01-23",
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ApplicationJson_

findPersonContractsUsingGET

Code samples

GET /api/v1/persons/{personId}/contracts

findPersonContracts

Get all customers loan contracts by customers unique identifier and contract status

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customers unique identifier
statusCodes query array[string] false Contract status code

Example responses

200 Response

{
  "data": [
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    },
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ContractJson_

findPersonLoansUsingGET

Code samples

GET /api/v1/persons/{personId}/loans

findPersonLoans

Get all customers loan contracts by customers unique identifier

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer unique identifier

Example responses

200 Response

{
  "data": [
    {
      "offer": {
        "monthlyRepaymentAmount": 7.061401241503109,
        "purpose": "purpose",
        "overdraft": true,
        "loanTypeCode": "loanTypeCode",
        "paymentDay": 4,
        "interestRate": 5.637376656633329,
        "numberOfPayments": 9,
        "apr": 5.962133916683182,
        "disbursementBic": "disbursementBic",
        "annuityAmount": 6.027456183070403,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "accountId": 0,
        "application": {
          "amount": 6.027456183070403,
          "purpose": "purpose",
          "disbursementBic": "disbursementBic",
          "overdraft": true,
          "scheduleTypeCode": "scheduleTypeCode",
          "applicantName": "applicantName",
          "loanTypeCode": "loanTypeCode",
          "accountId": 0,
          "paymentDay": 5,
          "loanGroupCode": "loanGroupCode",
          "personId": 2,
          "applicationId": 1,
          "currencyCode": "currencyCode",
          "loanPeriod": 5,
          "applicationDate": "2000-01-23",
          "disbursementIban": "disbursementIban",
          "statusCode": "statusCode"
        },
        "loanGroupCode": "loanGroupCode",
        "offerDate": "2000-01-23",
        "offerId": 3,
        "personId": 7,
        "requestedAmount": 1.2315135367772556,
        "applicationId": 1,
        "offeredAmount": 2.027123023002322,
        "currencyCode": "currencyCode",
        "loanPeriod": 2,
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "overdraft": true,
      "contract": {
        "endDate": "2000-01-23",
        "purpose": "purpose",
        "loanAmountRemaining": 1.2315135367772556,
        "overdraft": true,
        "otherDebtAmount": 1.4894159098541704,
        "headerId": 9,
        "loanTypeCode": "loanTypeCode",
        "interestDebtAmount": 2.027123023002322,
        "overdraftAccountId": 6,
        "debtAmount": 2.3021358869347655,
        "interestRate": 4.145608029883936,
        "preparationDate": "2000-01-23",
        "limitUsageDate": "2000-01-23",
        "apr": 5.637376656633329,
        "period": 7,
        "interestBalanceAmount": 3.616076749251911,
        "principalDebtAmount": 4.965218492984954,
        "annuityAmount": 1.4658129805029452,
        "contractNumber": "contractNumber",
        "loanAmount": 7.386281948385884,
        "accountId": 0,
        "feeAmount": 7.061401241503109,
        "schedule": [
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          },
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          }
        ],
        "loanGroupCode": "loanGroupCode",
        "activeVersionId": 6,
        "offerId": 1,
        "personId": 1,
        "activationDate": "2000-01-23",
        "applicationId": 5,
        "currencyCode": "currencyCode",
        "statusCode": "statusCode"
      },
      "personId": 0
    },
    {
      "offer": {
        "monthlyRepaymentAmount": 7.061401241503109,
        "purpose": "purpose",
        "overdraft": true,
        "loanTypeCode": "loanTypeCode",
        "paymentDay": 4,
        "interestRate": 5.637376656633329,
        "numberOfPayments": 9,
        "apr": 5.962133916683182,
        "disbursementBic": "disbursementBic",
        "annuityAmount": 6.027456183070403,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "accountId": 0,
        "application": {
          "amount": 6.027456183070403,
          "purpose": "purpose",
          "disbursementBic": "disbursementBic",
          "overdraft": true,
          "scheduleTypeCode": "scheduleTypeCode",
          "applicantName": "applicantName",
          "loanTypeCode": "loanTypeCode",
          "accountId": 0,
          "paymentDay": 5,
          "loanGroupCode": "loanGroupCode",
          "personId": 2,
          "applicationId": 1,
          "currencyCode": "currencyCode",
          "loanPeriod": 5,
          "applicationDate": "2000-01-23",
          "disbursementIban": "disbursementIban",
          "statusCode": "statusCode"
        },
        "loanGroupCode": "loanGroupCode",
        "offerDate": "2000-01-23",
        "offerId": 3,
        "personId": 7,
        "requestedAmount": 1.2315135367772556,
        "applicationId": 1,
        "offeredAmount": 2.027123023002322,
        "currencyCode": "currencyCode",
        "loanPeriod": 2,
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "overdraft": true,
      "contract": {
        "endDate": "2000-01-23",
        "purpose": "purpose",
        "loanAmountRemaining": 1.2315135367772556,
        "overdraft": true,
        "otherDebtAmount": 1.4894159098541704,
        "headerId": 9,
        "loanTypeCode": "loanTypeCode",
        "interestDebtAmount": 2.027123023002322,
        "overdraftAccountId": 6,
        "debtAmount": 2.3021358869347655,
        "interestRate": 4.145608029883936,
        "preparationDate": "2000-01-23",
        "limitUsageDate": "2000-01-23",
        "apr": 5.637376656633329,
        "period": 7,
        "interestBalanceAmount": 3.616076749251911,
        "principalDebtAmount": 4.965218492984954,
        "annuityAmount": 1.4658129805029452,
        "contractNumber": "contractNumber",
        "loanAmount": 7.386281948385884,
        "accountId": 0,
        "feeAmount": 7.061401241503109,
        "schedule": [
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          },
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          }
        ],
        "loanGroupCode": "loanGroupCode",
        "activeVersionId": 6,
        "offerId": 1,
        "personId": 1,
        "activationDate": "2000-01-23",
        "applicationId": 5,
        "currencyCode": "currencyCode",
        "statusCode": "statusCode"
      },
      "personId": 0
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_LoanJson_

findPersonOffersUsingGET

Code samples

GET /api/v1/persons/{personId}/offers

findPersonOffers

Get all customers loan offers by customers unique identifier

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer unique identifier
statusCodes query array[string] false Status of loan offer

Example responses

200 Response

{
  "data": [
    {
      "monthlyRepaymentAmount": 7.061401241503109,
      "purpose": "purpose",
      "overdraft": true,
      "loanTypeCode": "loanTypeCode",
      "paymentDay": 4,
      "interestRate": 5.637376656633329,
      "numberOfPayments": 9,
      "apr": 5.962133916683182,
      "disbursementBic": "disbursementBic",
      "annuityAmount": 6.027456183070403,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "accountId": 0,
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "loanGroupCode": "loanGroupCode",
      "offerDate": "2000-01-23",
      "offerId": 3,
      "personId": 7,
      "requestedAmount": 1.2315135367772556,
      "applicationId": 1,
      "offeredAmount": 2.027123023002322,
      "currencyCode": "currencyCode",
      "loanPeriod": 2,
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "monthlyRepaymentAmount": 7.061401241503109,
      "purpose": "purpose",
      "overdraft": true,
      "loanTypeCode": "loanTypeCode",
      "paymentDay": 4,
      "interestRate": 5.637376656633329,
      "numberOfPayments": 9,
      "apr": 5.962133916683182,
      "disbursementBic": "disbursementBic",
      "annuityAmount": 6.027456183070403,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "accountId": 0,
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "loanGroupCode": "loanGroupCode",
      "offerDate": "2000-01-23",
      "offerId": 3,
      "personId": 7,
      "requestedAmount": 1.2315135367772556,
      "applicationId": 1,
      "offeredAmount": 2.027123023002322,
      "currencyCode": "currencyCode",
      "loanPeriod": 2,
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_OfferJson_

createPersonOfferUsingPOST

Code samples

POST /api/v1/persons/{personId}/offers

createPersonOffer

Create new loan offer for a customer

Body parameter

{
  "interestRate": 1.4658129805029452,
  "monthlyRepaymentAmount": 5.637376656633329,
  "purpose": "purpose",
  "disbursementBic": "disbursementBic",
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "loanTypeCode": "loanTypeCode",
  "accountId": 0,
  "paymentDay": 7,
  "requestedAmount": 9.301444243932576,
  "applicationId": 6,
  "offeredAmount": 2.3021358869347655,
  "currencyCode": "currencyCode",
  "loanPeriod": 5,
  "disbursementIban": "disbursementIban"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer unique identifier
body body CreateOfferJson true Offer definition

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

preparePersonOfferUsingPOST

Code samples

POST /api/v1/persons/{personId}/prepare

preparePersonOffer

Prepare a new offer for customer

Body parameter

{
  "interestRate": 1.4658129805029452,
  "monthlyRepaymentAmount": 5.637376656633329,
  "purpose": "purpose",
  "disbursementBic": "disbursementBic",
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "loanTypeCode": "loanTypeCode",
  "accountId": 0,
  "paymentDay": 7,
  "requestedAmount": 9.301444243932576,
  "applicationId": 6,
  "offeredAmount": 2.3021358869347655,
  "currencyCode": "currencyCode",
  "loanPeriod": 5,
  "disbursementIban": "disbursementIban"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer unique identifier
body body CreateOfferJson true Offer definition

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

loan-application-api-controller

Loan Application Api Controller

searchApplicationsUsingPOST

Code samples

POST /api/v1/applications

searchApplications

Search loan applications

Parameters

Parameter In Type Required Description
statusCodes query array[string] false Status of application

Example responses

200 Response

{
  "data": [
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_ApplicationJson_

findApplicationUsingGET

Code samples

GET /api/v1/applications/{applicationId}

findApplication

Find loan application by unique identifier

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Unique identifier of application

Example responses

200 Response

{
  "data": {
    "amount": 6.027456183070403,
    "purpose": "purpose",
    "disbursementBic": "disbursementBic",
    "overdraft": true,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "loanTypeCode": "loanTypeCode",
    "accountId": 0,
    "paymentDay": 5,
    "loanGroupCode": "loanGroupCode",
    "personId": 2,
    "applicationId": 1,
    "currencyCode": "currencyCode",
    "loanPeriod": 5,
    "applicationDate": "2000-01-23",
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ApplicationJson_

acceptApplicationUsingPOST

Code samples

POST /api/v1/applications/{applicationId}/accept

acceptApplication

Accept loan application. Allows the back-office employees to accept loan applications manually

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Unique identifier of loan application

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

prepareForAcceptanceUsingPOST

Code samples

POST /api/v1/applications/{applicationId}/accept/prepare

prepareForAcceptance

Put application to status WAITING_FOR_ACCEPTANCE

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Unique identifier of loan application

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

declineApplicationUsingPOST

Code samples

POST /api/v1/applications/{applicationId}/decline

declineApplication

Decline loan application

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Unique identifier of loan application

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findApplicationOfferUsingGET

Code samples

GET /api/v1/applications/{applicationId}/offers

findApplicationOffer

Return the offer generated for loan application

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Unique identifier of loan application

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

quote-api-controller

Quote Api Controller

findQuoteUsingPOST

Code samples

POST /api/v1/quote

findQuote

Get monthly payment and APR for loan product based on customer input

Body parameter

{
  "interestRate": 1.4658129805029452,
  "serviceFee": 2.3021358869347655,
  "monthlyPaymentDay": 5,
  "amount": 0.8008281904610115,
  "conclusionFee": 6.027456183070403,
  "disbursementDate": "2000-01-23",
  "currency": "currency",
  "maturityMonths": 5,
  "scheduleTypeCode": "scheduleTypeCode",
  "loanTypeCode": "loanTypeCode"
}

Parameters

Parameter In Type Required Description
body body QuoteInputJson true json

Example responses

200 Response

{
  "data": {
    "apr": 0.8008281904610115,
    "monthlyPayment": 6.027456183070403,
    "scheduleLines": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_QuoteJson_

system-api-controller

System Api Controller

findComponentTypesUsingPOST

Code samples

POST /api/v1/component-types

findComponentTypes

Find types of defined loan components - principal, interest, various fees (conclusion, maintenance, disbursement), late payment interests. Number of components is not final and they can be added dynamically.

Example responses

200 Response

{
  "data": [
    {
      "separateRepaymentOrders": true,
      "componentTypeCode": "componentTypeCode",
      "feeLike": true,
      "penalty": true,
      "baseComponentTypeCode": "baseComponentTypeCode",
      "name": "name",
      "interestLike": true,
      "holdsBalance": true,
      "processingOrder": 0,
      "basePositionCode": "basePositionCode"
    },
    {
      "separateRepaymentOrders": true,
      "componentTypeCode": "componentTypeCode",
      "feeLike": true,
      "penalty": true,
      "baseComponentTypeCode": "baseComponentTypeCode",
      "name": "name",
      "interestLike": true,
      "holdsBalance": true,
      "processingOrder": 0,
      "basePositionCode": "basePositionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ComponentTypeJson_

findEventTypesUsingPOST

Code samples

POST /api/v1/event-types

findEventTypes

Get all available events related to loan contracts and components

Example responses

200 Response

{
  "data": [
    {
      "componentTypeCode": "componentTypeCode",
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "description": "description",
      "resetAccrual": true,
      "debtDirectionCode": "debtDirectionCode"
    },
    {
      "componentTypeCode": "componentTypeCode",
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "description": "description",
      "resetAccrual": true,
      "debtDirectionCode": "debtDirectionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_EventTypeJson_

findLoanTypesUsingGET

Code samples

GET /api/v1/loan-types

findLoanTypes

Get all defined loan products in platform

Example responses

200 Response

{
  "data": [
    {
      "overdraft": true,
      "conclusionFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "enabled": true
      },
      "description": "description",
      "administrationFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "paymentInterval": 6,
        "enabled": true
      },
      "loanTypeCode": "loanTypeCode",
      "applicationReviewRequired": true,
      "principal": {
        "paymentInterval": 9,
        "penaltyCalculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "hasPenalty": true,
        "penaltyRate": 3.616076749251911
      },
      "interest": {
        "calculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "paymentInterval": 1,
        "enabled": true
      },
      "loanGroupCode": "loanGroupCode",
      "collateralRequired": true,
      "signatureRequired": true,
      "contractReviewRequired": true,
      "periodRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interests": [
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        },
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        }
      ],
      "scheduleTypeCodes": [
        "scheduleTypeCodes",
        "scheduleTypeCodes"
      ]
    },
    {
      "overdraft": true,
      "conclusionFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "enabled": true
      },
      "description": "description",
      "administrationFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "paymentInterval": 6,
        "enabled": true
      },
      "loanTypeCode": "loanTypeCode",
      "applicationReviewRequired": true,
      "principal": {
        "paymentInterval": 9,
        "penaltyCalculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "hasPenalty": true,
        "penaltyRate": 3.616076749251911
      },
      "interest": {
        "calculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "paymentInterval": 1,
        "enabled": true
      },
      "loanGroupCode": "loanGroupCode",
      "collateralRequired": true,
      "signatureRequired": true,
      "contractReviewRequired": true,
      "periodRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interests": [
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        },
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        }
      ],
      "scheduleTypeCodes": [
        "scheduleTypeCodes",
        "scheduleTypeCodes"
      ]
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_LoanTypeJson_

createLoanTypeUsingPOST

Code samples

POST /api/v1/loan-types

createLoanType

Create new loan product

Body parameter

{
  "principal": {
    "paymentInterval": 9,
    "penaltyCalculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "hasPenalty": true,
    "penaltyRate": 3.616076749251911
  },
  "interest": {
    "calculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "paymentInterval": 1,
    "enabled": true
  },
  "loanGroupCode": "loanGroupCode",
  "signatureRequired": true,
  "contractReviewRequired": true,
  "conclusionFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "enabled": true
  },
  "description": "description",
  "periodRange": {
    "endValue": 2,
    "startValue": 7
  },
  "administrationFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "paymentInterval": 6,
    "enabled": true
  },
  "interests": [
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    },
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    }
  ],
  "scheduleTypeCodes": [
    "scheduleTypeCodes",
    "scheduleTypeCodes"
  ],
  "loanTypeCode": "loanTypeCode"
}

Parameters

Parameter In Type Required Description
body body CreateLoanTypeJson true Loan product definition

Example responses

200 Response

{
  "data": {
    "overdraft": true,
    "conclusionFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "enabled": true
    },
    "description": "description",
    "administrationFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "paymentInterval": 6,
      "enabled": true
    },
    "loanTypeCode": "loanTypeCode",
    "applicationReviewRequired": true,
    "principal": {
      "paymentInterval": 9,
      "penaltyCalculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "hasPenalty": true,
      "penaltyRate": 3.616076749251911
    },
    "interest": {
      "calculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "paymentInterval": 1,
      "enabled": true
    },
    "loanGroupCode": "loanGroupCode",
    "collateralRequired": true,
    "signatureRequired": true,
    "contractReviewRequired": true,
    "periodRange": {
      "endValue": 2,
      "startValue": 7
    },
    "interests": [
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      },
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      }
    ],
    "scheduleTypeCodes": [
      "scheduleTypeCodes",
      "scheduleTypeCodes"
    ]
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_LoanTypeJson_

findLoanTypeUsingGET

Code samples

GET /api/v1/loan-types/{loanTypeCode}

findLoanType

Find defined loan product by product code

Parameters

Parameter In Type Required Description
loanTypeCode path string true Loan product code

Example responses

200 Response

{
  "data": {
    "overdraft": true,
    "conclusionFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "enabled": true
    },
    "description": "description",
    "administrationFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "paymentInterval": 6,
      "enabled": true
    },
    "loanTypeCode": "loanTypeCode",
    "applicationReviewRequired": true,
    "principal": {
      "paymentInterval": 9,
      "penaltyCalculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "hasPenalty": true,
      "penaltyRate": 3.616076749251911
    },
    "interest": {
      "calculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "paymentInterval": 1,
      "enabled": true
    },
    "loanGroupCode": "loanGroupCode",
    "collateralRequired": true,
    "signatureRequired": true,
    "contractReviewRequired": true,
    "periodRange": {
      "endValue": 2,
      "startValue": 7
    },
    "interests": [
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      },
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      }
    ],
    "scheduleTypeCodes": [
      "scheduleTypeCodes",
      "scheduleTypeCodes"
    ]
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_LoanTypeJson_

updateLoanTypeUsingPOST

Code samples

POST /api/v1/loan-types/{loanTypeCode}

updateLoanType

Change existing loan product. Will be used for new customers.

Body parameter

{
  "principal": {
    "paymentInterval": 9,
    "penaltyCalculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "hasPenalty": true,
    "penaltyRate": 3.616076749251911
  },
  "interest": {
    "calculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "paymentInterval": 1,
    "enabled": true
  },
  "loanGroupCode": "loanGroupCode",
  "signatureRequired": true,
  "contractReviewRequired": true,
  "conclusionFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "enabled": true
  },
  "description": "description",
  "periodRange": {
    "endValue": 2,
    "startValue": 7
  },
  "administrationFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "paymentInterval": 6,
    "enabled": true
  },
  "interests": [
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    },
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    }
  ],
  "scheduleTypeCodes": [
    "scheduleTypeCodes",
    "scheduleTypeCodes"
  ],
  "loanTypeCode": "loanTypeCode"
}

Parameters

Parameter In Type Required Description
loanTypeCode path string true Loan product code
body body CreateLoanTypeJson true Product definition

Example responses

200 Response

{
  "data": {
    "overdraft": true,
    "conclusionFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "enabled": true
    },
    "description": "description",
    "administrationFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "paymentInterval": 6,
      "enabled": true
    },
    "loanTypeCode": "loanTypeCode",
    "applicationReviewRequired": true,
    "principal": {
      "paymentInterval": 9,
      "penaltyCalculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "hasPenalty": true,
      "penaltyRate": 3.616076749251911
    },
    "interest": {
      "calculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "paymentInterval": 1,
      "enabled": true
    },
    "loanGroupCode": "loanGroupCode",
    "collateralRequired": true,
    "signatureRequired": true,
    "contractReviewRequired": true,
    "periodRange": {
      "endValue": 2,
      "startValue": 7
    },
    "interests": [
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      },
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      }
    ],
    "scheduleTypeCodes": [
      "scheduleTypeCodes",
      "scheduleTypeCodes"
    ]
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_LoanTypeJson_

changePostingDateUsingPOST

Code samples

POST /api/v1/posting-date

changePostingDate

Change banking day in loan system

Body parameter

{
  "newPostingDate": "2000-01-23"
}

Parameters

Parameter In Type Required Description
body body PostingDateChangeJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

loan-offer-api-controller

Loan Offer Api Controller

calculateOfferInterestUsingPOST

Code samples

POST /api/v1/offers/interests

calculateOfferInterest

Get interest rate for customer based on loan product code and customers credit rating

Parameters

Parameter In Type Required Description
loanTypeCode query string true Loan product code
personScore query number true Customers credit rating

Example responses

200 Response

{
  "data": {
    "interestRate": 0.8008281904610115
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferInterestJson_

findOfferUsingGET

Code samples

GET /api/v1/offers/{offerId}

findOffer

Get loan offer by offers unique identifier

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offer unique identifier

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

presentOfferUsingPOST

Code samples

POST /api/v1/offers/{offerId}

presentOffer

Mark offer as presented to the customer

Body parameter

{
  "interestRate": 0.8008281904610115
}

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offers unique identifier
body body PresentOfferJson true json

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

acceptOfferUsingPOST

Code samples

POST /api/v1/offers/{offerId}/accept

acceptOffer

Customer can accept loan offer

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offers unique identifier

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

cancelOfferUsingPOST

Code samples

POST /api/v1/offers/{offerId}/cancel

cancelOffer

Decline loan offer

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offer unique identifier

Example responses

200 Response

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_OfferJson_

findOfferContractUsingGET

Code samples

GET /api/v1/offers/{offerId}/contracts

findOfferContract

Find contracts by loan offers unique identifier

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offers unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

createContractUsingPOST

Code samples

POST /api/v1/offers/{offerId}/contracts

createContract

Create new loan contract for customer

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Loan offers unique identifier

Example responses

200 Response

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_ContractJson_

Schemas

ActivationStepUpdateJson

{
  "amount": 0.8008281904610115,
  "id": 6
}

Update existing loan steps - for example taking a fee and loan disbursement are considered as activation steps

Properties

Name Type Required Restrictions Description
amount number false none New amount for loan activation step
id integer(int64) false none Activation step unique identifier

AdministrationFeeConfigJson

{
  "amount": {
    "amount": 0.8008281904610115,
    "currencyCode": "currencyCode"
  },
  "paymentInterval": 6,
  "enabled": true
}

Properties

Name Type Required Restrictions Description
amount Money false none none
enabled boolean false none Descibes if administration fee is applied to loan product
paymentInterval integer(int32) false none Descibes how often the fee must be paid - once a month, several times a month, quarterly etc

ApplicationJson

{
  "amount": 6.027456183070403,
  "purpose": "purpose",
  "disbursementBic": "disbursementBic",
  "overdraft": true,
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "loanTypeCode": "loanTypeCode",
  "accountId": 0,
  "paymentDay": 5,
  "loanGroupCode": "loanGroupCode",
  "personId": 2,
  "applicationId": 1,
  "currencyCode": "currencyCode",
  "loanPeriod": 5,
  "applicationDate": "2000-01-23",
  "disbursementIban": "disbursementIban",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique identifier for customer account
amount number false none Applied loan amount
applicantName string false none Applicants name
applicationDate string(date) false none Date of application
applicationId integer(int64) false none Unique identifier for application
currencyCode string false none Currency - EUR, GDP, USD etc
disbursementBic string false none BIC for loan disbursement account
disbursementIban string false none IBAN of disbursement account
loanGroupCode string false none Loan group - for example BUSINESS_LOAN, CONSTRUCTION_LOAN, JOINT_MORTGAGE, OVERDRAFT_LOAN, REGULAR_MORTGAGE, SECURED_LOAN, UNSECURED_LOAN, VEHICLE_LOAN
loanPeriod integer(int32) false none Loan period in months (for example 12 months)
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
overdraft boolean false none Defines if overdraft is allowed
paymentDay integer(int32) false none Payment day - for example 12th
personId integer(int64) false none Unique identifier of customer
purpose string false none Purpose of loan
scheduleTypeCode string false none Schedule type used - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL
statusCode string false none Status of application - SUBMITTED, DECLINED, ACCEPTED, WAITING_FOR_ACCEPTANCE

CalculationMethod

{
  "daysInMonth": "daysInMonth",
  "daysInYear": "daysInYear"
}

Properties

Name Type Required Restrictions Description
daysInMonth string false none Number of days used for interest calculation - 30, ACT
daysInYear string false none Number of days used for interest calculation - 360, 365

ComponentJson

{
  "componentId": 5,
  "debtStartDate": "2000-01-23",
  "scheduleTypeCode": "scheduleTypeCode",
  "balanceAmount": 1.4658129805029452,
  "accruedUntilDate": "2000-01-23",
  "regularAmount": 2.027123023002322,
  "calculationDaysYear": "calculationDaysYear",
  "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
  "versionId": 4,
  "componentTypeCode": "componentTypeCode",
  "paymentDay": 7,
  "paymentInterval": 9,
  "rate": 3.616076749251911,
  "scheduleStartDate": "2000-01-23",
  "initialAmount": 2.3021358869347655,
  "baseInvalidFromDate": "2000-01-23",
  "calculationDaysMonth": "calculationDaysMonth",
  "currencyCode": "currencyCode",
  "debtAmount": 5.637376656633329,
  "rateBaseCode": "rateBaseCode"
}

Properties

Name Type Required Restrictions Description
accruedUntilDate string(date) false none The last day up until when interest was accrued
balanceAmount number false none Loan components balance
baseInvalidFromDate string(date) false none Date when base interest rate was invalitated
calculationDaysMonth string false none Number of days in month used for interest calculation - 30, ACTUAL
calculationDaysYear string false none Number of days in year used for interest calculation - 360, 365
componentId integer(int64) false none Loan component unique identifier
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
currencyCode string false none Currency - EUR, GDP, USD etc
debtAmount number false none Current debt amount of component
debtStartDate string(date) false none Date when debt started
initialAmount number false none Initial amount of component - for example initial loan amount
paymentDay integer(int32) false none Payment day in month, for example the 12th
paymentInterval integer(int32) false none Number of payments per month
rate number false none Interest rate of component if component is interest related
rateBaseCode string false none Interest rate base code - FIX, FLOAT
regularAmount number false none Filled if the amount is fixed. For example in the case of administration fee
scheduleDefinitionTypeCode string false none Describes how schedule was defined for component - AUTOMATIC, MANUAL
scheduleStartDate string(date) false none First date of schedule
scheduleTypeCode string false none Schedule type - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL
versionId integer(int64) false none Components unique identifier

ComponentTypeJson

{
  "separateRepaymentOrders": true,
  "componentTypeCode": "componentTypeCode",
  "feeLike": true,
  "penalty": true,
  "baseComponentTypeCode": "baseComponentTypeCode",
  "name": "name",
  "interestLike": true,
  "holdsBalance": true,
  "processingOrder": 0,
  "basePositionCode": "basePositionCode"
}

Properties

Name Type Required Restrictions Description
baseComponentTypeCode string false none Describes which underlying value is used for interest accrual - D (debt amount), B (component balance)
basePositionCode string false none Calculation underlying component type code - PRI, COF, ADM. Others can be added
componentTypeCode string false none Component code - ADM, ADM_P, ALIM, CHANGE_FEE, COF, COF_P, INT, OTHER_FEE, PRI, PRI_P
feeLike boolean false none Boolean describing if component is fee
holdsBalance boolean false none Boolean describing if component has a balance
interestLike boolean false none Boolean describing if component is interest bearing
name string false none Business name of the component. For example - Account administration fee
penalty boolean false none Boolean describing if penalty is calculated on component
processingOrder integer(int32) false none Describes the debiting priority of components in case of repayments.
separateRepaymentOrders boolean false none Boolean describing if a separate repayment order is created for component.

ComponentUpdateJson

{
  "calculationDaysYear": "calculationDaysYear",
  "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
  "componentTypeCode": "componentTypeCode",
  "paymentIntervalMonths": 5,
  "paymentDay": 1,
  "rate": 5.637376656633329,
  "calculationDaysMonth": "calculationDaysMonth",
  "scheduleTypeCode": "scheduleTypeCode",
  "regularAmount": 2.3021358869347655
}

Properties

Name Type Required Restrictions Description
calculationDaysMonth string false none Number of days in month used for interest calculation - 30, ACTUAL
calculationDaysYear string false none Number of days in year used for interest calculation - 360, 365
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
paymentDay integer(int32) false none Payment day in month, for example the 12th
paymentIntervalMonths integer(int32) false none Number of payments per month
rate number false none Interest rate of component if component is interest related
regularAmount number false none Filled if the amount is fixed. For example in the case of administration fee
scheduleDefinitionTypeCode string false none Describes how schedule was defined for component - AUTOMATIC, MANUAL
scheduleTypeCode string false none Schedule type - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL

ConclusionFeeConfigJson

{
  "amount": {
    "amount": 0.8008281904610115,
    "currencyCode": "currencyCode"
  },
  "enabled": true
}

Properties

Name Type Required Restrictions Description
amount Money false none none
enabled boolean false none Boolean describing if conclusion fee is allowed

ContractInterestJson

{
  "amount": 0.8008281904610115,
  "componentTypeCode": "componentTypeCode",
  "calculationRange": {
    "endDate": "2000-01-23",
    "startDate": "2000-01-23"
  },
  "numberOfDays": 6,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
amount number false none Amount of interest calculated
calculationRange DateRange false none none
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
currencyCode string false none The currency of interest calculation
numberOfDays integer(int32) false none Number of days interest has been calculated

ContractJson

{
  "endDate": "2000-01-23",
  "purpose": "purpose",
  "loanAmountRemaining": 1.2315135367772556,
  "overdraft": true,
  "otherDebtAmount": 1.4894159098541704,
  "headerId": 9,
  "loanTypeCode": "loanTypeCode",
  "interestDebtAmount": 2.027123023002322,
  "overdraftAccountId": 6,
  "debtAmount": 2.3021358869347655,
  "interestRate": 4.145608029883936,
  "preparationDate": "2000-01-23",
  "limitUsageDate": "2000-01-23",
  "apr": 5.637376656633329,
  "period": 7,
  "interestBalanceAmount": 3.616076749251911,
  "principalDebtAmount": 4.965218492984954,
  "annuityAmount": 1.4658129805029452,
  "contractNumber": "contractNumber",
  "loanAmount": 7.386281948385884,
  "accountId": 0,
  "feeAmount": 7.061401241503109,
  "schedule": [
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    },
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    }
  ],
  "loanGroupCode": "loanGroupCode",
  "activeVersionId": 6,
  "offerId": 1,
  "personId": 1,
  "activationDate": "2000-01-23",
  "applicationId": 5,
  "currencyCode": "currencyCode",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Customer accounts unique identifier
activationDate string(date) false none Loan contract activation date
activeVersionId integer(int64) false none Reference to active loan contract versions unique identifier
annuityAmount number false none Monthly annuity payment amount
applicationId integer(int64) false none Reference to loan applications unique identifier
apr number false none Annual percentage amount of loan contract
contractNumber string false none Generated contract number
currencyCode string false none Underlying currency for loan contract
debtAmount number false none Total amount of current debt for the loan contract
endDate string(date) false none End date of loan contract
feeAmount number false none Monthly fee amount
headerId integer(int64) false none Reference to contract header
interestBalanceAmount number false none Current accrued interest balance
interestDebtAmount number false none Current interest debt amount
interestRate number false none Current interest rate
limitUsageDate string(date) false none In case of overdraft the date when all of limit was used
loanAmount number false none Total amount of loan or line of credit
loanAmountRemaining number false none Amount still open to use
loanGroupCode string false none Loan group - for example BUSINESS_LOAN, CONSTRUCTION_LOAN, JOINT_MORTGAGE, OVERDRAFT_LOAN, REGULAR_MORTGAGE, SECURED_LOAN, UNSECURED_LOAN, VEHICLE_LOAN
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
offerId integer(int64) false none Reference to offer which was used for creating the contract
otherDebtAmount number false none Total debt of other components beside principal and interest
overdraft boolean false none Boolean describing it contract is for overdraft
overdraftAccountId integer(int64) false none Loan product identifier, for example LOAN_PRODUCT1
period integer(int32) false none Total loan period in months
personId integer(int64) false none Reference to customer
preparationDate string(date) false none Date when contract was prepared
principalDebtAmount number false none Principal components debt
purpose string false none Purpose of the loan
schedule [ScheduleJson] false none none
statusCode string false none none

ContractVersionJson

{
  "interestRate": 1.4894159098541704,
  "preparationDate": "2000-01-23",
  "gracePeriod": 7,
  "numberOfPayments": 4,
  "apr": 6.027456183070403,
  "components": [
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    },
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    }
  ],
  "period": 9,
  "endDate": "2000-01-23",
  "loanAmountRemaining": 1.1730742509559433,
  "principalDebtAmount": 6.683562403749608,
  "annuityAmount": 0.8008281904610115,
  "otherDebtAmount": 5.025004791520295,
  "headerId": 1,
  "loanAmount": 7.457744773683766,
  "versionNumber": 9,
  "schedule": [
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    },
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    }
  ],
  "interestDebtAmount": 1.0246457001441578,
  "versionId": 8,
  "changeTypeCode": "changeTypeCode",
  "limitAmount": 6.84685269835264,
  "personId": 9,
  "activationDate": "2000-01-23",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
activationDate string(date) false none Loan contract activation date
annuityAmount number false none Monthly annuity payment amount
apr number false none Annual percentage amount of loan contract
changeTypeCode string false none Filled if contract has been changed - PAYMENT_HOLIDAY, PREMATURE_PAYMENT, PAYMENT_DAY_CHANGE
components [ComponentJson] false none none
endDate string(date) false none End date of loan contract
gracePeriod integer(int32) false none Grace period of loan contract
headerId integer(int64) false none Reference to contract header
interestDebtAmount number false none Current interest debt amount
interestRate number false none Current interest rate
limitAmount number false none Maximum limit for loan contract
loanAmount number false none Amount of loan or line of credit
loanAmountRemaining number false none Amount still open to use
numberOfPayments integer(int32) false none Number of payments made to the contract
otherDebtAmount number false none Total debt of other components beside principal and interest
period integer(int32) false none Total loan period in months
personId integer(int64) false none Reference to customer
preparationDate string(date) false none Date when contract was prepared
principalDebtAmount number false none Principal components debt
schedule [ScheduleJson] false none none
statusCode string false none Status of contract - DRAFT, ACTIVE, WAITING_FOR_SIGNATURE, WAITING_FOR_ACCEPTANCE, CLOSED
versionId integer(int64) false none Unique identifier for contract version
versionNumber integer(int32) false none Contract version number

CreateApplicationJson

{
  "monthlyRepaymentAmount": 1.4658129805029452,
  "paymentDay": 5,
  "disbursementBic": "disbursementBic",
  "loanPurpose": "loanPurpose",
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "relatedAccountId": 5,
  "currencyCode": "currencyCode",
  "loanAmount": 0.8008281904610115,
  "loanPeriod": 6,
  "loanTypeCode": "loanTypeCode",
  "disbursementIban": "disbursementIban"
}

Properties

Name Type Required Restrictions Description
applicantName string false none Loan applicants name
currencyCode string false none Currency - EUR, GDP, USD etc
disbursementBic string false none BIC for loan disbursement account
disbursementIban string false none IBAN of disbursement account
loanAmount number false none Amount applied for
loanPeriod integer(int32) false none Total period of loan in months
loanPurpose string false none Purpose of the loan
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
monthlyRepaymentAmount number false none Wished for monthly payment entered by user, chosen with a slider etc
paymentDay integer(int32) false none Payment day - for example 12th
relatedAccountId integer(int64) false none Reference to account if customer has one
scheduleTypeCode string false none Schedule type used - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL

CreateEventJson

{
  "amount": 0.8008281904610115,
  "componentTypeCode": "componentTypeCode",
  "eventTypeCode": "eventTypeCode",
  "regenerateSchedule": true,
  "details": "details",
  "currencyCode": "currencyCode",
  "effectiveDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
amount number false none Event amount
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
currencyCode string false none Currency - EUR, GDP, USD etc
details string false none Custom description for event
effectiveDate string(date) false none Date when the event should take place. Can be in the past (backvalue) or future
eventTypeCode string false none ACCRUAL; ACCRUAL_REVERSE; BAL_DECREASE; BAL_INCREASE; BAL_TO_DEBT; CALCULATION_DECREASE; CALCULATION_INCREASE; DEBT_DECREASE; DEBT_INCREASE; DEBT_TO_BAL; DISBURSEMENT; PENALTY_CALC_DECREASE; PENALTY_CALC_INCREASE; PREMATURE_REPAYMENT; REPAYMENT; REPAYMENT_REVERSAL; SCHEDULE; SCHEDULE_CANCEL; SCHEDULE_PROC_BALANCE; SCHEDULE_PROC_DEBT
regenerateSchedule boolean false none Description if schedule should be calculated again

CreateLoanInterestJson

{
  "interestRate": 0.8008281904610115,
  "scoreRange": {
    "endValue": 2,
    "startValue": 7
  }
}

Properties

Name Type Required Restrictions Description
interestRate number false none Interest rate value
scoreRange IntegerRange false none none

CreateLoanTypeJson

{
  "principal": {
    "paymentInterval": 9,
    "penaltyCalculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "hasPenalty": true,
    "penaltyRate": 3.616076749251911
  },
  "interest": {
    "calculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "paymentInterval": 1,
    "enabled": true
  },
  "loanGroupCode": "loanGroupCode",
  "signatureRequired": true,
  "contractReviewRequired": true,
  "conclusionFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "enabled": true
  },
  "description": "description",
  "periodRange": {
    "endValue": 2,
    "startValue": 7
  },
  "administrationFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "paymentInterval": 6,
    "enabled": true
  },
  "interests": [
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    },
    {
      "interestRate": 0.8008281904610115,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      }
    }
  ],
  "scheduleTypeCodes": [
    "scheduleTypeCodes",
    "scheduleTypeCodes"
  ],
  "loanTypeCode": "loanTypeCode"
}

Properties

Name Type Required Restrictions Description
administrationFee AdministrationFeeConfigJson false none none
conclusionFee ConclusionFeeConfigJson false none none
contractReviewRequired boolean false none Defines if contract applications can be automatically approved or not
description string false none Custom description of loan product
interest InterestConfigJson false none none
interests [CreateLoanInterestJson] false none none
loanGroupCode string false none Loan group - for example BUSINESS_LOAN, CONSTRUCTION_LOAN, JOINT_MORTGAGE, OVERDRAFT_LOAN, REGULAR_MORTGAGE, SECURED_LOAN, UNSECURED_LOAN, VEHICLE_LOAN
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
periodRange IntegerRange false none none
principal PrincipalConfigJson false none Loan principal component configuration component
scheduleTypeCodes [string] false none none
signatureRequired boolean false none Defines if contract needs to be signed or can be automatically created

CreateOfferJson

{
  "interestRate": 1.4658129805029452,
  "monthlyRepaymentAmount": 5.637376656633329,
  "purpose": "purpose",
  "disbursementBic": "disbursementBic",
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "loanTypeCode": "loanTypeCode",
  "accountId": 0,
  "paymentDay": 7,
  "requestedAmount": 9.301444243932576,
  "applicationId": 6,
  "offeredAmount": 2.3021358869347655,
  "currencyCode": "currencyCode",
  "loanPeriod": 5,
  "disbursementIban": "disbursementIban"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique identifier for customer account
applicantName string false none Loan applicants name
applicationId integer(int64) false none Unique identifier to loan application
currencyCode string false none Currency - EUR, GDP, USD etc
disbursementBic string false none BIC for loan disbursement account
disbursementIban string false none IBAN of disbursement account
interestRate number false none Current interest rate
loanPeriod integer(int32) false none Loan period in months (for example 12 months)
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
monthlyRepaymentAmount number false none Wished for monthly payment entered by user, chosen with a slider etc
offeredAmount number false none Amount offered to customer
paymentDay integer(int32) false none Payment day - for example 12th
purpose string false none Purpose of loan
requestedAmount number false none Loan amount requested by customer
scheduleTypeCode string false none Schedule type - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL

CreateVersionJson

{
  "changeTypeCode": "changeTypeCode"
}

Properties

Name Type Required Restrictions Description
changeTypeCode string false none Reason for changing loan contract. For example - payment holiday, premature repayment, chaning payment date

DateRange

{
  "endDate": "2000-01-23",
  "startDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
endDate string(date) false none none
startDate string(date) false none none

EventJson

{
  "eventId": 6,
  "amount": 0.8008281904610115,
  "eventTypeCode": "eventTypeCode",
  "balanceDirectionCode": "balanceDirectionCode",
  "initialDebtAmount": 5.637376656633329,
  "postingDate": "2000-01-23",
  "headerId": 1,
  "fullyDeducted": true,
  "versionId": 7,
  "componentTypeCode": "componentTypeCode",
  "financeEventTypeCode": "financeEventTypeCode",
  "initialBalanceAmount": 5.962133916683182,
  "paymentId": 2,
  "details": "details",
  "currencyCode": "currencyCode",
  "effectiveDate": "2000-01-23",
  "debtDirectionCode": "debtDirectionCode"
}

Properties

Name Type Required Restrictions Description
amount number false none Event amount
balanceDirectionCode string false none Describes if balance is credited or debited - C, D
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
currencyCode string false none Currency - EUR, GDP, USD etc
debtDirectionCode string false none Describes if debt direction is debit or credit - C, D
details string false none Custom description for event
effectiveDate string(date) false none Date when the event should take place. Can be in the past (backvalue) or future
eventId integer(int64) false none Event unique identifier
eventTypeCode string false none Description of event - ACCRUAL; ACCRUAL_REVERSE; BAL_DECREASE; BAL_INCREASE; BAL_TO_DEBT; CALCULATION_DECREASE; CALCULATION_INCREASE; DEBT_DECREASE; DEBT_INCREASE; DEBT_TO_BAL; DISBURSEMENT; PENALTY_CALC_DECREASE; PENALTY_CALC_INCREASE; PREMATURE_REPAYMENT; REPAYMENT; REPAYMENT_REVERSAL; SCHEDULE; SCHEDULE_CANCEL; SCHEDULE_PROC_BALANCE; SCHEDULE_PROC_DEBT
financeEventTypeCode string false none none
fullyDeducted boolean false none Boolean desribing if event can happen only fully
headerId integer(int64) false none Reference to related loan contract header
initialBalanceAmount number false none Loan components balance before event
initialDebtAmount number false none Loan components debt before event
paymentId integer(int64) false none Filled in case event is related to payment
postingDate string(date) false none Creation date for event
versionId integer(int64) false none Reference to contract version

EventTypeJson

{
  "componentTypeCode": "componentTypeCode",
  "eventTypeCode": "eventTypeCode",
  "balanceDirectionCode": "balanceDirectionCode",
  "description": "description",
  "resetAccrual": true,
  "debtDirectionCode": "debtDirectionCode"
}

Properties

Name Type Required Restrictions Description
balanceDirectionCode string false none Describes if balance is credited or debited - C, D
componentTypeCode string false none Loan component type code - PRI (principal), INT (interest), PRI_P (principal late payment interest), ADM (administration fee), COF (conclusion fee), ALIM (limit change fee), CHANGE_FEE (contract changing fee), OTHER_FEE (other type of fee). Components can be dynamically added
debtDirectionCode string false none Describes if debt direction is debit or credit - C, D
description string false none Custom description of event
eventTypeCode string false none ACCRUAL; ACCRUAL_REVERSE; BAL_DECREASE; BAL_INCREASE; BAL_TO_DEBT; CALCULATION_DECREASE; CALCULATION_INCREASE; DEBT_DECREASE; DEBT_INCREASE; DEBT_TO_BAL; DISBURSEMENT; PENALTY_CALC_DECREASE; PENALTY_CALC_INCREASE; PREMATURE_REPAYMENT; REPAYMENT; REPAYMENT_REVERSAL; SCHEDULE; SCHEDULE_CANCEL; SCHEDULE_PROC_BALANCE; SCHEDULE_PROC_DEBT
resetAccrual boolean false none Boolean defining if event resets interest or penalty accrual

IntegerRange

{
  "endValue": 2,
  "startValue": 7
}

Properties

Name Type Required Restrictions Description
endValue integer(int32) false none none
startValue integer(int32) false none none

InterestConfigJson

{
  "calculationMethod": {
    "daysInMonth": "daysInMonth",
    "daysInYear": "daysInYear"
  },
  "paymentInterval": 1,
  "enabled": true
}

Properties

Name Type Required Restrictions Description
calculationMethod CalculationMethod false none none
enabled boolean false none none
paymentInterval integer(int32) false none Describes the monthly payment of interest

LoanInterestJson

{
  "interestRate": 5.637376656633329,
  "scoreRange": {
    "endValue": 2,
    "startValue": 7
  },
  "interestId": 5,
  "loanTypeCode": "loanTypeCode"
}

Properties

Name Type Required Restrictions Description
interestId integer(int64) false none Reference to existing interest identifier
interestRate number false none New interest rate value
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
scoreRange IntegerRange false none none

LoanJson

{
  "offer": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "application": {
    "amount": 6.027456183070403,
    "purpose": "purpose",
    "disbursementBic": "disbursementBic",
    "overdraft": true,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "loanTypeCode": "loanTypeCode",
    "accountId": 0,
    "paymentDay": 5,
    "loanGroupCode": "loanGroupCode",
    "personId": 2,
    "applicationId": 1,
    "currencyCode": "currencyCode",
    "loanPeriod": 5,
    "applicationDate": "2000-01-23",
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "overdraft": true,
  "contract": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "personId": 0
}

Properties

Name Type Required Restrictions Description
application ApplicationJson false none none
contract ContractJson false none none
offer OfferJson false none none
overdraft boolean false none Boolean defining if overdraft is allowed
personId integer(int64) false none Reference to customer

LoanTypeJson

{
  "overdraft": true,
  "conclusionFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "enabled": true
  },
  "description": "description",
  "administrationFee": {
    "amount": {
      "amount": 0.8008281904610115,
      "currencyCode": "currencyCode"
    },
    "paymentInterval": 6,
    "enabled": true
  },
  "loanTypeCode": "loanTypeCode",
  "applicationReviewRequired": true,
  "principal": {
    "paymentInterval": 9,
    "penaltyCalculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "hasPenalty": true,
    "penaltyRate": 3.616076749251911
  },
  "interest": {
    "calculationMethod": {
      "daysInMonth": "daysInMonth",
      "daysInYear": "daysInYear"
    },
    "paymentInterval": 1,
    "enabled": true
  },
  "loanGroupCode": "loanGroupCode",
  "collateralRequired": true,
  "signatureRequired": true,
  "contractReviewRequired": true,
  "periodRange": {
    "endValue": 2,
    "startValue": 7
  },
  "interests": [
    {
      "interestRate": 5.637376656633329,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interestId": 5,
      "loanTypeCode": "loanTypeCode"
    },
    {
      "interestRate": 5.637376656633329,
      "scoreRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interestId": 5,
      "loanTypeCode": "loanTypeCode"
    }
  ],
  "scheduleTypeCodes": [
    "scheduleTypeCodes",
    "scheduleTypeCodes"
  ]
}

Properties

Name Type Required Restrictions Description
administrationFee AdministrationFeeConfigJson false none none
applicationReviewRequired boolean false none Boolean defining if loan application needs to be reviewed or automatic decision can be made
collateralRequired boolean false none Boolean defining if collateral is required for loan
conclusionFee ConclusionFeeConfigJson false none none
contractReviewRequired boolean false none Boolean defining if contract review is required
description string false none Custom description about product
interest InterestConfigJson false none none
interests [LoanInterestJson] false none none
loanGroupCode string false none Loan group - for example BUSINESS_LOAN, CONSTRUCTION_LOAN, JOINT_MORTGAGE, OVERDRAFT_LOAN, REGULAR_MORTGAGE, SECURED_LOAN, UNSECURED_LOAN, VEHICLE_LOAN
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
overdraft boolean false none Boolean describing if overdraft is allowed
periodRange IntegerRange false none none
principal PrincipalConfigJson false none Loan principal component configuration component
scheduleTypeCodes [string] false none none
signatureRequired boolean false none Boolean describing if signature is required

Money

{
  "amount": 0.8008281904610115,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
amount number false none none
currencyCode string false none none

OfferInterestJson

{
  "interestRate": 0.8008281904610115
}

Properties

Name Type Required Restrictions Description
interestRate number false none Interest rate value for offer

OfferJson

{
  "monthlyRepaymentAmount": 7.061401241503109,
  "purpose": "purpose",
  "overdraft": true,
  "loanTypeCode": "loanTypeCode",
  "paymentDay": 4,
  "interestRate": 5.637376656633329,
  "numberOfPayments": 9,
  "apr": 5.962133916683182,
  "disbursementBic": "disbursementBic",
  "annuityAmount": 6.027456183070403,
  "scheduleTypeCode": "scheduleTypeCode",
  "applicantName": "applicantName",
  "accountId": 0,
  "application": {
    "amount": 6.027456183070403,
    "purpose": "purpose",
    "disbursementBic": "disbursementBic",
    "overdraft": true,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "loanTypeCode": "loanTypeCode",
    "accountId": 0,
    "paymentDay": 5,
    "loanGroupCode": "loanGroupCode",
    "personId": 2,
    "applicationId": 1,
    "currencyCode": "currencyCode",
    "loanPeriod": 5,
    "applicationDate": "2000-01-23",
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "loanGroupCode": "loanGroupCode",
  "offerDate": "2000-01-23",
  "offerId": 3,
  "personId": 7,
  "requestedAmount": 1.2315135367772556,
  "applicationId": 1,
  "offeredAmount": 2.027123023002322,
  "currencyCode": "currencyCode",
  "loanPeriod": 2,
  "disbursementIban": "disbursementIban",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Customer accounts unique identifier
annuityAmount number false none Monthly annuity payment amount
applicantName string false none Name of loan applicant
application ApplicationJson false none none
applicationId integer(int64) false none Reference to application the offer is for
apr number false none Annual percentage amount of loan contract
currencyCode string false none Underlying currency for offer
disbursementBic string false none BIC for loan disbursement account
disbursementIban string false none IBAN of disbursement account
interestRate number false none none
loanGroupCode string false none Loan group - for example BUSINESS_LOAN, CONSTRUCTION_LOAN, JOINT_MORTGAGE, OVERDRAFT_LOAN, REGULAR_MORTGAGE, SECURED_LOAN, UNSECURED_LOAN, VEHICLE_LOAN
loanPeriod integer(int32) false none Loan period in months (for example 12 months)
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
monthlyRepaymentAmount number false none Monthly payment amount according to schedule
numberOfPayments integer(int32) false none Total number of payments
offerDate string(date) false none Date when offer is presented
offerId integer(int64) false none Loan offer unique identifier
offeredAmount number false none Offered loan amount to the customer
overdraft boolean false none Boolean defining if offer is for overdraft
paymentDay integer(int32) false none Payment day - for example 12th
personId integer(int64) false none Unique identifier of customer
purpose string false none Purpose of loan
requestedAmount number false none Amount requested by customer
scheduleTypeCode string false none Schedule type used - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL
statusCode string false none PREPARING, PRESENTED, ACCEPTED, CANCELED

PostingDateChangeJson

{
  "newPostingDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
newPostingDate string(date) false none none

PresentOfferJson

{
  "interestRate": 0.8008281904610115
}

Properties

Name Type Required Restrictions Description
interestRate number false none none

PrincipalConfigJson

{
  "paymentInterval": 9,
  "penaltyCalculationMethod": {
    "daysInMonth": "daysInMonth",
    "daysInYear": "daysInYear"
  },
  "hasPenalty": true,
  "penaltyRate": 3.616076749251911
}

Loan principal component configuration component

Properties

Name Type Required Restrictions Description
hasPenalty boolean false none Boolean defining if late penalty interest is collected on principal
paymentInterval integer(int32) false none Describes how often payments should be done for principal
penaltyCalculationMethod CalculationMethod false none none
penaltyRate number false none Describes late payment interest rate

QuoteInputJson

{
  "interestRate": 1.4658129805029452,
  "serviceFee": 2.3021358869347655,
  "monthlyPaymentDay": 5,
  "amount": 0.8008281904610115,
  "conclusionFee": 6.027456183070403,
  "disbursementDate": "2000-01-23",
  "currency": "currency",
  "maturityMonths": 5,
  "scheduleTypeCode": "scheduleTypeCode",
  "loanTypeCode": "loanTypeCode"
}

Properties

Name Type Required Restrictions Description
amount number false none Applied loan amount
conclusionFee number false none Conclusion fee
currency string false none Currency - EUR, GDP, USD etc
disbursementDate string(date) false none Date of loan disbursement
interestRate number false none Current interest rate
loanTypeCode string false none Loan product identifier, for example LOAN_PRODUCT1
maturityMonths integer(int32) false none Loan contract length in months
monthlyPaymentDay integer(int32) false none Payment day - for example 12th
scheduleTypeCode string false none Schedule type used - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL
serviceFee number false none Amount of monthly service fee

QuoteJson

{
  "apr": 0.8008281904610115,
  "monthlyPayment": 6.027456183070403,
  "scheduleLines": [
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    },
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    }
  ],
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
apr number false none Annual percentage rate
currencyCode string false none Currency - EUR, GDP, USD etc
monthlyPayment number false none Monthly payment amount
scheduleLines [ScheduleJson] false none none

ScheduleDateJson

{
  "date": "2000-01-23",
  "principal": true,
  "interest": true
}

Schedule row object

Properties

Name Type Required Restrictions Description
date string(date) false none Date of payment
interest boolean false none Boolean defining if interest has to be paid on that date
principal boolean false none Boolean defining if principal has to be on that date

ScheduleJson

{
  "feeAmount": 5.025004791520295,
  "totalAmount": 9.018348186070783,
  "interestAmount": 9.369310271410669,
  "paymentDate": "2000-01-23",
  "currencyCode": "currencyCode",
  "initialPrincipalAmount": 9.965781217890562,
  "remainingPrincipalAmount": 8.762042012749001,
  "principalAmount": 6.683562403749608
}

Properties

Name Type Required Restrictions Description
currencyCode string false none Currency - EUR, GDP, USD etc
feeAmount number false none Fee amount to be paid on scheduled date
initialPrincipalAmount number false none Initial principal amount before scheduled payment
interestAmount number false none Interest amount to be paid on scheduled date
paymentDate string(date) false none Payment date
principalAmount number false none Principal amount to be paid on scheduled date
remainingPrincipalAmount number false none Principal amount left after scheduled payment
totalAmount number false none Total amount to be paid on scheduled date (principal + interest + fees)

UpdateVersionJson

{
  "activationSteps": [
    {
      "amount": 0.8008281904610115,
      "id": 6
    },
    {
      "amount": 0.8008281904610115,
      "id": 6
    }
  ],
  "firstInterestPaymentDate": "2000-01-23",
  "gracePeriod": 7,
  "components": [
    {
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "componentTypeCode": "componentTypeCode",
      "paymentIntervalMonths": 5,
      "paymentDay": 1,
      "rate": 5.637376656633329,
      "calculationDaysMonth": "calculationDaysMonth",
      "scheduleTypeCode": "scheduleTypeCode",
      "regularAmount": 2.3021358869347655
    },
    {
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "componentTypeCode": "componentTypeCode",
      "paymentIntervalMonths": 5,
      "paymentDay": 1,
      "rate": 5.637376656633329,
      "calculationDaysMonth": "calculationDaysMonth",
      "scheduleTypeCode": "scheduleTypeCode",
      "regularAmount": 2.3021358869347655
    }
  ],
  "period": 3,
  "scheduleDates": [
    {
      "date": "2000-01-23",
      "principal": true,
      "interest": true
    },
    {
      "date": "2000-01-23",
      "principal": true,
      "interest": true
    }
  ],
  "plannedActivationDate": "2000-01-23",
  "principalScheduleDefinitionTypeCode": "principalScheduleDefinitionTypeCode",
  "firstPrincipalPaymentDate": "2000-01-23",
  "loanAmount": 9.301444243932576
}

Properties

Name Type Required Restrictions Description
activationSteps [ActivationStepUpdateJson] false none [Update existing loan steps - for example taking a fee and loan disbursement are considered as activation steps]
components [ComponentUpdateJson] false none none
firstInterestPaymentDate string(date) false none First interest payment date
firstPrincipalPaymentDate string(date) false none First principal payment date
gracePeriod integer(int32) false none Grace period
loanAmount number false none Total loan amount
period integer(int32) false none Number of scheduled payments
plannedActivationDate string(date) false none Planned activation date
principalScheduleDefinitionTypeCode string false none Schedule type used - ANNUITY, AMORTISATION, BULLET, FOLLOWFIX, ACT, ANNUITY_ADJUSTED, AMORTISATION_ADJUSTED, MANUAL
scheduleDates [ScheduleDateJson] false none [Schedule row object]

ResponseJson_ApplicationJson_

{
  "data": {
    "amount": 6.027456183070403,
    "purpose": "purpose",
    "disbursementBic": "disbursementBic",
    "overdraft": true,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "loanTypeCode": "loanTypeCode",
    "accountId": 0,
    "paymentDay": 5,
    "loanGroupCode": "loanGroupCode",
    "personId": 2,
    "applicationId": 1,
    "currencyCode": "currencyCode",
    "loanPeriod": 5,
    "applicationDate": "2000-01-23",
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data ApplicationJson false none none
errors [string] false none none

ResponseJson_ContractJson_

{
  "data": {
    "endDate": "2000-01-23",
    "purpose": "purpose",
    "loanAmountRemaining": 1.2315135367772556,
    "overdraft": true,
    "otherDebtAmount": 1.4894159098541704,
    "headerId": 9,
    "loanTypeCode": "loanTypeCode",
    "interestDebtAmount": 2.027123023002322,
    "overdraftAccountId": 6,
    "debtAmount": 2.3021358869347655,
    "interestRate": 4.145608029883936,
    "preparationDate": "2000-01-23",
    "limitUsageDate": "2000-01-23",
    "apr": 5.637376656633329,
    "period": 7,
    "interestBalanceAmount": 3.616076749251911,
    "principalDebtAmount": 4.965218492984954,
    "annuityAmount": 1.4658129805029452,
    "contractNumber": "contractNumber",
    "loanAmount": 7.386281948385884,
    "accountId": 0,
    "feeAmount": 7.061401241503109,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "loanGroupCode": "loanGroupCode",
    "activeVersionId": 6,
    "offerId": 1,
    "personId": 1,
    "activationDate": "2000-01-23",
    "applicationId": 5,
    "currencyCode": "currencyCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data ContractJson false none none
errors [string] false none none

ResponseJson_ContractVersionJson_

{
  "data": {
    "interestRate": 1.4894159098541704,
    "preparationDate": "2000-01-23",
    "gracePeriod": 7,
    "numberOfPayments": 4,
    "apr": 6.027456183070403,
    "components": [
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      },
      {
        "componentId": 5,
        "debtStartDate": "2000-01-23",
        "scheduleTypeCode": "scheduleTypeCode",
        "balanceAmount": 1.4658129805029452,
        "accruedUntilDate": "2000-01-23",
        "regularAmount": 2.027123023002322,
        "calculationDaysYear": "calculationDaysYear",
        "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
        "versionId": 4,
        "componentTypeCode": "componentTypeCode",
        "paymentDay": 7,
        "paymentInterval": 9,
        "rate": 3.616076749251911,
        "scheduleStartDate": "2000-01-23",
        "initialAmount": 2.3021358869347655,
        "baseInvalidFromDate": "2000-01-23",
        "calculationDaysMonth": "calculationDaysMonth",
        "currencyCode": "currencyCode",
        "debtAmount": 5.637376656633329,
        "rateBaseCode": "rateBaseCode"
      }
    ],
    "period": 9,
    "endDate": "2000-01-23",
    "loanAmountRemaining": 1.1730742509559433,
    "principalDebtAmount": 6.683562403749608,
    "annuityAmount": 0.8008281904610115,
    "otherDebtAmount": 5.025004791520295,
    "headerId": 1,
    "loanAmount": 7.457744773683766,
    "versionNumber": 9,
    "schedule": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "interestDebtAmount": 1.0246457001441578,
    "versionId": 8,
    "changeTypeCode": "changeTypeCode",
    "limitAmount": 6.84685269835264,
    "personId": 9,
    "activationDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data ContractVersionJson false none none
errors [string] false none none

ResponseJson_List_ApplicationJson_

{
  "data": [
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ApplicationJson] false none none
errors [string] false none none

ResponseJson_List_ContractInterestJson_

{
  "data": [
    {
      "amount": 0.8008281904610115,
      "componentTypeCode": "componentTypeCode",
      "calculationRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      },
      "numberOfDays": 6,
      "currencyCode": "currencyCode"
    },
    {
      "amount": 0.8008281904610115,
      "componentTypeCode": "componentTypeCode",
      "calculationRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      },
      "numberOfDays": 6,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ContractInterestJson] false none none
errors [string] false none none

ResponseJson_List_ContractJson_

{
  "data": [
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    },
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ContractJson] false none none
errors [string] false none none

ResponseJson_LoanTypeJson_

{
  "data": {
    "overdraft": true,
    "conclusionFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "enabled": true
    },
    "description": "description",
    "administrationFee": {
      "amount": {
        "amount": 0.8008281904610115,
        "currencyCode": "currencyCode"
      },
      "paymentInterval": 6,
      "enabled": true
    },
    "loanTypeCode": "loanTypeCode",
    "applicationReviewRequired": true,
    "principal": {
      "paymentInterval": 9,
      "penaltyCalculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "hasPenalty": true,
      "penaltyRate": 3.616076749251911
    },
    "interest": {
      "calculationMethod": {
        "daysInMonth": "daysInMonth",
        "daysInYear": "daysInYear"
      },
      "paymentInterval": 1,
      "enabled": true
    },
    "loanGroupCode": "loanGroupCode",
    "collateralRequired": true,
    "signatureRequired": true,
    "contractReviewRequired": true,
    "periodRange": {
      "endValue": 2,
      "startValue": 7
    },
    "interests": [
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      },
      {
        "interestRate": 5.637376656633329,
        "scoreRange": {
          "endValue": 2,
          "startValue": 7
        },
        "interestId": 5,
        "loanTypeCode": "loanTypeCode"
      }
    ],
    "scheduleTypeCodes": [
      "scheduleTypeCodes",
      "scheduleTypeCodes"
    ]
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data LoanTypeJson false none none
errors [string] false none none

ResponseJson_OfferInterestJson_

{
  "data": {
    "interestRate": 0.8008281904610115
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data OfferInterestJson false none none
errors [string] false none none

ResponseJson_OfferJson_

{
  "data": {
    "monthlyRepaymentAmount": 7.061401241503109,
    "purpose": "purpose",
    "overdraft": true,
    "loanTypeCode": "loanTypeCode",
    "paymentDay": 4,
    "interestRate": 5.637376656633329,
    "numberOfPayments": 9,
    "apr": 5.962133916683182,
    "disbursementBic": "disbursementBic",
    "annuityAmount": 6.027456183070403,
    "scheduleTypeCode": "scheduleTypeCode",
    "applicantName": "applicantName",
    "accountId": 0,
    "application": {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    "loanGroupCode": "loanGroupCode",
    "offerDate": "2000-01-23",
    "offerId": 3,
    "personId": 7,
    "requestedAmount": 1.2315135367772556,
    "applicationId": 1,
    "offeredAmount": 2.027123023002322,
    "currencyCode": "currencyCode",
    "loanPeriod": 2,
    "disbursementIban": "disbursementIban",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data OfferJson false none none
errors [string] false none none

ResponseJson_QuoteJson_

{
  "data": {
    "apr": 0.8008281904610115,
    "monthlyPayment": 6.027456183070403,
    "scheduleLines": [
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      },
      {
        "feeAmount": 5.025004791520295,
        "totalAmount": 9.018348186070783,
        "interestAmount": 9.369310271410669,
        "paymentDate": "2000-01-23",
        "currencyCode": "currencyCode",
        "initialPrincipalAmount": 9.965781217890562,
        "remainingPrincipalAmount": 8.762042012749001,
        "principalAmount": 6.683562403749608
      }
    ],
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data QuoteJson false none none
errors [string] false none none

ResponseJson_Void_

{
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
errors [string] false none none

ResponseListJson_List_ApplicationJson_

{
  "data": [
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "amount": 6.027456183070403,
      "purpose": "purpose",
      "disbursementBic": "disbursementBic",
      "overdraft": true,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "loanTypeCode": "loanTypeCode",
      "accountId": 0,
      "paymentDay": 5,
      "loanGroupCode": "loanGroupCode",
      "personId": 2,
      "applicationId": 1,
      "currencyCode": "currencyCode",
      "loanPeriod": 5,
      "applicationDate": "2000-01-23",
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ApplicationJson] false none none
errors [string] false none none

ResponseListJson_List_ComponentJson_

{
  "data": [
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    },
    {
      "componentId": 5,
      "debtStartDate": "2000-01-23",
      "scheduleTypeCode": "scheduleTypeCode",
      "balanceAmount": 1.4658129805029452,
      "accruedUntilDate": "2000-01-23",
      "regularAmount": 2.027123023002322,
      "calculationDaysYear": "calculationDaysYear",
      "scheduleDefinitionTypeCode": "scheduleDefinitionTypeCode",
      "versionId": 4,
      "componentTypeCode": "componentTypeCode",
      "paymentDay": 7,
      "paymentInterval": 9,
      "rate": 3.616076749251911,
      "scheduleStartDate": "2000-01-23",
      "initialAmount": 2.3021358869347655,
      "baseInvalidFromDate": "2000-01-23",
      "calculationDaysMonth": "calculationDaysMonth",
      "currencyCode": "currencyCode",
      "debtAmount": 5.637376656633329,
      "rateBaseCode": "rateBaseCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ComponentJson] false none none
errors [string] false none none

ResponseListJson_List_ComponentTypeJson_

{
  "data": [
    {
      "separateRepaymentOrders": true,
      "componentTypeCode": "componentTypeCode",
      "feeLike": true,
      "penalty": true,
      "baseComponentTypeCode": "baseComponentTypeCode",
      "name": "name",
      "interestLike": true,
      "holdsBalance": true,
      "processingOrder": 0,
      "basePositionCode": "basePositionCode"
    },
    {
      "separateRepaymentOrders": true,
      "componentTypeCode": "componentTypeCode",
      "feeLike": true,
      "penalty": true,
      "baseComponentTypeCode": "baseComponentTypeCode",
      "name": "name",
      "interestLike": true,
      "holdsBalance": true,
      "processingOrder": 0,
      "basePositionCode": "basePositionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ComponentTypeJson] false none none
errors [string] false none none

ResponseListJson_List_ContractJson_

{
  "data": [
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    },
    {
      "endDate": "2000-01-23",
      "purpose": "purpose",
      "loanAmountRemaining": 1.2315135367772556,
      "overdraft": true,
      "otherDebtAmount": 1.4894159098541704,
      "headerId": 9,
      "loanTypeCode": "loanTypeCode",
      "interestDebtAmount": 2.027123023002322,
      "overdraftAccountId": 6,
      "debtAmount": 2.3021358869347655,
      "interestRate": 4.145608029883936,
      "preparationDate": "2000-01-23",
      "limitUsageDate": "2000-01-23",
      "apr": 5.637376656633329,
      "period": 7,
      "interestBalanceAmount": 3.616076749251911,
      "principalDebtAmount": 4.965218492984954,
      "annuityAmount": 1.4658129805029452,
      "contractNumber": "contractNumber",
      "loanAmount": 7.386281948385884,
      "accountId": 0,
      "feeAmount": 7.061401241503109,
      "schedule": [
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        },
        {
          "feeAmount": 5.025004791520295,
          "totalAmount": 9.018348186070783,
          "interestAmount": 9.369310271410669,
          "paymentDate": "2000-01-23",
          "currencyCode": "currencyCode",
          "initialPrincipalAmount": 9.965781217890562,
          "remainingPrincipalAmount": 8.762042012749001,
          "principalAmount": 6.683562403749608
        }
      ],
      "loanGroupCode": "loanGroupCode",
      "activeVersionId": 6,
      "offerId": 1,
      "personId": 1,
      "activationDate": "2000-01-23",
      "applicationId": 5,
      "currencyCode": "currencyCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ContractJson] false none none
errors [string] false none none

ResponseListJson_List_EventJson_

{
  "data": [
    {
      "eventId": 6,
      "amount": 0.8008281904610115,
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "initialDebtAmount": 5.637376656633329,
      "postingDate": "2000-01-23",
      "headerId": 1,
      "fullyDeducted": true,
      "versionId": 7,
      "componentTypeCode": "componentTypeCode",
      "financeEventTypeCode": "financeEventTypeCode",
      "initialBalanceAmount": 5.962133916683182,
      "paymentId": 2,
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23",
      "debtDirectionCode": "debtDirectionCode"
    },
    {
      "eventId": 6,
      "amount": 0.8008281904610115,
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "initialDebtAmount": 5.637376656633329,
      "postingDate": "2000-01-23",
      "headerId": 1,
      "fullyDeducted": true,
      "versionId": 7,
      "componentTypeCode": "componentTypeCode",
      "financeEventTypeCode": "financeEventTypeCode",
      "initialBalanceAmount": 5.962133916683182,
      "paymentId": 2,
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23",
      "debtDirectionCode": "debtDirectionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [EventJson] false none none
errors [string] false none none

ResponseListJson_List_EventTypeJson_

{
  "data": [
    {
      "componentTypeCode": "componentTypeCode",
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "description": "description",
      "resetAccrual": true,
      "debtDirectionCode": "debtDirectionCode"
    },
    {
      "componentTypeCode": "componentTypeCode",
      "eventTypeCode": "eventTypeCode",
      "balanceDirectionCode": "balanceDirectionCode",
      "description": "description",
      "resetAccrual": true,
      "debtDirectionCode": "debtDirectionCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [EventTypeJson] false none none
errors [string] false none none

ResponseListJson_List_LoanJson_

{
  "data": [
    {
      "offer": {
        "monthlyRepaymentAmount": 7.061401241503109,
        "purpose": "purpose",
        "overdraft": true,
        "loanTypeCode": "loanTypeCode",
        "paymentDay": 4,
        "interestRate": 5.637376656633329,
        "numberOfPayments": 9,
        "apr": 5.962133916683182,
        "disbursementBic": "disbursementBic",
        "annuityAmount": 6.027456183070403,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "accountId": 0,
        "application": {
          "amount": 6.027456183070403,
          "purpose": "purpose",
          "disbursementBic": "disbursementBic",
          "overdraft": true,
          "scheduleTypeCode": "scheduleTypeCode",
          "applicantName": "applicantName",
          "loanTypeCode": "loanTypeCode",
          "accountId": 0,
          "paymentDay": 5,
          "loanGroupCode": "loanGroupCode",
          "personId": 2,
          "applicationId": 1,
          "currencyCode": "currencyCode",
          "loanPeriod": 5,
          "applicationDate": "2000-01-23",
          "disbursementIban": "disbursementIban",
          "statusCode": "statusCode"
        },
        "loanGroupCode": "loanGroupCode",
        "offerDate": "2000-01-23",
        "offerId": 3,
        "personId": 7,
        "requestedAmount": 1.2315135367772556,
        "applicationId": 1,
        "offeredAmount": 2.027123023002322,
        "currencyCode": "currencyCode",
        "loanPeriod": 2,
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "overdraft": true,
      "contract": {
        "endDate": "2000-01-23",
        "purpose": "purpose",
        "loanAmountRemaining": 1.2315135367772556,
        "overdraft": true,
        "otherDebtAmount": 1.4894159098541704,
        "headerId": 9,
        "loanTypeCode": "loanTypeCode",
        "interestDebtAmount": 2.027123023002322,
        "overdraftAccountId": 6,
        "debtAmount": 2.3021358869347655,
        "interestRate": 4.145608029883936,
        "preparationDate": "2000-01-23",
        "limitUsageDate": "2000-01-23",
        "apr": 5.637376656633329,
        "period": 7,
        "interestBalanceAmount": 3.616076749251911,
        "principalDebtAmount": 4.965218492984954,
        "annuityAmount": 1.4658129805029452,
        "contractNumber": "contractNumber",
        "loanAmount": 7.386281948385884,
        "accountId": 0,
        "feeAmount": 7.061401241503109,
        "schedule": [
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          },
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          }
        ],
        "loanGroupCode": "loanGroupCode",
        "activeVersionId": 6,
        "offerId": 1,
        "personId": 1,
        "activationDate": "2000-01-23",
        "applicationId": 5,
        "currencyCode": "currencyCode",
        "statusCode": "statusCode"
      },
      "personId": 0
    },
    {
      "offer": {
        "monthlyRepaymentAmount": 7.061401241503109,
        "purpose": "purpose",
        "overdraft": true,
        "loanTypeCode": "loanTypeCode",
        "paymentDay": 4,
        "interestRate": 5.637376656633329,
        "numberOfPayments": 9,
        "apr": 5.962133916683182,
        "disbursementBic": "disbursementBic",
        "annuityAmount": 6.027456183070403,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "accountId": 0,
        "application": {
          "amount": 6.027456183070403,
          "purpose": "purpose",
          "disbursementBic": "disbursementBic",
          "overdraft": true,
          "scheduleTypeCode": "scheduleTypeCode",
          "applicantName": "applicantName",
          "loanTypeCode": "loanTypeCode",
          "accountId": 0,
          "paymentDay": 5,
          "loanGroupCode": "loanGroupCode",
          "personId": 2,
          "applicationId": 1,
          "currencyCode": "currencyCode",
          "loanPeriod": 5,
          "applicationDate": "2000-01-23",
          "disbursementIban": "disbursementIban",
          "statusCode": "statusCode"
        },
        "loanGroupCode": "loanGroupCode",
        "offerDate": "2000-01-23",
        "offerId": 3,
        "personId": 7,
        "requestedAmount": 1.2315135367772556,
        "applicationId": 1,
        "offeredAmount": 2.027123023002322,
        "currencyCode": "currencyCode",
        "loanPeriod": 2,
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "overdraft": true,
      "contract": {
        "endDate": "2000-01-23",
        "purpose": "purpose",
        "loanAmountRemaining": 1.2315135367772556,
        "overdraft": true,
        "otherDebtAmount": 1.4894159098541704,
        "headerId": 9,
        "loanTypeCode": "loanTypeCode",
        "interestDebtAmount": 2.027123023002322,
        "overdraftAccountId": 6,
        "debtAmount": 2.3021358869347655,
        "interestRate": 4.145608029883936,
        "preparationDate": "2000-01-23",
        "limitUsageDate": "2000-01-23",
        "apr": 5.637376656633329,
        "period": 7,
        "interestBalanceAmount": 3.616076749251911,
        "principalDebtAmount": 4.965218492984954,
        "annuityAmount": 1.4658129805029452,
        "contractNumber": "contractNumber",
        "loanAmount": 7.386281948385884,
        "accountId": 0,
        "feeAmount": 7.061401241503109,
        "schedule": [
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          },
          {
            "feeAmount": 5.025004791520295,
            "totalAmount": 9.018348186070783,
            "interestAmount": 9.369310271410669,
            "paymentDate": "2000-01-23",
            "currencyCode": "currencyCode",
            "initialPrincipalAmount": 9.965781217890562,
            "remainingPrincipalAmount": 8.762042012749001,
            "principalAmount": 6.683562403749608
          }
        ],
        "loanGroupCode": "loanGroupCode",
        "activeVersionId": 6,
        "offerId": 1,
        "personId": 1,
        "activationDate": "2000-01-23",
        "applicationId": 5,
        "currencyCode": "currencyCode",
        "statusCode": "statusCode"
      },
      "personId": 0
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [LoanJson] false none none
errors [string] false none none

ResponseListJson_List_LoanTypeJson_

{
  "data": [
    {
      "overdraft": true,
      "conclusionFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "enabled": true
      },
      "description": "description",
      "administrationFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "paymentInterval": 6,
        "enabled": true
      },
      "loanTypeCode": "loanTypeCode",
      "applicationReviewRequired": true,
      "principal": {
        "paymentInterval": 9,
        "penaltyCalculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "hasPenalty": true,
        "penaltyRate": 3.616076749251911
      },
      "interest": {
        "calculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "paymentInterval": 1,
        "enabled": true
      },
      "loanGroupCode": "loanGroupCode",
      "collateralRequired": true,
      "signatureRequired": true,
      "contractReviewRequired": true,
      "periodRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interests": [
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        },
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        }
      ],
      "scheduleTypeCodes": [
        "scheduleTypeCodes",
        "scheduleTypeCodes"
      ]
    },
    {
      "overdraft": true,
      "conclusionFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "enabled": true
      },
      "description": "description",
      "administrationFee": {
        "amount": {
          "amount": 0.8008281904610115,
          "currencyCode": "currencyCode"
        },
        "paymentInterval": 6,
        "enabled": true
      },
      "loanTypeCode": "loanTypeCode",
      "applicationReviewRequired": true,
      "principal": {
        "paymentInterval": 9,
        "penaltyCalculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "hasPenalty": true,
        "penaltyRate": 3.616076749251911
      },
      "interest": {
        "calculationMethod": {
          "daysInMonth": "daysInMonth",
          "daysInYear": "daysInYear"
        },
        "paymentInterval": 1,
        "enabled": true
      },
      "loanGroupCode": "loanGroupCode",
      "collateralRequired": true,
      "signatureRequired": true,
      "contractReviewRequired": true,
      "periodRange": {
        "endValue": 2,
        "startValue": 7
      },
      "interests": [
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        },
        {
          "interestRate": 5.637376656633329,
          "scoreRange": {
            "endValue": 2,
            "startValue": 7
          },
          "interestId": 5,
          "loanTypeCode": "loanTypeCode"
        }
      ],
      "scheduleTypeCodes": [
        "scheduleTypeCodes",
        "scheduleTypeCodes"
      ]
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [LoanTypeJson] false none none
errors [string] false none none

ResponseListJson_List_OfferJson_

{
  "data": [
    {
      "monthlyRepaymentAmount": 7.061401241503109,
      "purpose": "purpose",
      "overdraft": true,
      "loanTypeCode": "loanTypeCode",
      "paymentDay": 4,
      "interestRate": 5.637376656633329,
      "numberOfPayments": 9,
      "apr": 5.962133916683182,
      "disbursementBic": "disbursementBic",
      "annuityAmount": 6.027456183070403,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "accountId": 0,
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "loanGroupCode": "loanGroupCode",
      "offerDate": "2000-01-23",
      "offerId": 3,
      "personId": 7,
      "requestedAmount": 1.2315135367772556,
      "applicationId": 1,
      "offeredAmount": 2.027123023002322,
      "currencyCode": "currencyCode",
      "loanPeriod": 2,
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    },
    {
      "monthlyRepaymentAmount": 7.061401241503109,
      "purpose": "purpose",
      "overdraft": true,
      "loanTypeCode": "loanTypeCode",
      "paymentDay": 4,
      "interestRate": 5.637376656633329,
      "numberOfPayments": 9,
      "apr": 5.962133916683182,
      "disbursementBic": "disbursementBic",
      "annuityAmount": 6.027456183070403,
      "scheduleTypeCode": "scheduleTypeCode",
      "applicantName": "applicantName",
      "accountId": 0,
      "application": {
        "amount": 6.027456183070403,
        "purpose": "purpose",
        "disbursementBic": "disbursementBic",
        "overdraft": true,
        "scheduleTypeCode": "scheduleTypeCode",
        "applicantName": "applicantName",
        "loanTypeCode": "loanTypeCode",
        "accountId": 0,
        "paymentDay": 5,
        "loanGroupCode": "loanGroupCode",
        "personId": 2,
        "applicationId": 1,
        "currencyCode": "currencyCode",
        "loanPeriod": 5,
        "applicationDate": "2000-01-23",
        "disbursementIban": "disbursementIban",
        "statusCode": "statusCode"
      },
      "loanGroupCode": "loanGroupCode",
      "offerDate": "2000-01-23",
      "offerId": 3,
      "personId": 7,
      "requestedAmount": 1.2315135367772556,
      "applicationId": 1,
      "offeredAmount": 2.027123023002322,
      "currencyCode": "currencyCode",
      "loanPeriod": 2,
      "disbursementIban": "disbursementIban",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [OfferJson] false none none
errors [string] false none none

ResponseListJson_List_ScheduleJson_

{
  "data": [
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    },
    {
      "feeAmount": 5.025004791520295,
      "totalAmount": 9.018348186070783,
      "interestAmount": 9.369310271410669,
      "paymentDate": "2000-01-23",
      "currencyCode": "currencyCode",
      "initialPrincipalAmount": 9.965781217890562,
      "remainingPrincipalAmount": 8.762042012749001,
      "principalAmount": 6.683562403749608
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ScheduleJson] false none none
errors [string] false none none