Create Waiver

POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create

Create a new waiver for a borrower

Path parameters

borrower_id string Required
waiver_id string Required
loan_id string Required

Query parameters

is_migration boolean

When this parameter is set to True, the transaction will be handled as if it had occurred on the date specified in the occurred_on field, rather than the current date and time. This is useful when migrating data from a legacy system or for building test cases.

Default value is false.

application/json

Body

occurred_on string(date-time)

Represents the date and time at which the lender reported the transaction. This field is expressed as a datetime object with timezone information and is provided for reference purposes only. Please note that the 'occurred on' date is not used in loan management operations and does not affect the processing or status of the transaction. It is provided solely to track when the lender believes the transaction occurred, regardless of when it was actually processed by the loan management system. However if the request comes with the is_migration parameter set to true the occurred_on field will be used to handle the request as if it had happened on that date.
request_id string
waiver object

Additional properties are allowed.
Hide waiver attributes Show waiver 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.
- 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
- 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.
- id string
  
  Identifier for the recently created waiver. It's the same id provided in the request.'
- kordev_id integer
  
  Identifier for the waiver used internally by Kordev. The ID is unique for each borrower but not globally unique.
- loan_id string
  
  Identifier for the loan used by the lender.
- percentage null | number
  
  The % to be waived.
  
  Minimum value is 0, maximum value is 1.
- reason null | string
  
  The reason for the waiver.
- request_id string
  
  Optional field that will be returned unmodified in each response. Especially useful for keeping track of responses in batch requests.
- type string
  
  The type of waiver to be applied. The two options are percentage and amount.
  
  Values are percentage or amount.
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}/loans/{loan_id}/waivers/{waiver_id}/create

curl \
 --request POST 'https://sandbox.lms.kordev.io/v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create' \
 --header "Content-Type: application/json" \
 --data '{"occurred_on":"2020-01-01T10:15:20-05:00","request_id":"string","waiver":{"amount":163333.34,"bucket":"all","config_id":"DEFAULT_WAIVER_CONFIG","effective_date":"2020-01-01T00:00:00-05:00","percentage":0.2,"reason":"DEFAULT","type":"percentage"}}'

Request examples

{
  "occurred_on": "2020-01-01T10:15:20-05:00",
  "request_id": "string",
  "waiver": {
    "amount": 163333.34,
    "bucket": "all",
    "config_id": "DEFAULT_WAIVER_CONFIG",
    "effective_date": "2020-01-01T00:00:00-05:00",
    "percentage": 0.2,
    "reason": "DEFAULT",
    "type": "percentage"
  }
}

Response examples (200)

{
  "amount": 163333.34,
  "bucket": "all",
  "config_id": "DEFAULT_WAIVER_CONFIG",
  "effective_date": "2020-01-01T00:00:00-05:00",
  "id": "string",
  "kordev_id": 42,
  "loan_id": "string",
  "percentage": 0.2,
  "reason": "DEFAULT",
  "request_id": "string",
  "type": "percentage"
}

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"
}