Update an account
curl --request PATCH \
--url https://api.finta.io/v2/accounts/{accountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"liability": {
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": true,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": true,
"hasPrepaymentPenalty": true,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
}
}
'import requests
url = "https://api.finta.io/v2/accounts/{accountId}"
payload = {
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"liability": {
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": True,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": True,
"hasPrepaymentPenalty": True,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
}
}
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({
name: '<string>',
type: '<string>',
subtype: '<string>',
mask: '<string>',
currency: '<string>',
currentBalance: 123,
availableBalance: 123,
liability: {
minimumPaymentAmount: 123,
nextPaymentDueDate: '2023-12-25',
lastPaymentAmount: 123,
lastPaymentDate: '2023-12-25',
interestRate: 123,
isOverdue: true,
lastStatementBalance: 123,
aprs: [
{
aprType: '<string>',
aprPercentage: 123,
balanceSubjectToApr: 123,
interestChargeAmount: 123
}
],
loanName: '<string>',
loanStatus: {type: '<string>', endDate: '2023-12-25'},
repaymentPlan: {type: '<string>', description: '<string>'},
pslfStatus: {
paymentsRemaining: 123,
paymentsMade: 123,
estimatedEligibilityDate: '2023-12-25'
},
originationDate: '2023-12-25',
originationPrincipalAmount: 123,
expectedPayoffDate: '2023-12-25',
outstandingInterestAmount: 123,
ytdInterestPaid: 123,
ytdPrincipalPaid: 123,
nextMonthlyPayment: 123,
escrowBalance: 123,
hasPmi: true,
hasPrepaymentPenalty: true,
propertyAddress: {
street: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
},
loanTypeDescription: '<string>',
maturityDate: '2023-12-25',
pastDueAmount: 123
}
})
};
fetch('https://api.finta.io/v2/accounts/{accountId}', 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.finta.io/v2/accounts/{accountId}",
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([
'name' => '<string>',
'type' => '<string>',
'subtype' => '<string>',
'mask' => '<string>',
'currency' => '<string>',
'currentBalance' => 123,
'availableBalance' => 123,
'liability' => [
'minimumPaymentAmount' => 123,
'nextPaymentDueDate' => '2023-12-25',
'lastPaymentAmount' => 123,
'lastPaymentDate' => '2023-12-25',
'interestRate' => 123,
'isOverdue' => true,
'lastStatementBalance' => 123,
'aprs' => [
[
'aprType' => '<string>',
'aprPercentage' => 123,
'balanceSubjectToApr' => 123,
'interestChargeAmount' => 123
]
],
'loanName' => '<string>',
'loanStatus' => [
'type' => '<string>',
'endDate' => '2023-12-25'
],
'repaymentPlan' => [
'type' => '<string>',
'description' => '<string>'
],
'pslfStatus' => [
'paymentsRemaining' => 123,
'paymentsMade' => 123,
'estimatedEligibilityDate' => '2023-12-25'
],
'originationDate' => '2023-12-25',
'originationPrincipalAmount' => 123,
'expectedPayoffDate' => '2023-12-25',
'outstandingInterestAmount' => 123,
'ytdInterestPaid' => 123,
'ytdPrincipalPaid' => 123,
'nextMonthlyPayment' => 123,
'escrowBalance' => 123,
'hasPmi' => true,
'hasPrepaymentPenalty' => true,
'propertyAddress' => [
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'loanTypeDescription' => '<string>',
'maturityDate' => '2023-12-25',
'pastDueAmount' => 123
]
]),
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://api.finta.io/v2/accounts/{accountId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\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://api.finta.io/v2/accounts/{accountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finta.io/v2/accounts/{accountId}")
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 \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerAccountId": "<string>",
"bankConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bankConnectionStatus": "active",
"provider": "plaid",
"institutionName": "<string>",
"name": "<string>",
"mask": "<string>",
"type": "<string>",
"subtype": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"balanceAsOf": "2023-11-07T05:31:56Z",
"status": "active",
"closedAt": "2023-11-07T05:31:56Z",
"liability": {
"type": "credit",
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": true,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"interestRateType": "fixed",
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": true,
"hasPrepaymentPenalty": true,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
},
"institutionAccountName": "<string>"
}
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": "Missing or invalid Authorization header"
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Per-minute rate limit exceeded (standard plan)"
}
}Accounts
Update an account
Update an account. Requires Storage Mode. A manual account’s name, type, currency, mask, balance, or liability data can change; updating the balance records a balance-history snapshot for today. A bank-synced account can only be renamed: send name alone, or name: null to go back to the bank’s name (institutionAccountName). Syncs never overwrite the new name. Sending any other field for a synced account returns 400 and saves nothing.
PATCH
/
accounts
/
{accountId}
Update an account
curl --request PATCH \
--url https://api.finta.io/v2/accounts/{accountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"liability": {
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": true,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": true,
"hasPrepaymentPenalty": true,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
}
}
'import requests
url = "https://api.finta.io/v2/accounts/{accountId}"
payload = {
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"liability": {
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": True,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": True,
"hasPrepaymentPenalty": True,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
}
}
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({
name: '<string>',
type: '<string>',
subtype: '<string>',
mask: '<string>',
currency: '<string>',
currentBalance: 123,
availableBalance: 123,
liability: {
minimumPaymentAmount: 123,
nextPaymentDueDate: '2023-12-25',
lastPaymentAmount: 123,
lastPaymentDate: '2023-12-25',
interestRate: 123,
isOverdue: true,
lastStatementBalance: 123,
aprs: [
{
aprType: '<string>',
aprPercentage: 123,
balanceSubjectToApr: 123,
interestChargeAmount: 123
}
],
loanName: '<string>',
loanStatus: {type: '<string>', endDate: '2023-12-25'},
repaymentPlan: {type: '<string>', description: '<string>'},
pslfStatus: {
paymentsRemaining: 123,
paymentsMade: 123,
estimatedEligibilityDate: '2023-12-25'
},
originationDate: '2023-12-25',
originationPrincipalAmount: 123,
expectedPayoffDate: '2023-12-25',
outstandingInterestAmount: 123,
ytdInterestPaid: 123,
ytdPrincipalPaid: 123,
nextMonthlyPayment: 123,
escrowBalance: 123,
hasPmi: true,
hasPrepaymentPenalty: true,
propertyAddress: {
street: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
country: '<string>'
},
loanTypeDescription: '<string>',
maturityDate: '2023-12-25',
pastDueAmount: 123
}
})
};
fetch('https://api.finta.io/v2/accounts/{accountId}', 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.finta.io/v2/accounts/{accountId}",
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([
'name' => '<string>',
'type' => '<string>',
'subtype' => '<string>',
'mask' => '<string>',
'currency' => '<string>',
'currentBalance' => 123,
'availableBalance' => 123,
'liability' => [
'minimumPaymentAmount' => 123,
'nextPaymentDueDate' => '2023-12-25',
'lastPaymentAmount' => 123,
'lastPaymentDate' => '2023-12-25',
'interestRate' => 123,
'isOverdue' => true,
'lastStatementBalance' => 123,
'aprs' => [
[
'aprType' => '<string>',
'aprPercentage' => 123,
'balanceSubjectToApr' => 123,
'interestChargeAmount' => 123
]
],
'loanName' => '<string>',
'loanStatus' => [
'type' => '<string>',
'endDate' => '2023-12-25'
],
'repaymentPlan' => [
'type' => '<string>',
'description' => '<string>'
],
'pslfStatus' => [
'paymentsRemaining' => 123,
'paymentsMade' => 123,
'estimatedEligibilityDate' => '2023-12-25'
],
'originationDate' => '2023-12-25',
'originationPrincipalAmount' => 123,
'expectedPayoffDate' => '2023-12-25',
'outstandingInterestAmount' => 123,
'ytdInterestPaid' => 123,
'ytdPrincipalPaid' => 123,
'nextMonthlyPayment' => 123,
'escrowBalance' => 123,
'hasPmi' => true,
'hasPrepaymentPenalty' => true,
'propertyAddress' => [
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'loanTypeDescription' => '<string>',
'maturityDate' => '2023-12-25',
'pastDueAmount' => 123
]
]),
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://api.finta.io/v2/accounts/{accountId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\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://api.finta.io/v2/accounts/{accountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finta.io/v2/accounts/{accountId}")
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 \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"mask\": \"<string>\",\n \"currency\": \"<string>\",\n \"currentBalance\": 123,\n \"availableBalance\": 123,\n \"liability\": {\n \"minimumPaymentAmount\": 123,\n \"nextPaymentDueDate\": \"2023-12-25\",\n \"lastPaymentAmount\": 123,\n \"lastPaymentDate\": \"2023-12-25\",\n \"interestRate\": 123,\n \"isOverdue\": true,\n \"lastStatementBalance\": 123,\n \"aprs\": [\n {\n \"aprType\": \"<string>\",\n \"aprPercentage\": 123,\n \"balanceSubjectToApr\": 123,\n \"interestChargeAmount\": 123\n }\n ],\n \"loanName\": \"<string>\",\n \"loanStatus\": {\n \"type\": \"<string>\",\n \"endDate\": \"2023-12-25\"\n },\n \"repaymentPlan\": {\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"pslfStatus\": {\n \"paymentsRemaining\": 123,\n \"paymentsMade\": 123,\n \"estimatedEligibilityDate\": \"2023-12-25\"\n },\n \"originationDate\": \"2023-12-25\",\n \"originationPrincipalAmount\": 123,\n \"expectedPayoffDate\": \"2023-12-25\",\n \"outstandingInterestAmount\": 123,\n \"ytdInterestPaid\": 123,\n \"ytdPrincipalPaid\": 123,\n \"nextMonthlyPayment\": 123,\n \"escrowBalance\": 123,\n \"hasPmi\": true,\n \"hasPrepaymentPenalty\": true,\n \"propertyAddress\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"loanTypeDescription\": \"<string>\",\n \"maturityDate\": \"2023-12-25\",\n \"pastDueAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerAccountId": "<string>",
"bankConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bankConnectionStatus": "active",
"provider": "plaid",
"institutionName": "<string>",
"name": "<string>",
"mask": "<string>",
"type": "<string>",
"subtype": "<string>",
"currency": "<string>",
"currentBalance": 123,
"availableBalance": 123,
"balanceAsOf": "2023-11-07T05:31:56Z",
"status": "active",
"closedAt": "2023-11-07T05:31:56Z",
"liability": {
"type": "credit",
"minimumPaymentAmount": 123,
"nextPaymentDueDate": "2023-12-25",
"lastPaymentAmount": 123,
"lastPaymentDate": "2023-12-25",
"interestRate": 123,
"isOverdue": true,
"lastStatementBalance": 123,
"aprs": [
{
"aprType": "<string>",
"aprPercentage": 123,
"balanceSubjectToApr": 123,
"interestChargeAmount": 123
}
],
"loanName": "<string>",
"loanStatus": {
"type": "<string>",
"endDate": "2023-12-25"
},
"repaymentPlan": {
"type": "<string>",
"description": "<string>"
},
"pslfStatus": {
"paymentsRemaining": 123,
"paymentsMade": 123,
"estimatedEligibilityDate": "2023-12-25"
},
"originationDate": "2023-12-25",
"originationPrincipalAmount": 123,
"expectedPayoffDate": "2023-12-25",
"outstandingInterestAmount": 123,
"ytdInterestPaid": 123,
"ytdPrincipalPaid": 123,
"interestRateType": "fixed",
"nextMonthlyPayment": 123,
"escrowBalance": 123,
"hasPmi": true,
"hasPrepaymentPenalty": true,
"propertyAddress": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"loanTypeDescription": "<string>",
"maturityDate": "2023-12-25",
"pastDueAmount": 123
},
"institutionAccountName": "<string>"
}
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": "Missing or invalid Authorization header"
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Per-minute rate limit exceeded (standard plan)"
}
}Authorizations
A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as Authorization: Bearer <token>.
Path Parameters
Finta bank account ID
Body
application/json
At least one field must be provided. Pass null to clear a nullable field. A bank-synced account accepts only name.
New display name. On a bank-synced account, null puts back the bank's name (institutionAccountName); a manual account needs a name.
Required string length:
1 - 120Required string length:
1 - 100Required string length:
1 - 100Required string length:
1 - 100Required string length:
1 - 10Liability detail for credit, student, or mortgage accounts; null for non-liability accounts. Fields not relevant to the liability type are null. The same shape is accepted when creating or updating a manual account.
Show child attributes
Show child attributes
Response
Updated account
Show child attributes
Show child attributes