---
title: "Fetch External Account Details"
method: GET
path: "/v3/metadata/external_account_details"
---

# Fetch External Account Details

`GET /v3/metadata/external_account_details`

## Request

- Base URL: `https://service-sandbox.tazapay.com`
- URL: `https://service-sandbox.tazapay.com/v3/metadata/external_account_details`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/tazapay/apis/sandbox/docs/v3/metadata/external_account_details/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch Account Details using the tax ID

## Query parameters

- `country` string, required
- `tax_id` string, required

## Response `200`

200

- object
  - `status` string: Indicates whether the request to retrieve external account details was successful.
  - `message` string: Additional message providing context about the response.
  - `data` object: Contains details about the linked external accounts and their associated information.
    - `account_holder_name` string: Name of the account holder associated with the external account.
    - `accounts` object[]: List of external accounts linked to the user or entity.
      - `bank` Bank: Bank account details
        - `account_number` string: Bank Account Number. Either account_number or IBAN is mandatory
        - `iban` string: IBAN. Either account_number or iban is mandatory
        - `bank_name` string: Name of the bank
        - `branch_name` string: Name of the branch
        - `country` string: Two-letter country code (ISO 3166-1 alpha-2)
        - `currency` string: Three-letter ISO currency code, in uppercase
        - `purpose_code` string: Purpose Code for INR bank accounts
        - `bank_codes` BankCodes: Bank specific identification codes
          - `swift_code` string: SWIFT Code
          - `bic_code` string: Bank Identifier Code (BIC)
          - `ifsc_code` string: IFS Code
          - `aba_code` string: ABA / Routing Number
          - `sort_code` string: SORT Code
          - `branch_code` string: Branch Code
          - `bsb_code` string: BSB Code
          - `bank_code` string: Bank Code
          - `cnaps` string: CNAPS
        - `firc_required` boolean: Pass true if you want FIRC for a payout to India
        - `account_type` 'savings' | 'checking' | 'payment': Type of bank account
        - `account_holder_name` string: Name of the account holder
        - `transfer_type` string: Type of transfer (e.g., local, SWIFT)
      - `type` string: Specifies the type of external account, typically 'bank'.
    - `country` string: Country code (ISO 3166-1 alpha-2) associated with the external account.
    - `object` string: Type of object returned, typically 'external_account_details'.
    - `tax_id` string: Tax identification number linked to the external account holder.

---

[API](https://skmtc.dev/tazapay/apis/sandbox.md) - [All operations](https://skmtc.dev/tazapay/apis/sandbox/llms.txt) - [OpenAPI document](https://skmtc.dev/tazapay/apis/sandbox/revisions/bf5f4b8f6f5d?raw)