Update External Account - Asset API Documentation

PATCH

business

{business_id}

external-account

{external_account_id}

Update External Account

curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "connected",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "cursor": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_balanced_at": "2023-11-07T05:31:56Z",
  "external_balance": 123
}
'

import requests

url = "https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}"

payload = {
    "status": "connected",
    "disconnected_at": "2023-11-07T05:31:56Z",
    "cursor": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "last_balanced_at": "2023-11-07T05:31:56Z",
    "external_balance": 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({
    status: 'connected',
    disconnected_at: '2023-11-07T05:31:56Z',
    cursor: '<string>',
    last_synced_at: '2023-11-07T05:31:56Z',
    last_balanced_at: '2023-11-07T05:31:56Z',
    external_balance: 123
  })
};

fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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([
    'status' => 'connected',
    'disconnected_at' => '2023-11-07T05:31:56Z',
    'cursor' => '<string>',
    'last_synced_at' => '2023-11-07T05:31:56Z',
    'last_balanced_at' => '2023-11-07T05:31:56Z',
    'external_balance' => 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.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}"

	payload := strings.NewReader("{\n  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\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.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\n}"

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

{
  "business_id": "<string>",
  "external_id": "1234567890",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_balanced_at": "2023-11-07T05:31:56Z",
  "external_balance": 3512.85,
  "last_statement_end_date": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "contribution_ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "distribution_ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "financial_account_type": "bank_account",
  "metadata_": {},
  "name": "ABC Business Checking",
  "mask": "1234",
  "linked_item_id": "lni_R2fAXCjqJPdpYata112zyW",
  "status": "connected",
  "currency": "USD",
  "institution_name": "Chase Bank"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id

string<biz_string>

required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

external_account_id

string<eac_string>

required

The id of the external account

Example:

"eac_9p2Fp7gra8aCVNvCSekUyK"

Body

application/json

status

enum<string> | null

The updated status of the External Account

Available options:

connected,

disconnected,

untracked

Example:

"connected"

disconnected_at

string<date-time> | null

The datetime when the External Account is disconnected

cursor

string | null

The Plaid cursor of the External Account

last_synced_at

string<date-time> | null

The datetime when the External Account was last synced

last_balanced_at

string<date-time> | null

The datetime when the External Account was last balanced

external_balance

The current balance of the External Account

Response

Successful Response

business_id

string<biz_string>

required

The ID of the Business associated with the External Account

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

type

enum<string>

required

The type of the External Account

Available options:

business,

personal

Examples:

"business"

"personal"

source

enum<string>

required

The source of the External Account

Available options:

manual,

plaid,

statements,

gusto,

stripe

Examples:

"manual"

"plaid"

external_id

string | null

required

The external ID of the External Account

Maximum string length: 255

Example:

"1234567890"

disconnected_at

string<date-time> | null

required

Datetime when the external account was disconnected

last_synced_at

string<date-time> | null

required

Datetime when the external account was last synced

last_balanced_at

string<date-time> | null

required

Datetime when the external account was last balanced

external_balance

number | null

required

The current balance of the External Account

Example:

3512.85

last_statement_end_date

string<date-time> | null

required

Datetime when the external account balance was last updated

string<eac_string>

required

The ID of the External Account

Example:

"eac_Ns6rRRLYVZPh4cVB7MDby5"

ledger_id

string<ldg_string> | null

The ID of the Bank Ledger associated with the Business External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

contribution_ledger_id

string<ldg_string> | null

The ID of the Contribution Ledger associated with the Personal External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

distribution_ledger_id

string<ldg_string> | null

The ID of the Distribution Ledger associated with the Personal External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

financial_account_type

enum<string> | null

The type of real-world financial account this External Account represents

Available options:

bank_account,

credit_card,

prepaid_card,

payments,

payroll,

loan,

accounts_receivable,

accounts_payable

Example:

"bank_account"

metadata_

Metadata · object | null

name

string | null

The name of the External Account

Maximum string length: 255

Example:

"ABC Business Checking"

mask

string | null

The mask of the External Account

Maximum string length: 255

Example:

"1234"

linked_item_id

string<lni_string> | null

The ID of the Linked Item associated with the External Account

Example:

"lni_R2fAXCjqJPdpYata112zyW"

status

enum<string>

default:connected

The status of the External Account

Available options:

connected,

disconnected,

untracked

Examples:

"connected"

"disconnected"

currency

string

default:USD

ISO 4217 currency code for this account.

Examples:

"USD"

"CAD"

institution_name

string | null

The name of the institution associated with the External Account, if any

Example:

"Chase Bank"

⌘I

Update External Account

curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "connected",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "cursor": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_balanced_at": "2023-11-07T05:31:56Z",
  "external_balance": 123
}
'

import requests

url = "https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}"

payload = {
    "status": "connected",
    "disconnected_at": "2023-11-07T05:31:56Z",
    "cursor": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "last_balanced_at": "2023-11-07T05:31:56Z",
    "external_balance": 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({
    status: 'connected',
    disconnected_at: '2023-11-07T05:31:56Z',
    cursor: '<string>',
    last_synced_at: '2023-11-07T05:31:56Z',
    last_balanced_at: '2023-11-07T05:31:56Z',
    external_balance: 123
  })
};

fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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([
    'status' => 'connected',
    'disconnected_at' => '2023-11-07T05:31:56Z',
    'cursor' => '<string>',
    'last_synced_at' => '2023-11-07T05:31:56Z',
    'last_balanced_at' => '2023-11-07T05:31:56Z',
    'external_balance' => 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.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}"

	payload := strings.NewReader("{\n  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\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.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/external-account/{external_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  \"status\": \"connected\",\n  \"disconnected_at\": \"2023-11-07T05:31:56Z\",\n  \"cursor\": \"<string>\",\n  \"last_synced_at\": \"2023-11-07T05:31:56Z\",\n  \"last_balanced_at\": \"2023-11-07T05:31:56Z\",\n  \"external_balance\": 123\n}"

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

{
  "business_id": "<string>",
  "external_id": "1234567890",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_balanced_at": "2023-11-07T05:31:56Z",
  "external_balance": 3512.85,
  "last_statement_end_date": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "contribution_ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "distribution_ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",
  "financial_account_type": "bank_account",
  "metadata_": {},
  "name": "ABC Business Checking",
  "mask": "1234",
  "linked_item_id": "lni_R2fAXCjqJPdpYata112zyW",
  "status": "connected",
  "currency": "USD",
  "institution_name": "Chase Bank"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}