Get connected accounts
Returns all connected accounts.
Note: This endpoint is currently in beta and might be subject to changes.
GET
TypeScript
Query Parameters
Whether to include only main accounts in the response.
Page size for pagination.
Required range:
1 <= x <= 100Page cursor for pagination.
Response
Get accounts response
List of connected accounts matching the query.
Example:
[
{
"id": "acc-123456",
"name": "Main Venue Account",
"providerId": "BRIDGE",
"status": "APPROVED",
"totalBalance": {
"amount": "1201.15",
"denominatedAssetId": "ea6c3cb7-355a-4ee3-82ff-267c69970214",
"hasFullAssetCoverage": true
},
"manifest": {
"assetTypes": [],
"capabilities": ["DEPOSITS", "WITHDRAWALS"]
},
"accountType": "CONNECTED_ACCOUNT"
},
{
"id": "acc-654321",
"name": "Secondary Account",
"providerId": "BRIDGE",
"status": "WAITING_FOR_APPROVAL",
"totalBalance": {
"amount": "0.00",
"denominatedAssetId": "ea6c3cb7-355a-4ee3-82ff-267c69970214",
"hasFullAssetCoverage": false
},
"manifest": {
"assetTypes": [],
"capabilities": ["WITHDRAWALS"]
},
"accountType": "CONNECTED_ACCOUNT"
}
]Total number of accounts by query.
Example:
2
A cursor for the next page of results, if available.
Example:
"eyJwYWdlIjoyfQ=="
Previous
Add a connected accountCreates a new connected account for the authenticated tenant.
The `creds` field must be a Base64-encoded RSA-encrypted credential blob.
Use `GET /exchange_accounts/credentials_public_key` to retrieve the public key for encryption.
The `providerType` is derived server-side from the `providerId` — callers do not supply it.
Endpoint Permission: Editor, Admin, Non-Signing Admin.
**Note:** This endpoint is currently in beta and might be subject to changes.
Next
TypeScript