Cancel Loan

POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel

Cancel a loan for a borrower, if the loan is not found it will return an error

Path parameters

borrower_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

loan_cancellation object

Additional properties are allowed.
Hide loan_cancellation attributes Show loan_cancellation attributes object
- id null | string
- reason null | string
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

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- effective_date string(date-time)
- id null | string
  
  Unique identifier for the loan cancellation event.
- kordev_id integer
  
  Identifier for the loan 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.
- request_id string
  
  Optional field that will be returned unmodified in each response. Especially useful for keeping track of responses in batch requests.
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}/cancel

curl \
 --request POST 'https://lms.kordev.io/v1/borrowers/{borrower_id}/loans/{loan_id}/cancel' \
 --header "Content-Type: application/json" \
 --data '{"loan_cancellation":{"id":null,"reason":null},"occurred_on":"2020-01-01T10:15:20-05:00","request_id":"string"}'

Request examples

{
  "loan_cancellation": {
    "id": null,
    "reason": null
  },
  "occurred_on": "2020-01-01T10:15:20-05:00",
  "request_id": "string"
}

Response examples (200)

{
  "effective_date": "2020-01-01T00:00:00-05:00",
  "id": null,
  "kordev_id": 42,
  "loan_id": "string",
  "request_id": "string"
}

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