Skip to main content
DELETE
/
loans
/
{id}
cURL
curl --request DELETE \
  --url https://api.example.com/loans/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "deleted": true,
  "servicingStatus": "NOT_SERVICING",
  "cancelledScheduledPayments": 2,
  "cancelledCalls": 3,
  "cancelledEmails": 1,
  "cancelledSms": 1
}

​
Overview

Soft-delete a loan by its external reference ID. This endpoint:
  • Sets the loan’s servicing status to NOT_SERVICING
  • Cancels all scheduled payments for the loan
  • Cancels all scheduled communications (calls, emails, SMS)
  • Marks the loan as deleted (soft-delete)
The loan record is preserved in the database for audit purposes but will no longer appear in normal queries or be actively serviced.

​
Response

The response includes counts of all cancelled items: 
{
  "id": "LOAN-12345",
  "deleted": true,
  "servicingStatus": "NOT_SERVICING",
  "cancelledScheduledPayments": 2,
  "cancelledCalls": 3,
  "cancelledEmails": 1,
  "cancelledSms": 1
}

​
Error Responses

Status CodeDescription
404Loan not found
500Internal server error

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

External reference ID of the loan

Response

Loan deleted

​
id
string
required
​
deleted
boolean
required
Example:

true

​
servicingStatus
string
required
Example:

"NOT_SERVICING"

​
cancelledScheduledPayments
integer
required
Example:

2

​
cancelledCalls
integer
required
Example:

3

​
cancelledEmails
integer
required
Example:

1

​
cancelledSms
integer
required
Example:

1