Skip to main content
PATCH
/
external_accounts
/
{external_account_id}
Patch an external account
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/external_accounts/{external_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_identifiers": {
    "iban": "LI4476584648937N59B00",
    "number": 87654321
  },
  "account_owner_names": [
    "Jane Smith"
  ],
  "currency": "USD",
  "nickname": "Vacation savings",
  "routing_identifiers": {
    "ach_routing_number": "756392185",
    "bank_name": "Chase",
    "eft_ca_routing_number": "02101140",
    "international_wire_details": {
      "correspondent_banks_details": [
        {
          "bank_address": {
            "address_line_1": "100 Main St.",
            "country_code": "US",
            "address_line_2": "Suite 99",
            "city": "New York",
            "is_registered_agent": true,
            "nickname": "Home",
            "postal_code": "28620",
            "state": "NY"
          },
          "bank_name": "Bank of Greece",
          "swift_code": "BNGRGRAAXXX"
        }
      ],
      "swift_code": "CHASUS3AXXX"
    },
    "wire_routing_number": "952391102"
  },
  "status_reason": "<string>",
  "verification": {
    "creation_time": "2010-05-06T12:23:34.321Z",
    "last_updated_time": "2010-05-06T12:23:34.321Z"
  }
}
'
import requests

url = "https://api-sandbox.synctera.com/v0/external_accounts/{external_account_id}"

payload = {
    "account_identifiers": {
        "iban": "LI4476584648937N59B00",
        "number": 87654321
    },
    "account_owner_names": ["Jane Smith"],
    "currency": "USD",
    "nickname": "Vacation savings",
    "routing_identifiers": {
        "ach_routing_number": "756392185",
        "bank_name": "Chase",
        "eft_ca_routing_number": "02101140",
        "international_wire_details": {
            "correspondent_banks_details": [
                {
                    "bank_address": {
                        "address_line_1": "100 Main St.",
                        "country_code": "US",
                        "address_line_2": "Suite 99",
                        "city": "New York",
                        "is_registered_agent": True,
                        "nickname": "Home",
                        "postal_code": "28620",
                        "state": "NY"
                    },
                    "bank_name": "Bank of Greece",
                    "swift_code": "BNGRGRAAXXX"
                }
            ],
            "swift_code": "CHASUS3AXXX"
        },
        "wire_routing_number": "952391102"
    },
    "status_reason": "<string>",
    "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z"
    }
}
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({
    account_identifiers: {iban: 'LI4476584648937N59B00', number: 87654321},
    account_owner_names: ['Jane Smith'],
    currency: 'USD',
    nickname: 'Vacation savings',
    routing_identifiers: {
      ach_routing_number: '756392185',
      bank_name: 'Chase',
      eft_ca_routing_number: '02101140',
      international_wire_details: {
        correspondent_banks_details: [
          {
            bank_address: {
              address_line_1: '100 Main St.',
              country_code: 'US',
              address_line_2: 'Suite 99',
              city: 'New York',
              is_registered_agent: true,
              nickname: 'Home',
              postal_code: '28620',
              state: 'NY'
            },
            bank_name: 'Bank of Greece',
            swift_code: 'BNGRGRAAXXX'
          }
        ],
        swift_code: 'CHASUS3AXXX'
      },
      wire_routing_number: '952391102'
    },
    status_reason: '<string>',
    verification: {
      creation_time: '2010-05-06T12:23:34.321Z',
      last_updated_time: '2010-05-06T12:23:34.321Z'
    }
  })
};

