Simulate Borrower

POST /v1/borrowers/{borrower_id}/simulate

Simulates the status of a borrower with the new items provided in the request

Path parameters

borrower_id string Required

The id of the borrower to simulate.

application/json

Body

allocations array[object] | null

The payment allocations to simulate. If not provided, no payment allocations will be simulated.
Hide allocations attributes Show allocations attributes object
- payment_allocations array[object] | null
  Hide payment_allocations attributes Show payment_allocations attributes object
  
  amount number
  
  Represents the allocated amount, which is a specific portion of the payment, assigned to a particular loan. It indicates the portion of the payment that is designated for the specified loan within the payment allocation process. It is important to note that the sum of all the allocated amounts in each payment allocation object must be equal to the total payment amount.
  
  Minimum value is 0.
  
  loan_id string
  
  Indicates the loan to which the specified amount in the amount field will be allocated. It identifies the specific loan within the payment allocation process where the designated portion of the payment will be directed.
- payment_id string
calculation_date string(date-time)

The date to use for the simulation. If not provided, the current date will be used.
payments array[object] | null

The payments to simulate. If not provided, no payments will be simulated.
Hide payments attributes Show payments attributes object
- amount_paid number
  
  The amount paid by the borrower.
  
  Minimum value is 0.
- config_id string
  
  The ID of the payment configuration associated with this payment.
- payment_date string(date-time)
  
  The date on which the payment was made.
- payment_id string
request_id string

Optional field that will be returned unmodified in each response. Especially useful for keeping track of responses in batch requests.
restructurings array[object] | null

The restructurings to simulate. If not provided, no restructurings will be simulated.
Hide restructurings attributes Show restructurings attributes object
- amortization_method null | string
- amount_financed null | number
- config_id string
- delinquency_interest_rate null | number
- due_dates null | array[string(date-time)]
- effective_date string(date-time)
- installment_fee null | number
- interest_rate null | number
- loan_id string
  
  The id of the loan to which the waiver applies.
- manual_pmts null | object
  Hide manual_pmts attribute Show manual_pmts attribute null | object
  
  * integer Additional properties
waivers array[object] | null

The waivers to simulate. If not provided, no waivers will be simulated.
Hide waivers attributes Show waivers attributes object
- amount null | number
  
  The amount to be waived.
  
  Minimum value is 0.
- bucket string
  
  The bucket to which the waiver will be applied.
  
  Values are all, principal, non_overdue_principal, interest, delinquency_interest, installment_fee, current_installment_fee, current_installment, non_overdue_installment_fee, current_principal, overdue_principal, overdue_interest, discount_at_origination, overdue_installment_fee, or late_fee.
- config_id null | string
  
  The ID of the configuration to be used for the waiver.
- effective_date string(date-time)
  
  The date on which the waiver is to be effective.
- loan_id string
  
  The id of the loan to which the waiver applies.
- percentage null | number
  
  The % to be waived.
  
  Minimum value is 0, maximum value is 1.
- reason null | string
  
  The reason for the waiver.
- type string
  
  The type of waiver to be applied. The two options are percentage and amount.
  
  Values are percentage or amount.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- borrower_id string
- calculation_date string(date-time)
  
  The status shown corresponds to this date
