> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uqpay.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a bank details

> This endpoint returns a bank details of a balance based on the currency.

### Header

<ParamField header="x-client-id" type="string" required>
  `x-client-id`.
</ParamField>

<ParamField header="x-auth-token" type="string" required>
  Bearer `YOUR_TOKEN_HERE`.
</ParamField>

### Parameters

<ParamField path="currency" type="string" required>
  Currency of the balance.<br />
  Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
</ParamField>

### Response

<ResponseField name="code" type="number">
  Indicates whether the call was successful. 200 if successful, 400 if not.
</ResponseField>

<ResponseField name="message" type="string">
  Response Message. "Success" if successful, others not.
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="details" defaultOpen>
    <ResponseField name="local" type="array">
      <Expandable title="details" defaultOpen>
        <ResponseField name="account_id" type="string">
          ID of the account this balance is associated with.
        </ResponseField>

        <ResponseField name="account_bank_id" type="string">
          ID of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="country_code" type="string">
          Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
        </ResponseField>

        <ResponseField name="currency_code" type="string">
          Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
        </ResponseField>

        <ResponseField name="account_holder" type="string">
          Account holder of the balance.
        </ResponseField>

        <ResponseField name="account_number" type="string">
          Account number of the balance.
        </ResponseField>

        <ResponseField name="clearing_system_type" type="string">
          Clearing system type is one of SG-FAST, RTGS, GIRO, US-ACH, Fedwire, SEPA, Faster Payments, CHAPS, Bacs, Zengin, Bank, FPS, MEPS, SWIFT.
        </ResponseField>

        <ResponseField name="clearing_system_code" type="string">
          Clearing system code is the number of ACH, FEDWIRE, GRIO, SWIFT CODE.
        </ResponseField>

        <ResponseField name="bank_name" type="string">
          Name of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="bank_code" type="string">
          Code of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="bank_address" type="string">
          Address of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="payment_reference" type="string">
          Payment reference used for bank transfers to quote remarks.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="string">
      Status of the account.
    </ResponseField>

    <ResponseField name="swift" type="array">
      <Expandable title="details">
        <ResponseField name="account_id" type="string">
          ID of the account this balance is associated with.
        </ResponseField>

        <ResponseField name="account_bank_id" type="string">
          ID of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="country_code" type="string">
          Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
        </ResponseField>

        <ResponseField name="currency_code" type="string">
          Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
        </ResponseField>

        <ResponseField name="account_holder" type="string">
          Account holder of the balance.
        </ResponseField>

        <ResponseField name="account_number" type="string">
          Account number of the balance.
        </ResponseField>

        <ResponseField name="clearing_system_type" type="string">
          Clearing system type is one of SG-FAST, RTGS, GIRO, US-ACH, Fedwire, SEPA, Faster Payments, CHAPS, Bacs, Zengin, Bank, FPS, MEPS, SWIFT.
        </ResponseField>

        <ResponseField name="clearing_system_code" type="string">
          Clearing system code is the number of ACH, FEDWIRE, GRIO, SWIFT CODE.
        </ResponseField>

        <ResponseField name="bank_name" type="string">
          Name of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="bank_code" type="string">
          Code of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="bank_address" type="string">
          Address of the bank this balance is associated with.
        </ResponseField>

        <ResponseField name="payment_reference" type="string">
          Payment reference used for bank transfers to quote remarks.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL Example Request theme={null}
  curl 'https://api.sandbox.uqpay.org/api/v1/balances/EUR/bank_details' \
  -H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
  -H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
      "code": 200,
      "message": "Success",
      "data": {
      "local": [
          {
              "account_bank_id": "60d33671-0f2d-4353-b3e7-4e3af71408ac",
              "account_holder": "Johnson",
              "account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
              "account_number": "GB01TCCL28232805570870",
              "bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
              "bank_code": "",
              "bank_name": "The Currency Cloud Limited",
              "clearing_system_code": "TCCLGB31",
              "clearing_system_type": "bic swift",
              "country_code": "GB",
              "currency_code": "EUR",
              "payment_reference": "B9637636096"
          }
      ],
      "status": "opened",
      "swift": [
          {
              "account_bank_id": "aca22cc9-04ee-4598-af6b-e3ba696585f5",
              "account_holder": "Johnson",
              "account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
              "account_number": "GB64TCCL12345621576812",
              "bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
              "bank_code": "",
              "bank_name": "The Currency Cloud Limited",
              "clearing_system_code": "TCCLGB3L",
              "clearing_system_type": "bic swift",
              "country_code": "GB",
              "currency_code": "EUR",
              "payment_reference": "B9637636096"
          }
      ]
  }
  }
  ```
</ResponseExample>