fetch('https://api-sandbox.synctera.com/v0/external_accounts/{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.synctera.com/v0/external_accounts/{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([
    'account_identifiers' => [
        'iban' => 'LI4476584648937N59B00',
        'number' => 87654321
    ],
    'account_owner_names' => [
        'Jane Smith'
    ],
    'currency' => 'USD',
    'nickname' => 'Vacation savings',
    'routing_identifiers' => [
        'ach_routing_number' => '756392185',
        'bank_name' => 'Chase',
        'eft_ca_routing_number' => '02101140',
        'international_wire_details' => [
                'correspondent_banks_details' => [
                                [
                                                                'bank_address' => [
                                                                                                                                'address_line_1' => '100 Main St.',
                                                                                                                                'country_code' => 'US',
                                                                                                                                'address_line_2' => 'Suite 99',
                                                                                                                                'city' => 'New York',
                                                                                                                                'is_registered_agent' => true,
                                                                                                                                'nickname' => 'Home',
                                                                                                                                'postal_code' => '28620',
                                                                                                                                'state' => 'NY'
                                                                ],
                                                                'bank_name' => 'Bank of Greece',
                                                                'swift_code' => 'BNGRGRAAXXX'
                                ]
                ],
                'swift_code' => 'CHASUS3AXXX'
        ],
        'wire_routing_number' => '952391102'
    ],
    'status_reason' => '<string>',
    'verification' => [
        'creation_time' => '2010-05-06T12:23:34.321Z',
        'last_updated_time' => '2010-05-06T12:23:34.321Z'
    ]
  ]),
  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.synctera.com/v0/external_accounts/{external_account_id}"

	payload := strings.NewReader("{\n  \"account_identifiers\": {\n    \"iban\": \"LI4476584648937N59B00\",\n    \"number\": 87654321\n  },\n  \"account_owner_names\": [\n    \"Jane Smith\"\n  ],\n  \"currency\": \"USD\",\n  \"nickname\": \"Vacation savings\",\n  \"routing_identifiers\": {\n    \"ach_routing_number\": \"756392185\",\n    \"bank_name\": \"Chase\",\n    \"eft_ca_routing_number\": \"02101140\",\n    \"international_wire_details\": {\n      \"correspondent_banks_details\": [\n        {\n          \"bank_address\": {\n            \"address_line_1\": \"100 Main St.\",\n            \"country_code\": \"US\",\n            \"address_line_2\": \"Suite 99\",\n            \"city\": \"New York\",\n            \"is_registered_agent\": true,\n            \"nickname\": \"Home\",\n            \"postal_code\": \"28620\",\n            \"state\": \"NY\"\n          },\n          \"bank_name\": \"Bank of Greece\",\n          \"swift_code\": \"BNGRGRAAXXX\"\n        }\n      ],\n      \"swift_code\": \"CHASUS3AXXX\"\n    },\n    \"wire_routing_number\": \"952391102\"\n  },\n  \"status_reason\": \"<string>\",\n  \"verification\": {\n    \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n    \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\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-sandbox.synctera.com/v0/external_accounts/{external_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_identifiers\": {\n    \"iban\": \"LI4476584648937N59B00\",\n    \"number\": 87654321\n  },\n  \"account_owner_names\": [\n    \"Jane Smith\"\n  ],\n  \"currency\": \"USD\",\n  \"nickname\": \"Vacation savings\",\n  \"routing_identifiers\": {\n    \"ach_routing_number\": \"756392185\",\n    \"bank_name\": \"Chase\",\n    \"eft_ca_routing_number\": \"02101140\",\n    \"international_wire_details\": {\n      \"correspondent_banks_details\": [\n        {\n          \"bank_address\": {\n            \"address_line_1\": \"100 Main St.\",\n            \"country_code\": \"US\",\n            \"address_line_2\": \"Suite 99\",\n            \"city\": \"New York\",\n            \"is_registered_agent\": true,\n            \"nickname\": \"Home\",\n            \"postal_code\": \"28620\",\n            \"state\": \"NY\"\n          },\n          \"bank_name\": \"Bank of Greece\",\n          \"swift_code\": \"BNGRGRAAXXX\"\n        }\n      ],\n      \"swift_code\": \"CHASUS3AXXX\"\n    },\n    \"wire_routing_number\": \"952391102\"\n  },\n  \"status_reason\": \"<string>\",\n  \"verification\": {\n    \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n    \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/external_accounts/{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  \"account_identifiers\": {\n    \"iban\": \"LI4476584648937N59B00\",\n    \"number\": 87654321\n  },\n  \"account_owner_names\": [\n    \"Jane Smith\"\n  ],\n  \"currency\": \"USD\",\n  \"nickname\": \"Vacation savings\",\n  \"routing_identifiers\": {\n    \"ach_routing_number\": \"756392185\",\n    \"bank_name\": \"Chase\",\n    \"eft_ca_routing_number\": \"02101140\",\n    \"international_wire_details\": {\n      \"correspondent_banks_details\": [\n        {\n          \"bank_address\": {\n            \"address_line_1\": \"100 Main St.\",\n            \"country_code\": \"US\",\n            \"address_line_2\": \"Suite 99\",\n            \"city\": \"New York\",\n            \"is_registered_agent\": true,\n            \"nickname\": \"Home\",\n            \"postal_code\": \"28620\",\n            \"state\": \"NY\"\n          },\n          \"bank_name\": \"Bank of Greece\",\n          \"swift_code\": \"BNGRGRAAXXX\"\n        }\n      ],\n      \"swift_code\": \"CHASUS3AXXX\"\n    },\n    \"wire_routing_number\": \"952391102\"\n  },\n  \"status_reason\": \"<string>\",\n  \"verification\": {\n    \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n    \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "account_identifiers": {
    "number": "78277121",
    "iban": "LI4476584648937N59B00"
  },
  "account_owner_names": [
    "Jane Smith"
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "routing_identifiers": {
    "bank_countries": [
      "US"
    ],
    "bank_name": "Chase",
    "ach_routing_number": "756392185",
    "bank_address": {
      "address_line_1": "100 Main St.",
      "country_code": "US",
      "address_line_2": "Suite 99",
      "address_type": "SHIPPING",
      "city": "New York",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    },
    "correspondent_bank_details": [
      {
        "bank_address": {
          "address_line_1": "100 Main St.",
          "country_code": "US",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "is_registered_agent": true,
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        },
        "bank_name": "Bank of Greece",
        "swift_code": "BNGRGRAAXXX"
      }
    ],
    "eft_ca_routing_number": "02101140",
    "eft_routing_number": "02101140",
    "swift_code": "CHASUS3AXXX",
    "wire_routing_number": "756392185"
  },
  "verification": {
    "creation_time": "2010-05-06T12:23:34.321Z",
    "last_updated_time": "2010-05-06T12:23:34.321Z"
  },
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "currency": "USD",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "deletion_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "name": "Plaid Checking",
  "nickname": "Vacation savings",
  "status_reason": "<string>",
  "tenant": "abcdef_ghijkl",
  "vendor_data": {
    "account_number_mask": "<string>",
    "institution_id": "<string>"
  },
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}
{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
external_account_id
string<uuid>
required

External Account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

External account to be updated

​
account_identifiers
Identifiers for the account · object
​
account_owner_names
string[]

The names of the account owners.

​
currency
string

The currency of the account in ISO 4217 format

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
nickname
string

A user-meaningful name for the account

Minimum string length: 1
Example:

"Vacation savings"

​
routing_identifiers
Identifiers for the bank · object
​
status
enum<string>
Available options:
ACTIVE,
INACTIVE
​
status_reason
string

The reason for the status change of the external account.

​
type
enum<string>

The type of the account

Available options:
CHECKING,
CRYPTO_WALLET,
OTHER_BANK_ACCOUNT,
SAVINGS,
WALLET
​
verification
Information specific to Plaid verification · object

Information about the account verification process. If the account has not been verified, this will be null.

Response

Updated external account

​
account_identifiers
Identifiers for the account · object
required
​
account_owner_names
string[]
required

The names of the account owners. Values may be masked, in which case the array will be empty.

​
creation_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required
read-only

External account unique identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_updated_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
routing_identifiers
Routing information for the account · object
required
​
status
enum<string>
required

The current state of the account

Available options:
ACTIVE,
CLOSED,
DELETED,
INACTIVE
​
type
enum<string>
required

The type of the account

Available options:
CHECKING,
CREDIT_CARD,
CRYPTO_WALLET,
INVESTMENT_529,
MONEY_MARKET,
OTHER,
OTHER_BANK_ACCOUNT,
SAVINGS,
WALLET
​
verification
Information specific to Plaid verification · object
required

Information about the account verification process. If the account has not been verified, this will be null.

​
business_id
string<uuid>

The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id will be returned.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
currency
string

ISO 4217 alphabetic currency code

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
customer_id
string<uuid>

The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id will be returned.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
deletion_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

User-supplied JSON format metadata.

​
name
string

The official name of the account

Example:

"Plaid Checking"

​
nickname
string | null

A user-meaningful name for the account

Example:

"Vacation savings"

​
status_reason
string

The reason for the status for the external account.

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
vendor_data
object
​
vendor_info
Vendor Info · object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.