Create Reimbursement

POST /v1/borrowers/{borrower_id}/reimbursements/{reimbursement_id}/create

Create a positive balance reimbursement for the borrower

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.

  • reimbursement object

    Additional properties are allowed.

    Hide reimbursement attributes Show reimbursement attributes object
    • effective_date string(date-time)

      The date on which the reimbursement is applied.

    • value number

      The amount of the reimbursement.

  • request_id string

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
  • 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}/reimbursements/{reimbursement_id}/create 
curl \
 --request POST 'https://sandbox.lms.kordev.io/v1/borrowers/{borrower_id}/reimbursements/{reimbursement_id}/create' \
 --header "Content-Type: application/json" \
 --data '{"occurred_on":"2020-01-01T10:15:20-05:00","reimbursement":{"effective_date":"2025-05-04T09:42:00Z","value":42.0},"request_id":"string"}'
Request examples 
{
  "occurred_on": "2020-01-01T10:15:20-05:00",
  "reimbursement": {
    "effective_date": "2025-05-04T09:42:00Z",
    "value": 42.0
  },
  "request_id": "string"
}
Response examples (200) 
{
  "id": "string",
  "kordev_id": 42,
  "reimbursement": {
    "effective_date": "2025-05-04T09:42:00Z",
    "value": 42.0
  },
  "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"
}