cURL
curl --request PUT \
--url https://api.example.com/loans/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"dueDate": "2023-12-25",
"stopServicingReason": "<string>",
"isSettled": true,
"chargeoffDate": "2023-12-25",
"chargeoffAmount": 123,
"autopayEnabled": true,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": true,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {}
}
'import requests
url = "https://api.example.com/loans/{id}"
payload = {
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"dueDate": "2023-12-25",
"stopServicingReason": "<string>",
"isSettled": True,
"chargeoffDate": "2023-12-25",
"chargeoffAmount": 123,
"autopayEnabled": True,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": True,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
originalFundedAmount: 123,
originalTotalOwed: 123,
interestRate: 123,
apr: 123,
originationDate: '2023-12-25',
startDate: '2023-12-25',
totalBalance: 123,
payoffAmount: 123,
totalPayoffAmount: 123,
balanceAtTransfer: 123,
preTransferPayments: 123,
dueDate: '2023-12-25',
stopServicingReason: '<string>',
isSettled: true,
chargeoffDate: '2023-12-25',
chargeoffAmount: 123,
autopayEnabled: true,
noCallReason: '<string>',
noTextReason: '<string>',
noEmailReason: '<string>',
isVisibleInBorrowerPortal: true,
daysPastDueAtBoarding: 123,
daysSinceOriginationAtBoarding: 123,
externalLmsMetadata: {}
})
};
fetch('https://api.example.com/loans/{id}', 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/loans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'originalFundedAmount' => 123,
'originalTotalOwed' => 123,
'interestRate' => 123,
'apr' => 123,
'originationDate' => '2023-12-25',
'startDate' => '2023-12-25',
'totalBalance' => 123,
'payoffAmount' => 123,
'totalPayoffAmount' => 123,
'balanceAtTransfer' => 123,
'preTransferPayments' => 123,
'dueDate' => '2023-12-25',
'stopServicingReason' => '<string>',
'isSettled' => true,
'chargeoffDate' => '2023-12-25',
'chargeoffAmount' => 123,
'autopayEnabled' => true,
'noCallReason' => '<string>',
'noTextReason' => '<string>',
'noEmailReason' => '<string>',
'isVisibleInBorrowerPortal' => true,
'daysPastDueAtBoarding' => 123,
'daysSinceOriginationAtBoarding' => 123,
'externalLmsMetadata' => [
]
]),
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/loans/{id}"
payload := strings.NewReader("{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/loans/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/loans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"type": "<string>",
"applicationStatus": "<string>",
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"amountDue": 123,
"dueDate": "<string>",
"servicingStatus": "<string>",
"stopServicingReason": "<string>",
"isSettled": true,
"chargeoffDate": "<string>",
"chargeoffAmount": 123,
"autopayEnabled": true,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": true,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {},
"portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentPlanMinPercentage": 123,
"paymentPlanMaxPercentage": 123,
"taskType": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Loans
Update Loan
Partially update a loan by its external reference. Only send fields that changed. amountDue is immutable.
PUT
/
loans
/
{id}
cURL
curl --request PUT \
--url https://api.example.com/loans/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"dueDate": "2023-12-25",
"stopServicingReason": "<string>",
"isSettled": true,
"chargeoffDate": "2023-12-25",
"chargeoffAmount": 123,
"autopayEnabled": true,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": true,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {}
}
'import requests
url = "https://api.example.com/loans/{id}"
payload = {
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"dueDate": "2023-12-25",
"stopServicingReason": "<string>",
"isSettled": True,
"chargeoffDate": "2023-12-25",
"chargeoffAmount": 123,
"autopayEnabled": True,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": True,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
originalFundedAmount: 123,
originalTotalOwed: 123,
interestRate: 123,
apr: 123,
originationDate: '2023-12-25',
startDate: '2023-12-25',
totalBalance: 123,
payoffAmount: 123,
totalPayoffAmount: 123,
balanceAtTransfer: 123,
preTransferPayments: 123,
dueDate: '2023-12-25',
stopServicingReason: '<string>',
isSettled: true,
chargeoffDate: '2023-12-25',
chargeoffAmount: 123,
autopayEnabled: true,
noCallReason: '<string>',
noTextReason: '<string>',
noEmailReason: '<string>',
isVisibleInBorrowerPortal: true,
daysPastDueAtBoarding: 123,
daysSinceOriginationAtBoarding: 123,
externalLmsMetadata: {}
})
};
fetch('https://api.example.com/loans/{id}', 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/loans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'originalFundedAmount' => 123,
'originalTotalOwed' => 123,
'interestRate' => 123,
'apr' => 123,
'originationDate' => '2023-12-25',
'startDate' => '2023-12-25',
'totalBalance' => 123,
'payoffAmount' => 123,
'totalPayoffAmount' => 123,
'balanceAtTransfer' => 123,
'preTransferPayments' => 123,
'dueDate' => '2023-12-25',
'stopServicingReason' => '<string>',
'isSettled' => true,
'chargeoffDate' => '2023-12-25',
'chargeoffAmount' => 123,
'autopayEnabled' => true,
'noCallReason' => '<string>',
'noTextReason' => '<string>',
'noEmailReason' => '<string>',
'isVisibleInBorrowerPortal' => true,
'daysPastDueAtBoarding' => 123,
'daysSinceOriginationAtBoarding' => 123,
'externalLmsMetadata' => [
]
]),
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/loans/{id}"
payload := strings.NewReader("{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/loans/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/loans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"originalFundedAmount\": 123,\n \"originalTotalOwed\": 123,\n \"interestRate\": 123,\n \"apr\": 123,\n \"originationDate\": \"2023-12-25\",\n \"startDate\": \"2023-12-25\",\n \"totalBalance\": 123,\n \"payoffAmount\": 123,\n \"totalPayoffAmount\": 123,\n \"balanceAtTransfer\": 123,\n \"preTransferPayments\": 123,\n \"dueDate\": \"2023-12-25\",\n \"stopServicingReason\": \"<string>\",\n \"isSettled\": true,\n \"chargeoffDate\": \"2023-12-25\",\n \"chargeoffAmount\": 123,\n \"autopayEnabled\": true,\n \"noCallReason\": \"<string>\",\n \"noTextReason\": \"<string>\",\n \"noEmailReason\": \"<string>\",\n \"isVisibleInBorrowerPortal\": true,\n \"daysPastDueAtBoarding\": 123,\n \"daysSinceOriginationAtBoarding\": 123,\n \"externalLmsMetadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"type": "<string>",
"applicationStatus": "<string>",
"originalFundedAmount": 123,
"originalTotalOwed": 123,
"interestRate": 123,
"apr": 123,
"originationDate": "2023-12-25",
"startDate": "2023-12-25",
"totalBalance": 123,
"payoffAmount": 123,
"totalPayoffAmount": 123,
"balanceAtTransfer": 123,
"preTransferPayments": 123,
"amountDue": 123,
"dueDate": "<string>",
"servicingStatus": "<string>",
"stopServicingReason": "<string>",
"isSettled": true,
"chargeoffDate": "<string>",
"chargeoffAmount": 123,
"autopayEnabled": true,
"noCallReason": "<string>",
"noTextReason": "<string>",
"noEmailReason": "<string>",
"isVisibleInBorrowerPortal": true,
"daysPastDueAtBoarding": 123,
"daysSinceOriginationAtBoarding": 123,
"externalLmsMetadata": {},
"portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentPlanMinPercentage": 123,
"paymentPlanMaxPercentage": 123,
"taskType": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Overview
Partially update a loan by its external reference ID. Only the fields that changed need to be sent — omitted fields are left unchanged.Immutable Fields
The following fields cannot be changed via this endpoint:id— The external loan reference (used as the path parameter)customerId— The customer linkageamountDue— The origination amount set at creation
Servicing Status Transitions
SettingservicingStatus to NOT_SERVICING via this endpoint also cancels all scheduled payments and communications for the loan, matching the behavior of POST /loans/{id}/cancel-servicing. You can optionally include stopServicingReason (defaults to API_REQUEST).
For stopping servicing specifically, the dedicated POST /loans/{id}/cancel-servicing endpoint remains the primary path.
Request Body
Only send the fields you want to update:{
"totalBalance": 300.00,
"payoffAmount": 300.00,
"isSettled": false
}
{
"servicingStatus": "NOT_SERVICING",
"stopServicingReason": "PAID_OFF"
}
Error Responses
| Status Code | Description |
|---|---|
| 400 | Invalid enum value |
| 404 | Loan not found |
| 500 | Internal server error |
Authorizations
Path Parameters
External reference ID of the loan
Body
application/json
Fields to update
Partial update. Only send fields that changed. id, customerId, amountDue cannot be changed.
Available options:
CASH_ADVANCE, PERSONAL_LOAN, INSTALLMENT_LOAN Available options:
PENDING, APPROVED, FUNDED, WITHDRAWN, REJECTED Available options:
ACTIVE, NOT_SERVICING Response
Loan updated
External loan reference ID
External customer reference ID
⌘I