- loans array[object] | null
  
  Hide loans attributes Show loans attributes object
  
  attributes object
  
  Additional properties are allowed.
  
  Hide attributes attributes Show attributes attributes object
  
  amount_financed number
  
  Amount that was financed for the loan
  
  chargeoff_date null | string
  
  Date when the loan was charged off
  
  config_id string
  
  Configuration ID related to the loan
  
  due_dates array[string(date-time)] | null
  
  Due dates for the loan installments
  
  fixed_installment_amount number
  
  Amount due for each installment of the loan, it does not include daily fees.
  
  id string
  
  Unique identifier for the loan
  
  installment_amount_at_origination number
  
  Initial amount of the installment payment, it does not include daily fees.
  
  interest_rates object
  
  Interest rates applicable for the loan
  
  Additional properties are allowed.
  
  Hide interest_rates attributes Show interest_rates attributes object
  
  applicable number
  
  fixed number
  
  is_cancelled boolean
  
  Indicates if the loan is cancelled
  
  kordev_id integer
  
  Internal identifier for the loan
  
  origination_date string(date-time)
  
  Date when the loan was originated
  
  owner string
  
  Owner of the loan
  
  paid_off_date null | string
  
  Date when the loan was paid off
  
  balance_detail object
  
  Additional properties are allowed.
  
  Hide balance_detail attributes Show balance_detail attributes object
  
  at_calculation_date object
  
  Shows the loan's balance at the calculation date.
  
  Additional properties are allowed.
  
  Hide at_calculation_date attributes Show at_calculation_date attributes object
  
  daily_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide daily_fee attributes Show daily_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  delinquency_interest object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide delinquency_interest attributes Show delinquency_interest attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  initial_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide initial_fee attributes Show initial_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  installment_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide installment_fee attributes Show installment_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  installment_fee_2 object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide installment_fee_2 attributes Show installment_fee_2 attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  interest object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide interest attributes Show interest attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  late_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide late_fee attributes Show late_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  principal object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide principal attributes Show principal attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  at_next_due_date object
  
  Shows the loan's balance at the calculation date.
  
  Additional properties are allowed.
  
  Hide at_next_due_date attributes Show at_next_due_date attributes object
  
  daily_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide daily_fee attributes Show daily_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  delinquency_interest object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide delinquency_interest attributes Show delinquency_interest attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  initial_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide initial_fee attributes Show initial_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  installment_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide installment_fee attributes Show installment_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  installment_fee_2 object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide installment_fee_2 attributes Show installment_fee_2 attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  interest object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide interest attributes Show interest attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  late_fee object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide late_fee attributes Show late_fee attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  principal object
  
  Shows the detail for the daily fee bucket.
  
  Additional properties are allowed.
  
  Hide principal attributes Show principal attributes object
  
  charged_off number
  
  Shows the amount of money is charged off in the bucket.
  
  current number
  
  Shows the pending balance for the bucket.
  
  initial_balance number
  
  Shows the balance of the bucket at the origination date.
  
  overdue number
  
  Shows the amount of money that is overdue in the bucket.
  
  paid number
  
  Shows the amount of money that has been imputed to the bucket.
  
  unpaid number
  
  Shows the outstanding balance of the bucket.
  
  waived_off number
  
  Shows the amount of money that has been waived off from the bucket.
  
  summary object
  
  The Summary section includes useful aggregated metrics that describe the loan's performance at a given calculation date
  
  Additional properties are allowed.
  
  Hide summary attributes Show summary attributes object
  
  days_past_due_at_chargeoff null | integer
  
  The number of days that the loan was past due at the time of chargeoff.
  
  full_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide full_payment attributes Show full_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  immediate_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide immediate_payment attributes Show immediate_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  next_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide next_payment attributes Show next_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  number_of_covered_installments integer
  
  The number of installments that have been covered by the borrower.
  
  number_of_elapsed_due_dates integer
  
  The number of due dates that have elapsed since the start of the loan.
  
  simple_days_past_due integer
  
  It represents the number of days that a borrower's payment is late. It is calculated by subtracting the due date of the oldest overdue installment from the calculation date.
  
  total_imputed_payment number
  
  The amount of money in the form of payment that has been imputed to a certain loan.
  
  total_waived_off number
  
  The total amount of money that has been waived off from the borrower's loan.
  
  weighted_days_past_due integer
