Cancel Customer 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"
}
'

import requests

url = "https://api.example.com/customers/{id}/cancel-servicing"

payload = { "reason": "PAID_OFF" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'PAID_OFF'})
};

fetch('https://api.example.com/customers/{id}/cancel-servicing', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/customers/{id}/cancel-servicing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'PAID_OFF'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/customers/{id}/cancel-servicing"

	payload := strings.NewReader("{\n  \"reason\": \"PAID_OFF\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/customers/{id}/cancel-servicing")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"PAID_OFF\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/{id}/cancel-servicing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"PAID_OFF\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "loansUpdated": 3,
  "stopServicingReason": "PAID_OFF",
  "cancelledScheduledPayments": 9,
  "cancelledCallSchedules": 3,
  "cancelledEmailSchedules": 3,
  "cancelledSmsSchedules": 3,
  "cancelledCalls": 15,
  "cancelledEmails": 6,
  "cancelledSms": 9
}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

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

import requests

url = "https://api.example.com/customers/{id}/cancel-servicing"

payload = { "reason": "PAID_OFF" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'PAID_OFF'})
};

fetch('https://api.example.com/customers/{id}/cancel-servicing', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/customers/{id}/cancel-servicing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'PAID_OFF'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/customers/{id}/cancel-servicing"

	payload := strings.NewReader("{\n  \"reason\": \"PAID_OFF\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/customers/{id}/cancel-servicing")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"PAID_OFF\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/{id}/cancel-servicing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"PAID_OFF\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "loansUpdated": 3,
  "stopServicingReason": "PAID_OFF",
  "cancelledScheduledPayments": 9,
  "cancelledCallSchedules": 3,
  "cancelledEmailSchedules": 3,
  "cancelledSmsSchedules": 3,
  "cancelledCalls": 15,
  "cancelledEmails": 6,
  "cancelledSms": 9
}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

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:

Reason	Description
`API_REQUEST`	Default reason when cancelled via API
`PAID_OFF`	Loans have been paid in full
`BANKRUPTCY`	Customer filed for bankruptcy
`FRAUD_CLAIM`	Fraud detected on the account
`MILITARY`	Customer is protected under SCRA
`DECEASED`	Customer is deceased
`INCARCERATED`	Customer is incarcerated
`DEBT_MANAGEMENT_COMPANY`	Account transferred to debt management
`SOLD_OFF`	Loans sold to another servicer
`MISTAKE`	Customer was created in error
`NO_VALID_COMMUNICATION_CHANNEL`	No valid way to contact customer
`DEBT_DISPUTE`	Customer is disputing the debt
`COMPLAINT_TRIGGER`	Triggered by customer complaint
`DUPLICATE`	Duplicate customer record
`REFUSES_TO_PAY`	Customer refuses to pay
`LMS_CLOSED`	Loan 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 Code	Description
400	Invalid reason provided
404	Customer not found
500	Internal server error

Authorizations

X-API-Key

string

header

required

Path Parameters

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

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

Cancel Communications Create Scheduled Calls

API Documentation

Endpoint Examples

Cancel Customer Servicing

Overview

What Gets Cancelled

Use Cases

Stop Servicing Reasons

Request Body

Response

Error Responses

Authorizations

Path Parameters

Body

Response

​Overview

​What Gets Cancelled

​Use Cases

​Stop Servicing Reasons

​Request Body

​Response

​Error Responses

Authorizations

Path Parameters

Body

Response

Overview

What Gets Cancelled

Use Cases

Stop Servicing Reasons

Request Body

Response

Error Responses