---
title: "List external accounts"
method: GET
path: "/payments/external_accounts"
tags: ["Payments"]
---

# List external accounts

`GET /payments/external_accounts`

Retrieves a paginated list of external accounts linked to the calling platform, optionally filtered by participants, account type, or account status.

## Query parameters

- `participants` string
- `account_type` 'checking' | 'savings'
- `account_status` 'pending' | 'submitted' | 'approved' | 'closed' | 'deleted' | 'rejected' | 'locked' | 'disabled' | 'revoked' | 'failed'
- `page` number
- `size` number

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Response `200`

Successfully retrieved paginated list of external accounts with optional filters: participants, account_type, account_status.

- GetExternalAccountsResponse
  - `request_id` string — Request id
  - `message` ExternalAccount[]
    - union
      - object
        - `external_account_id` string — Linked account id
        - `account_number` string — Bank account number
        - `routing_number` string — Routing number, routing number needs to be 9 characters and can only be integers [0-9]
        - `account_type` 'checking' | 'savings' — Fiat account type
        - `account_nickname` string — Fiat account nickname
        - `participant_code` string — Participant code
        - `platform_code` string — Platform code
        - `created_at` string, date-time — Creation timestamp of the account.
        - `updated_at` string — Updated at date with time
        - `status` 'pending' | 'approved' | 'rejected' | 'locked' | 'disabled' | 'revoked' | 'closed' — Account status
        - `status_reason` string — Will only be filled if the status is "reject". Gives more details about why it was rejected
        - `networks` union[]
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
      - object
        - `external_account_id` string — Linked account id
        - `account_nickname` string — Crypto account nickname
        - `participant_code` string — Participant code
        - `platform_code` string — Platform code
        - `created_at` string, date-time — Creation timestamp of the account.
        - `updated_at` string — Updated at date with time
        - `status` 'pending' | 'approved' | 'rejected' | 'locked' | 'disabled' | 'revoked' | 'closed' — Account status
        - `status_reason` string — Will only be filled if the status is "reject". Gives more details about why it was rejected
        - `type` 'crypto' | 'fiat' — Account asset type
        - `details` object
          - `destination_tag` string — Destination tag
          - `network` 'ETH' | 'ALGO' | 'ARBITRUM' | 'AVAX' | 'BASE' | 'HBAR' | 'POLYGON' | 'SOL' | 'OP' | 'SUI' | 'XLM' | 'ZK' — Blockchain or Fiat rail
          - `supported_assets` string[] — Tokens or currencies in the provided network
          - `supported_symbols` string[] — Symbol uses dot notation to refer to asset and network
          - `address` string — Destination address
        - `reference_id` string — platform reference id passed through token
  - `page` number
  - `page_size` number
  - `count` number

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)