Skip to main content
POST
/
loans
/
{id}
/
cancel-servicing
cURL
curl --request POST \
  --url https://api.example.com/loans/{id}/cancel-servicing \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "PAID_OFF"
}
'
{
  "id": "<string>",
  "servicingStatus": "NOT_SERVICING",
  "stopServicingReason": "PAID_OFF",
  "cancelledScheduledPayments": 3,
  "cancelledCallSchedules": 1,
  "cancelledEmailSchedules": 1,
  "cancelledSmsSchedules": 1,
  "cancelledCalls": 5,
  "cancelledEmails": 2,
  "cancelledSms": 3
}

​
Overview

This endpoint cancels servicing for a specific loan, stopping all automated communications and scheduled payments. Use this when a loan should no longer be actively serviced by the platform.

​
What Gets Cancelled

When you call this endpoint, the following actions are taken:
  • Loan Status: Sets the loan’s servicing status to NOT_SERVICING
  • Stop Reason: Records the reason for stopping servicing (defaults to API_REQUEST)
  • Scheduled Payments: Cancels all pending scheduled payments for the loan
  • Scheduled Calls: Cancels all pending scheduled calls
  • Scheduled Emails: Cancels all pending scheduled emails
  • Scheduled SMS: Cancels all pending scheduled SMS messages
  • Call Schedules: Cancels all active loan call schedules
  • Email Schedules: Cancels all active loan email schedules
  • SMS Schedules: Cancels all active loan SMS schedules

​
Use Cases

  • Customer has paid off their loan in full
  • Loan has been sold to another servicer
  • Customer filed for bankruptcy
  • Fraud has been detected on the account
  • Customer is deceased
  • Customer is in the military (SCRA protection)
  • Loan was created by mistake and needs to be removed from servicing

​
Stop Servicing Reasons

You can optionally provide a reason for stopping servicing. Valid values are:
ReasonDescription
API_REQUESTDefault reason when cancelled via API
PAID_OFFLoan has been paid in full
BANKRUPTCYCustomer filed for bankruptcy
FRAUD_CLAIMFraud detected on the account
MILITARYCustomer is protected under SCRA
DECEASEDCustomer is deceased
INCARCERATEDCustomer is incarcerated
DEBT_MANAGEMENT_COMPANYAccount transferred to debt management
NO_LOGIN_2MNo customer login for 2 months
NO_PAYMENT_OR_PLAN_3MNo payment or plan for 3 months
NO_PLAN_PAYMENT_2MNo plan payment for 2 months
NO_PAYMENT_OR_PLAN_4MNo payment or plan for 4 months
SOLD_OFFLoan sold to another servicer
MISTAKELoan was created in error
NO_VALID_COMMUNICATION_CHANNELNo valid way to contact customer
DEBT_DISPUTECustomer is disputing the debt
COMPLAINT_TRIGGERTriggered by customer complaint
HISTORICAL_INELIGIBLEHistorically ineligible for servicing
DUPLICATEDuplicate loan record
REFUSES_TO_PAYCustomer refuses to pay
LMS_CLOSEDLoan closed from external LMS sync

​
Request Body

The request body is optional. If not provided, the reason defaults to API_REQUEST. 
{
  "reason": "PAID_OFF"
}

​
Response

The response includes counts of all cancelled items: 
{
  "id": "LOAN-12345",
  "servicingStatus": "NOT_SERVICING",
  "stopServicingReason": "PAID_OFF",
  "cancelledScheduledPayments": 3,
  "cancelledCallSchedules": 1,
  "cancelledEmailSchedules": 1,
  "cancelledSmsSchedules": 1,
  "cancelledCalls": 5,
  "cancelledEmails": 2,
  "cancelledSms": 3
}

​
Error Responses

Status CodeDescription
400Invalid reason provided
404Loan not found
500Internal server error

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

External reference ID of the loan to cancel servicing for

Body

application/json

Optional reason for stopping servicing. Defaults to API_REQUEST if not specified.

​
reason
enum<string>

Reason for stopping servicing. Defaults to API_REQUEST if not specified.

Available options:
PAID_OFF,
BANKRUPTCY,
FRAUD_CLAIM,
MILITARY,
DECEASED,
INCARCERATED,
DEBT_MANAGEMENT_COMPANY,
NO_LOGIN_2M,
NO_PAYMENT_OR_PLAN_3M,
NO_PLAN_PAYMENT_2M,
NO_PAYMENT_OR_PLAN_4M,
SOLD_OFF,
MISTAKE,
NO_VALID_COMMUNICATION_CHANNEL,
DEBT_DISPUTE,
COMPLAINT_TRIGGER,
HISTORICAL_INELIGIBLE,
DUPLICATE,
REFUSES_TO_PAY,
LMS_CLOSED,
API_REQUEST
Example:

"PAID_OFF"

Response

Loan servicing cancelled successfully

​
id
string
required

Loan external reference ID

​
servicingStatus
string
required

New servicing status (NOT_SERVICING)

Example:

"NOT_SERVICING"

​
stopServicingReason
string
required

Reason for stopping servicing

Example:

"PAID_OFF"

​
cancelledScheduledPayments
integer
required

Number of scheduled payments cancelled

Example:

3

​
cancelledCallSchedules
integer
required

Number of call schedules cancelled

Example:

1

​
cancelledEmailSchedules
integer
required

Number of email schedules cancelled

Example:

1

​
cancelledSmsSchedules
integer
required

Number of SMS schedules cancelled

Example:

1

​
cancelledCalls
integer
required

Number of scheduled calls cancelled

Example:

5

​
cancelledEmails
integer
required

Number of scheduled emails cancelled

Example:

2

​
cancelledSms
integer
required

Number of scheduled SMS cancelled

Example:

3