curl --request PATCH \
--url https://staging.debt-wise.com/api/users/{id}/accounts/{account_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "Chase credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"user_next_payment_date": "2038-03-04"
}
'import requests
url = "https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}"
payload = {
"nickname": "Chase credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"user_next_payment_date": "2038-03-04"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nickname: 'Chase credit card',
user_apr: 5.5,
user_minimum_payment: 10000,
user_next_payment_date: '2038-03-04'
})
};
fetch('https://staging.debt-wise.com/api/users/{id}/accounts/{account_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://staging.debt-wise.com/api/users/{id}/accounts/{account_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'nickname' => 'Chase credit card',
'user_apr' => 5.5,
'user_minimum_payment' => 10000,
'user_next_payment_date' => '2038-03-04'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://staging.debt-wise.com/api/users/{id}/accounts/{account_id}"
payload := strings.NewReader("{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "JCP Morgan",
"type": "loan",
"subtype": "credit_card_loan",
"mask": "1234",
"status": "active",
"nickname": "Primary credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"effective_minimum_payment": 15000,
"effective_apr": 6.3,
"original_loan_amount": 15000000,
"balance": 150000,
"limit": 0,
"last_payment_amount": 20000,
"last_updated_at": "2024-06-01",
"last_payment_date": "2024-05-25",
"opened_at": "2024-05-25",
"closed_at": "2024-05-25",
"institution_name": "Chase",
"institution_logo": "<string>",
"next_payment_due_date": "2024-06-25",
"user_next_payment_date": "2024-06-25",
"first_time_payment": false,
"expected_payoff_date": "2052-01-01",
"payments_history": [
"0"
]
}{
"error": {
"code": "internal_server_error",
"message": "We've notified our engineers and hope to address this issue shortly."
}
}Update Account
Update information about a single account
curl --request PATCH \
--url https://staging.debt-wise.com/api/users/{id}/accounts/{account_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "Chase credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"user_next_payment_date": "2038-03-04"
}
'import requests
url = "https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}"
payload = {
"nickname": "Chase credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"user_next_payment_date": "2038-03-04"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nickname: 'Chase credit card',
user_apr: 5.5,
user_minimum_payment: 10000,
user_next_payment_date: '2038-03-04'
})
};
fetch('https://staging.debt-wise.com/api/users/{id}/accounts/{account_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://staging.debt-wise.com/api/users/{id}/accounts/{account_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'nickname' => 'Chase credit card',
'user_apr' => 5.5,
'user_minimum_payment' => 10000,
'user_next_payment_date' => '2038-03-04'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://staging.debt-wise.com/api/users/{id}/accounts/{account_id}"
payload := strings.NewReader("{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.debt-wise.com/api/users/{id}/accounts/{account_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"Chase credit card\",\n \"user_apr\": 5.5,\n \"user_minimum_payment\": 10000,\n \"user_next_payment_date\": \"2038-03-04\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "JCP Morgan",
"type": "loan",
"subtype": "credit_card_loan",
"mask": "1234",
"status": "active",
"nickname": "Primary credit card",
"user_apr": 5.5,
"user_minimum_payment": 10000,
"effective_minimum_payment": 15000,
"effective_apr": 6.3,
"original_loan_amount": 15000000,
"balance": 150000,
"limit": 0,
"last_payment_amount": 20000,
"last_updated_at": "2024-06-01",
"last_payment_date": "2024-05-25",
"opened_at": "2024-05-25",
"closed_at": "2024-05-25",
"institution_name": "Chase",
"institution_logo": "<string>",
"next_payment_due_date": "2024-06-25",
"user_next_payment_date": "2024-06-25",
"first_time_payment": false,
"expected_payoff_date": "2052-01-01",
"payments_history": [
"0"
]
}{
"error": {
"code": "internal_server_error",
"message": "We've notified our engineers and hope to address this issue shortly."
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
We can compress a response with gzip.
"gzip deflate"
API API Version. See Versioning page for more details.
"2024-07-01"
Path Parameters
An userId.
1
An accountId.
1
Body
User's nickname for the account
"Chase credit card"
User's apr for account. Could be provide if APR from provider invalid or missing.
5.5
User's minimum payment for account in cents. Could be provide if effective minimum payment from provider invalid or missing.
10000
User's next payment date for account. Could be provide if next payment date from provider invalid or missing.
"2038-03-04"
Response
Returns updated information about an account
Account ID
1
Account's name
"JCP Morgan"
Account's type
depository, loan, investment, other "loan"
Account's sub type, which indicates which the account type
student_loan, credit_card_loan, auto_loan, personal_loan, mortgage_loan, medical_loan, other_loan, checking, savings "credit_card_loan"
Account's mask, or the last 4 digits of the account number
4"1234"
Account's status
active, disabled, closed "active"
User's nickname for account
"Primary credit card"
User's APR for account
5.5
User's minimum payment for account in cents
10000
Account minimum payment in cents
15000
Account's APR
6.3
Original loan amount in cents
15000000
Balance of account in cents
150000
Maximum limit of account in cents
0
Last payment amount for the loan in cents
20000
Last data sync for account date
"2024-06-01"
Last payment date
"2024-05-25"
Date when account was opened
"2024-05-25"
Date when account was closed
"2024-05-25"
Account's Institution name
"Chase"
Base 64 encoded image
Next payment date
"2024-06-25"
User's custom next payment date
"2024-06-25"
Indicates if next payment will be the first
false
Indicates account's close date if minimum payment will be paid off
"2052-01-01"
24 months payment history, where each string represents monthly payment status: "0" = The account is too new to rate, or has been approved, but not yet used; "1" = Payments have been made on-time; "2" = Two or fewer payments are past due; "3" = Three or fewer payments are past due; "4" = Four or fewer payments are past due; "5" = Either more than four payments are past due, or least one payment is more than 120 days past due; "6" = The account is with collections (Enhanced Trade Only); "7" = Included in Chapter 13; "8" = Repossession; "9" = Charge-off; "E" = The account has a zero balance or is current; "*" = Payment status was not available; Blank = Not reported;
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, , E, *