- payments array[object] | null
  
  Hide payments attributes Show payments attributes object
  
  amount_paid number
  
  Amount paid in the payment
  
  effective_date string(date-time)
  
  Effective date of the payment
  
  is_cancelled boolean
  
  Indicates if the payment was cancelled
  
  leftover number
  
  Amount left over after the payment has been allocated
  
  loan_allocation array[object] | null
  
  Allocation of the payment to different loans
  
  Hide loan_allocation attributes Show loan_allocation attributes object
  
  daily_fee object
  
  Payment applied to daily fee
  
  Additional properties are allowed.
  
  Hide daily_fee attributes Show daily_fee attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  current number
  
  Payment applied to current amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  delinquency_interest object
  
  Payment applied to delinquency interest
  
  Additional properties are allowed.
  
  Hide delinquency_interest attributes Show delinquency_interest attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  installment_fee object
  
  Payment applied to installment fee
  
  Additional properties are allowed.
  
  Hide installment_fee attributes Show installment_fee attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  current number
  
  Payment applied to current amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  unpaid number
  
  Payment applied to outstanding balance
  
  interest object
  
  Payment applied to daily fee
  
  Additional properties are allowed.
  
  Hide interest attributes Show interest attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  current number
  
  Payment applied to current amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  late_fee object
  
  Payment applied to delinquency interest
  
  Additional properties are allowed.
  
  Hide late_fee attributes Show late_fee attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  loan_id string
  
  Unique identifier for the loan
  
  principal object
  
  Payment applied to installment fee
  
  Additional properties are allowed.
  
  Hide principal attributes Show principal attributes object
  
  charged_off number
  
  Payment applied to charged off amount
  
  current number
  
  Payment applied to current amount
  
  overdue number
  
  Payment applied to overdue amount
  
  total number
  
  Payment applied to bucket
  
  unpaid number
  
  Payment applied to outstanding balance
  
  total number
  
  Total amount allocated to the loan
  
  payment_id string
  
  Unique identifier for the payment
  
  received_on string(date-time)
  
  Date when the payment was received
- request_id string
- summary object
  
  The Summary section includes useful aggregated metrics that describe the borrower's performance at a given calculation date
  
  Additional properties are allowed.
  
  Hide summary attributes Show summary attributes object
  
  borrower_full_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide borrower_full_payment attributes Show borrower_full_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  borrower_immediate_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide borrower_immediate_payment attributes Show borrower_immediate_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  borrower_next_payment object
  
  The full_payment field indicates the total amount required to pay off the loan in full, including any interest, fees, and principal that is outstanding as of the calculation date. Note that this amount is valid only for the specific calculation date and may change over time.
  
  Additional properties are allowed.
  
  Hide borrower_next_payment attributes Show borrower_next_payment attributes object
  
  amount number
  
  The amount of money that the borrower is required to pay.
  
  breakdown_by_bucket object
  
  The detail of the required payment amount by bucket.
  
  Additional properties are allowed.
  
  Hide breakdown_by_bucket attributes Show breakdown_by_bucket attributes object
  
  benefit number
  
  daily_fee number
  
  delinquency_interest number
  
  initial_fee number
  
  installment_fee number
  
  installment_fee_2 number
  
  interest number
  
  late_fee number
  
  principal number
  
  date string(date-time)
  
  The date when the borrower is required to pay.
  
  excess_reimbursement number
  
  The amount of money that the borrower was reimbursed exceeding the positive balance
  
  positive_balance number
  
  The total amount of money that the borrower has available to pay
400 application/json

Bad Request
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
404 application/json

Not Found
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
409 application/json

Conflict
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.

POST /v1/borrowers/{borrower_id}/simulate

curl \
 --request POST 'https://sandbox.lms.kordev.io/v1/borrowers/{borrower_id}/simulate' \
 --header "Content-Type: application/json" \
 --data '{"allocations":[{"payment_allocations":[{"amount":163333.34,"loan_id":"string"}],"payment_id":"string"}],"calculation_date":"2025-05-04T09:42:00Z","payments":[{"amount_paid":163333.34,"config_id":"default_payment_config","payment_date":"2020-01-01T00:00:00-05:00","payment_id":"string"}],"request_id":"string","restructurings":[{"amortization_method":null,"amount_financed":null,"config_id":"string","delinquency_interest_rate":null,"due_dates":[null],"effective_date":"2025-05-04T09:42:00Z","installment_fee":null,"interest_rate":null,"loan_id":"string","manual_pmts":{"additionalProperty1":42,"additionalProperty2":42}}],"waivers":[{"amount":163333.34,"bucket":"all","config_id":"DEFAULT_WAIVER_CONFIG","effective_date":"2020-01-01T00:00:00-05:00","loan_id":"string","percentage":0.2,"reason":"DEFAULT","type":"percentage"}]}'

