HIFI Docs

GET

external-accounts

{externalAccountId}

Retrieve an external account

curl --request GET \
  --url https://production.hifi.com/v3/external-accounts/{externalAccountId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifi.com/v3/external-accounts/{externalAccountId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/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://production.hifi.com/v3/external-accounts/{externalAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifi.com/v3/external-accounts/{externalAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/external-accounts/{externalAccountId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "extacct_9aB0xY4mNpXwZ7bV1aLdt",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "counterPartyId": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
  "accountNumber": "****6789",
  "routingNumber": "021000021",
  "accountType": "CHECKING",
  "bankName": "Chase Bank",
  "bankAddress": {
    "addressLine1": "123 Main Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "currency": "USD",
  "transferType": "ACH",
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

externalAccountId

string

required

Public ID of the external account (prefixed with extacct_)

Response

External account retrieved successfully.

An external account.

string

Public ID of the external account (prefixed with extacct_).

Example:

"extacct_9aB0xY4mNpXwZ7bV1aLdt"

userId

string

Public ID of the user this account belongs to (prefixed with usr_).

Example:

"usr_3Kf9dQ2mNpXwZ7bV1aLcs"

counterPartyId

string

Public ID of the counter party this account belongs to (prefixed with cpty_).

Example:

"cpty_7dLpR2mNpXwZ7bV1aQz3x"

accountNumber

string

Masked bank account number.

Example:

"****6789"

routingNumber

string

ABA routing number.

Example:

"021000021"

accountType

enum<string>

Available options:

CHECKING,

SAVINGS

Example:

"CHECKING"

iban

string

Masked IBAN.

Example:

"****6789"

swiftCode

string

SWIFT/BIC code.

Example:

"DEUTDEFF"

sortCode

string

Sort code.

Example:

"123456"

pixKey

string

Masked PIX key (EVP format).

Example:

"****4000"

phoneNumber

string

Masked phone number.

Example:

"+57*****4567"

string

Masked email (PIX key, Brazil only).

Example:

"j***e@e*****e.com"

cpf

string

Masked CPF (PIX key, Brazil only).

Example:

"****8901"

cnpj

string

Masked CNPJ (PIX key, Brazil only).

Example:

"****1234"

bankName

string

Example:

"Chase Bank"

bankAddress

object

Address of the beneficiary bank.

Show child attributes

nickname

string | null

Client-supplied nickname for the external account.

Example:

"Primary settlement account"

currency

enum<string>

Available options:

USD,

EUR,

BRL,

NGN,

KES,

TZS,

UGX,

BWP,

XAF,

MWK,

RWF,

ZMW,

XOF,

ZAR,

MXN,

PHP,

AED,

HKD,

CNY,

COP,

ARS,

SGD,

GBP,

AUD,

CAD,

JPY,

VND

Example:

"USD"

transferType

enum<string>

Available options:

ACH,

WIRE,

SWIFT,

RTP,

PIX,

SPEI,

CHATS,

FPS,

CIPS,

SEPA,

INSTAPAY,

PESONET,

NEQUI,

BANK

Example:

"ACH"

fpsId

string

Masked Faster Payment System identifier.

Example:

"****6789"

clabe

string

Masked CLABE number.

Example:

"****9719"

status

enum<string>

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

invalidCode

string | null

Set when the receiving bank reports the account as invalid; the account's status is then INACTIVE and it cannot be used for new transfers. Null otherwise.

Format is <RAIL>_<EVENT>_<NETWORK_CODE>, shared across payment rails. More rails and codes may be added.

Code	Description
`ACH_NOC_C01`	Incorrect DFI Account Number
`ACH_NOC_C02`	Incorrect Routing Number
`ACH_NOC_C03`	Incorrect Routing Number and Incorrect DFI Number
`ACH_NOC_C04`	Incorrect Individual Name/Receiving Company Name
`ACH_NOC_C05`	Incorrect Transaction Code
`ACH_NOC_C06`	Incorrect DFI Account Number and Incorrect Transaction Code
`ACH_NOC_C07`	Incorrect Routing Number, Incorrect DFI Account Number, and Incorrect Transaction Code
`ACH_NOC_C08`	Incorrect Receiving DFI Identification (IAT only)
`ACH_NOC_C09`	Incorrect Identification Number
`ACH_NOC_C13`	Addenda Format Error
`ACH_NOC_C14`	Incorrect SEC Code for Outbound International Payment
`ACH_RETURN_<Rxx>`	ACH prenote returned with return code `Rxx` (e.g. `ACH_RETURN_R03`: No account or unable to locate account)

Example:

"ACH_NOC_C01"

invalidMessage

string | null

Human-readable description of invalidCode. Null when invalidCode is null.

Example:

"Incorrect DFI Account Number"

createdAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

updatedAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

⌘I

Retrieve an external account

curl --request GET \
  --url https://production.hifi.com/v3/external-accounts/{externalAccountId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifi.com/v3/external-accounts/{externalAccountId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/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://production.hifi.com/v3/external-accounts/{externalAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifi.com/v3/external-accounts/{externalAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/external-accounts/{externalAccountId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "extacct_9aB0xY4mNpXwZ7bV1aLdt",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "counterPartyId": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
  "accountNumber": "****6789",
  "routingNumber": "021000021",
  "accountType": "CHECKING",
  "bankName": "Chase Bank",
  "bankAddress": {
    "addressLine1": "123 Main Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "currency": "USD",
  "transferType": "ACH",
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Overview

Endpoints

Retrieve an external account

Authorizations

Path Parameters

Response