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

​
Overview

This endpoint cancels servicing for all loans belonging to a specific customer, stopping all automated communications and scheduled payments across all of their loans. Use this when a customer should no longer be actively serviced by the platform.

​
What Gets Cancelled

When you call this endpoint, the following actions are taken for all loans owned by the customer:
  • Loan Status: Sets all loans’ servicing status to NOT_SERVICING
  • Stop Reason: Records the reason for stopping servicing (defaults to API_REQUEST)
  • Scheduled Payments: Cancels all pending scheduled payments
  • 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 all their loans
  • Customer is leaving the platform entirely
  • Customer filed for bankruptcy
  • Fraud has been detected across the customer’s accounts
  • Customer is deceased
  • Customer requested to be removed from all 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_OFFLoans have 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
SOLD_OFFLoans sold to another servicer
MISTAKECustomer was created in error
NO_VALID_COMMUNICATION_CHANNELNo valid way to contact customer
DEBT_DISPUTECustomer is disputing the debt
COMPLAINT_TRIGGERTriggered by customer complaint
DUPLICATEDuplicate customer 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 the total count of all cancelled items across all loans: 
{
  "id": "CUST-12345",
  "loansUpdated": 3,
  "stopServicingReason": "PAID_OFF",
  "cancelledScheduledPayments": 9,
  "cancelledCallSchedules": 3,
  "cancelledEmailSchedules": 3,
  "cancelledSmsSchedules": 3,
  "cancelledCalls": 15,
  "cancelledEmails": 6,
  "cancelledSms": 9
}

​
Error Responses

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

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

External reference ID of the customer

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

Customer servicing cancelled successfully

​
id
string
required

Customer ID (reference_id)

​
loansUpdated
integer
required

Number of loans set to NOT_SERVICING

Example:

3

​
stopServicingReason
string
required

Reason for stopping servicing

Example:

"PAID_OFF"

​
cancelledScheduledPayments
integer
required

Total scheduled payments cancelled across all loans

Example:

9

​
cancelledCallSchedules
integer
required

Total call schedules cancelled

Example:

3

​
cancelledEmailSchedules
integer
required

Total email schedules cancelled

Example:

3

​
cancelledSmsSchedules
integer
required

Total SMS schedules cancelled

Example:

3

​
cancelledCalls
integer
required

Total scheduled calls cancelled

Example:

15

​
cancelledEmails
integer
required

Total scheduled emails cancelled

Example:

6

​
cancelledSms
integer
required

Total scheduled SMS cancelled

Example:

9