Request examples

{
  "allocations": [
    {
      "payment_allocations": [
        {
          "amount": 163333.34,
          "loan_id": "string"
        }
      ],
      "payment_id": "string"
    }
  ],
  "calculation_date": "2025-05-04T09:42:00Z",
  "payments": [
    {
      "amount_paid": 163333.34,
      "config_id": "default_payment_config",
      "payment_date": "2020-01-01T00:00:00-05:00",
      "payment_id": "string"
    }
  ],
  "request_id": "string",
  "restructurings": [
    {
      "amortization_method": null,
      "amount_financed": null,
      "config_id": "string",
      "delinquency_interest_rate": null,
      "due_dates": [
        null
      ],
      "effective_date": "2025-05-04T09:42:00Z",
      "installment_fee": null,
      "interest_rate": null,
      "loan_id": "string",
      "manual_pmts": {
        "additionalProperty1": 42,
        "additionalProperty2": 42
      }
    }
  ],
  "waivers": [
    {
      "amount": 163333.34,
      "bucket": "all",
      "config_id": "DEFAULT_WAIVER_CONFIG",
      "effective_date": "2020-01-01T00:00:00-05:00",
      "loan_id": "string",
      "percentage": 0.2,
      "reason": "DEFAULT",
      "type": "percentage"
    }
  ]
}

Response examples (200)

