Update an External Account

curl --request PUT \
  --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "routing_number": "<string>"
  }
}
'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}"

payload = { "account": { "routing_number": "<string>" } }
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account: {routing_number: '<string>'}})
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}', 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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}",
  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([
    'account' => [
        'routing_number' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}"

	payload := strings.NewReader("{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "customer_id": "<string>",
  "account_owner_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "active": true,
  "account_type": "us",
  "currency": "usd",
  "account": {
    "routing_number": "<string>",
    "last_4": "<string>"
  },
  "bank_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "address": {
    "street_line_1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "street_line_2": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "account_owner_country": "<string>",
  "deactivation_details": "<string>",
  "beneficiary_address_valid": true,
  "last_4": "<string>",
  "account_verification": {
    "iban": {
      "reason_code": "<string>",
      "validated_account_owner_name": "<string>"
    },
    "gb": {
      "reason_code": "<string>",
      "validated_account_owner_name": "<string>"
    },
    "requested_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

PUT

customers

{customerID}

external_accounts

{externalAccountID}

Update an External Account

curl --request PUT \
  --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "routing_number": "<string>"
  }
}
'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}"

payload = { "account": { "routing_number": "<string>" } }
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account: {routing_number: '<string>'}})
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}', 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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}",
  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([
    'account' => [
        'routing_number' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}"

	payload := strings.NewReader("{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("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.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"routing_number\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "customer_id": "<string>",
  "account_owner_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "active": true,
  "account_type": "us",
  "currency": "usd",
  "account": {
    "routing_number": "<string>",
    "last_4": "<string>"
  },
  "bank_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "address": {
    "street_line_1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "street_line_2": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "account_owner_country": "<string>",
  "deactivation_details": "<string>",
  "beneficiary_address_valid": true,
  "last_4": "<string>",
  "account_verification": {
    "iban": {
      "reason_code": "<string>",
      "validated_account_owner_name": "<string>"
    },
    "gb": {
      "reason_code": "<string>",
      "validated_account_owner_name": "<string>"
    },
    "requested_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Api-Key

string

header

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

externalAccountID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

Body

application/json

External Account details to be updated

address

object

write-only

Address of the beneficiary of this account.

Show child attributes

account

object

US bank account information. Required when the account_type is us.

Show child attributes

Response

External Account object updated

US bank account using account and routing numbers for ACH or Wire transfers

string

required

read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

customer_id

string

required

read-only

The id of the Bridge customer that this External Account belongs to

Minimum string length: 1

account_owner_name

string

required

Owner of the account Bank Account (e.g. "John Doe"). For ach, wire, and iban accounts, this field must be at least 3 characters, at most 35 characters, and follow the regex pattern for the given account type:

ach: ^(?!\s*$)[\x20-\x7E]*$
wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$
iban: ^(?![:\- ]*$)[a-zA-Z0-9\/\-?:().,'+ _]+$

Required string length: 1 - 256

created_at

string<date-time>

required

read-only

Time of creation of the External Account

updated_at

string<date-time>

required

read-only

Time of last update of the External Account

active

boolean

required

read-only

Whether or not this External Account is active

account_type

enum<string>

required

Type of the bank account.

Available options:

us

currency

enum<string>

required

Currency associated with the bank account. Must be usd for US accounts.

Available options:

usd

account

us · object

required

Show child attributes

bank_name

string

Bank name of the account (e.g. "Chase")

Required string length: 1 - 256

account_owner_type

enum<string>

The type of the account ownership. Required when the account_type is iban. For individual ownership, first_name and last_name are required. For business ownership, business_name is required.

Available options:

individual,

business

first_name

string

First name of the individual account holder. Required when the account_owner_type is individual

last_name

string

Last name of the individual account holder. Required when the account_owner_type is individual

business_name

string

Business name of the business account holder. Required when the account_owner_type is business

address

object

Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number.

Show child attributes

account_owner_country

string

read-only

Three-letter alpha-3 country of residence of the account owner (ISO 3166-1), used for regulatory reporting. Omitted when unknown.

Required string length: 3

deactivation_reason

enum<string>

read-only

Reason for deactivation when this External Account is inactive

Available options:

plaid_item_error,

deactivated_due_to_bounceback,

deleted_by_developer,

requested_by_developer,

invalid_account_number,

invalid_bank_validation,

rejected_by_bank_provider

deactivation_details

string

read-only

Additional details about the deactivation when this External Account is inactive

beneficiary_address_valid

boolean

read-only

Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts

last_4

string

deprecated

read-only

Last 4 digits of the bank account number. This field is getting deprecated in favor of the account.last_4 field

Minimum string length: 1

account_verification

object | null

Present for accounts with a holder verification check; contains the verification result keyed by account type.

Show child attributes

Retrieve an External Account object Delete a single External Account object

⌘I