Skip to main content
GET
/
accounts
/
{account_id}
/
addresses
/
{address_id}
Retrieve an address
curl --request GET \
  --url https://api.brale.xyz/accounts/{account_id}/addresses/{address_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
  "status": "active",
  "name": "Solana Custodial Wallet",
  "address": "73uyt9HkEqx9bThYXWaUBP67sWsiJEsyJ5rSCieDx5me",
  "transfer_types": [
    "solana",
    "base",
    "wire"
  ]
}
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel. This endpoint returns a single internal (custodial) or external Address by its address_id. Use it to fetch the latest status, address value, and enabled transfer_types.

​
Example request

curl --request GET \
  --url "https://api.brale.xyz/accounts/${ACCOUNT_ID}/addresses/${ADDRESS_ID}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

​
Example response

{
  "id": "2MhCCIHulVdXrHiEuQDJvnKbSkl",
  "type": "external",
  "name": "Example Bank",
  "status": "active",
  "address": null,
  "transfer_types": ["ach_credit", "same_day_ach_credit", "rtp_credit"]
}
This endpoint is useful after creating an address whose capabilities may update asynchronously — for example, checking whether rtp_credit has been added to an external bank address after RTP eligibility is confirmed. See Create external address for RTP.

Authorizations

​
Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

​
account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

​
address_id
string<ksuid>
required

The ID of the address

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Response

200 - */*

A single address

​
id
string<ksuid>
Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

​
status
enum<string>
Available options:
pending,
active,
archived
Example:

"active"

​
name
string
Example:

"Solana Custodial Wallet"

​
address
string

The on-chain wallet address

Example:

"73uyt9HkEqx9bThYXWaUBP67sWsiJEsyJ5rSCieDx5me"

​
transfer_types
string[]
Example:
["solana", "base", "wire"]