{
  "borrower_id": "string",
  "calculation_date": "2025-05-04T09:42:00Z",
  "loans": [
    {
      "attributes": {
        "amount_financed": 300000,
        "chargeoff_date": "null",
        "config_id": "string",
        "due_dates": [
          "2024-02-02T23:59:59.999999-05:00, 2024-03-02T23:59:59.999999-05:00 2024-04-02T23:59:59.999999-05:00]"
        ],
        "fixed_installment_amount": 102354.51,
        "id": "106b07e9-3113-4068-a327-6e3b284f704d",
        "installment_amount_at_origination": 100000,
        "interest_rates": {
          "applicable": 42.0,
          "fixed": 42.0
        },
        "is_cancelled": false,
        "kordev_id": 3617888273932,
        "origination_date": "2024-01-02T23:59:59.999999-05:00",
        "owner": "BANK_1",
        "paid_off_date": "2024-04-02T23:59:59.999999-05:00"
      },
      "balance_detail": {
        "at_calculation_date": {
          "daily_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "delinquency_interest": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "initial_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "installment_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "installment_fee_2": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "interest": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "late_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "principal": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          }
        },
        "at_next_due_date": {
          "daily_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "delinquency_interest": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "initial_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "installment_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "installment_fee_2": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "interest": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "late_fee": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          },
          "principal": {
            "charged_off": 42.0,
            "current": 42.0,
            "initial_balance": 42.0,
            "overdue": 42.0,
            "paid": 42.0,
            "unpaid": 42.0,
            "waived_off": 42.0
          }
        }
      },
      "summary": {
        "days_past_due_at_chargeoff": 0,
        "full_payment": {
          "amount": 42.0,
          "breakdown_by_bucket": {
            "benefit": 42.0,
            "daily_fee": 42.0,
            "delinquency_interest": 42.0,
            "initial_fee": 42.0,
            "installment_fee": 42.0,
            "installment_fee_2": 42.0,
            "interest": 42.0,
            "late_fee": 42.0,
            "principal": 42.0
          },
          "date": "2025-05-04T09:42:00Z"
        },
        "immediate_payment": {
          "amount": 42.0,
          "breakdown_by_bucket": {
            "benefit": 42.0,
            "daily_fee": 42.0,
            "delinquency_interest": 42.0,
            "initial_fee": 42.0,
            "installment_fee": 42.0,
            "installment_fee_2": 42.0,
            "interest": 42.0,
            "late_fee": 42.0,
            "principal": 42.0
          },
          "date": "2025-05-04T09:42:00Z"
        },
        "next_payment": {
          "amount": 42.0,
          "breakdown_by_bucket": {
            "benefit": 42.0,
            "daily_fee": 42.0,
            "delinquency_interest": 42.0,
            "initial_fee": 42.0,
            "installment_fee": 42.0,
            "installment_fee_2": 42.0,
            "interest": 42.0,
            "late_fee": 42.0,
            "principal": 42.0
          },
          "date": "2025-05-04T09:42:00Z"
        },
        "number_of_covered_installments": 1,
        "number_of_elapsed_due_dates": 1,
        "simple_days_past_due": 0,
        "total_imputed_payment": 200000.5,
        "total_waived_off": 10000.31,
        "weighted_days_past_due": 0
      }
    }
  ],
  "payments": [
    {
      "amount_paid": 100.5,
      "effective_date": "2022-01-02T00:00:00Z",
      "is_cancelled": false,
      "leftover": 0,
      "loan_allocation": [
        {
          "daily_fee": {
            "charged_off": 200,
            "current": 150,
            "overdue": 50,
            "total": 250
          },
          "delinquency_interest": {
            "charged_off": 200,
            "overdue": 50,
            "total": 250
          },
          "installment_fee": {
            "charged_off": 200,
            "current": 150,
            "overdue": 50,
            "total": 250,
            "unpaid": 100
          },
          "interest": {
            "charged_off": 200,
            "current": 150,
            "overdue": 50,
            "total": 250
          },
          "late_fee": {
            "charged_off": 200,
            "overdue": 50,
            "total": 250
          },
          "loan_id": "8adbca06-1d13-49b6-a391-d02d106047b3",
          "principal": {
            "charged_off": 200,
            "current": 150,
            "overdue": 50,
            "total": 250,
            "unpaid": 100
          },
          "total": 102100.5
        }
      ],
      "payment_id": "47bc57c4-4ef8-4978-8819-ca9516cb5a46",
      "received_on": "2022-01-03T05:32:00Z"
    }
  ],
  "request_id": "string",
  "summary": {
    "borrower_full_payment": {
      "amount": 42.0,
      "breakdown_by_bucket": {
        "benefit": 42.0,
        "daily_fee": 42.0,
        "delinquency_interest": 42.0,
        "initial_fee": 42.0,
        "installment_fee": 42.0,
        "installment_fee_2": 42.0,
        "interest": 42.0,
        "late_fee": 42.0,
        "principal": 42.0
      },
      "date": "2025-05-04T09:42:00Z"
    },
    "borrower_immediate_payment": {
      "amount": 42.0,
      "breakdown_by_bucket": {
        "benefit": 42.0,
        "daily_fee": 42.0,
        "delinquency_interest": 42.0,
        "initial_fee": 42.0,
        "installment_fee": 42.0,
        "installment_fee_2": 42.0,
        "interest": 42.0,
        "late_fee": 42.0,
        "principal": 42.0
      },
      "date": "2025-05-04T09:42:00Z"
    },
    "borrower_next_payment": {
      "amount": 42.0,
      "breakdown_by_bucket": {
        "benefit": 42.0,
        "daily_fee": 42.0,
        "delinquency_interest": 42.0,
        "initial_fee": 42.0,
        "installment_fee": 42.0,
        "installment_fee_2": 42.0,
        "interest": 42.0,
        "late_fee": 42.0,
        "principal": 42.0
      },
      "date": "2025-05-04T09:42:00Z"
    },
    "excess_reimbursement": 1000,
    "positive_balance": 1000
  }
}

Response examples (400)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (404)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (409)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (500)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}