> For the complete documentation index, see [llms.txt](https://docs.aquanow.io/aquanow/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aquanow.io/aquanow/api-endpoints-or-v2.0/funding-api/get-deposit-instructions.md).

# Get Deposit Instructions

Retrieves the specific fiat or crypto deposit instruction to deposit funds into your platform account.

Behavior: The type of instructions returned depends on your parameters:

1. Fiat Mode: If you provide a fiat `currency` (e.g., "USD") and omit `networkSymbol`, it returns bank wire instructions.
2. Crypto Mode: If you provide `currency` (e.g., "USDC") and include `networkSymbol` (e.g., "ETH"), it returns a crypto deposit address.

{% hint style="info" %}
The Get Deposit Instructions endpoint will automatically create a deposit address for the coin and network specified if it doesn't already exist.
{% endhint %}

## Get Deposit Fiat Instructions

Retrieve deposit bank instructions with optional filtering.

<mark style="color:blue;">`GET`</mark> `https://api.aquanow.io/accounts/v2/depositInstructions`

#### Query Parameters

| Name      | Type   | Description                                                                                                 |
| --------- | ------ | ----------------------------------------------------------------------------------------------------------- |
| accountId | String | Required. Used to retrieve the bank instructions configured for the specified account (e.g., "CA1000897R"). |
| currency  | String | Required. The fiat currency that the client is looking to deposit into. (e.g., "USD")                       |

#### Headers

| Name                                          | Type   | Description                                                                                                                                                        |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-api-key<mark style="color:red;">\*</mark>   | String | <p><code>{{x-api-key}}</code></p><p>API Auth Key</p>                                                                                                               |
| x-signature<mark style="color:red;">\*</mark> | String | <p><code>32c92660f65cbb78d0eaf9a4361fb6b0a2cb8bb4c40f531e9974a0afc12d9a328b5ff621w544d242ee9ba1dfa799c85a</code></p><p>Signature created using your API secret</p> |
| x-nonce<mark style="color:red;">\*</mark>     | String | <p><code>1657731573930</code></p><p>Timestamp in millisecond</p>                                                                                                   |

#### Response

{% tabs %}
{% tab title="200: OK" %}

```json
{
  "accountId": "CA2595342R",
  "currency": "USD",
  "updatedAt": "2024-06-01T14:22:45.123Z",
  "beneficiaryLegalName": "James B. Holdings Ltd.",
  "beneficiaryBankName": "Toronto-Dominion Bank",
  "beneficiaryAddress": {
    "addressLine1": "100 King Street West",
    "addressLine2": "Suite 5700",
    "city": "Toronto",
    "region": "ON",
    "postalCode": "M5X 1C9",
    "country": "CA"
  },
  "beneficiaryAccountNumber": "000123456789",
  "beneficiaryBankBic": "TDOMCATTTOR",
  "beneficiaryRoutingCode": "026009593",
  "beneficiaryBankMemo": "Invoice #INV-20240601",
  "beneficiaryBankAddress": {
    "addressLine1": "55 King Street West",
    "addressLine2": "Floor 3",
    "city": "Toronto",
    "region": "ON",
    "postalCode": "M5H 1J9",
    "country": "CA"
  },
  "intermediaryBankName": "Bank of America N.A.",
  "intermediaryAccountNumber": "987654321000",
  "intermediaryBankBic": "BOFAUS3NXXX",
  "intermediaryBankAddress": {
    "addressLine1": "222 Broadway",
    "addressLine2": "Floor 2",
    "city": "New York",
    "region": "NY",
    "postalCode": "10038",
    "country": "US"
  }
}
```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="404: Not found" %}

```json
{
    "message": "No fiat instruction found"
}
```

{% endtab %}
{% endtabs %}

## Get Crypto Deposit Instructions

Get Crypto Deposit Instructions

<mark style="color:blue;">`GET`</mark> `https://api.aquanow.io/accounts/v2/depositInstructions`

#### Query Parameters

| Name            | Type   | Description                                                                                                                                                                                                                                                                                                          |
| --------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId`     | String | Required. Used to retrieve the crypto instructions configured for the specified account (e.g., "CA1000897R").                                                                                                                                                                                                        |
| `currency`      | String | Required. The asset ticker or fiat currency that the client is looking to deposit. For crypto: e.g., "BTC", "ETH", "AAVE", "USDC", etc. The supported assets are available on the [Supported Assets and Tickers](https://docs.aquanow.io/aquanow/integration-guide/supported-assets-and-tickers) page.               |
| `networkSymbol` | String | Required for crypto deposits. The network symbol that the client is looking to deposit funds into (e.g., "BTC", "ETH", "TRON", "TRX", "SOL", etc.). The supported networks are available on the [Supported Assets and Tickers](https://docs.aquanow.io/aquanow/integration-guide/supported-assets-and-tickers) page. |

**Note**: If `networkSymbol` is provided, the endpoint will return crypto deposit instructions. If `networkSymbol` is not provided and `currency` is a supported fiat currency, the endpoint will return fiat bank instructions.

#### Headers

| Name                                          | Type   | Description                                                                                                                                                        |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-api-key<mark style="color:red;">\*</mark>   | String | <p><code>{{x-api-key}}</code></p><p>API Auth Key</p>                                                                                                               |
| x-signature<mark style="color:red;">\*</mark> | String | <p><code>32c92660f65cbb78d0eaf9a4361fb6b0a2cb8bb4c40f531e9974a0afc12d9a328b5ff621w544d242ee9ba1dfa799c85a</code></p><p>Signature created using your API secret</p> |
| x-nonce<mark style="color:red;">\*</mark>     | String | <p><code>1657731573930</code></p><p>Timestamp in millisecond</p>                                                                                                   |

#### Response

{% tabs %}
{% tab title="200: OK" %}

```json
{
  "accountId": "CA2595342R",
  "currency": "BTC",
  "networkSymbol": "BTC",
  "updatedAt": "2024-06-01T14:22:45.123Z",
  "depositAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}
```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="403: Invalid accountId" %}

```
{
    "message": "Invalid accountId"
}
```

{% endtab %}

{% tab title="400: Network not support" %}

```json
{
    "message": "Asset ${assetUpper} does not support network ${network}. Please check supported networks for this asset."
}
```

{% endtab %}
{% endtabs %}

**Response Fields:**

| Field Name               | Data Type | Description                                                                                                                               | Required/Optional |
| ------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| `accountId`              | string    | Account ID for which the instructions are returned                                                                                        | Required          |
| `currency`               | string    | Returns the asset ticker that the user is looking to deposit (e.g., "BTC", "ETH", "USDC", "AAVE")                                         | Required          |
| `networkSymbol`          | string    | Returns the network that the client is looking to deposit funds into (e.g., "BTC", "ETH", "TRON", "TRX", "SOL")                           | Required          |
| `updatedAt`              | string    | The timestamp of when the deposit instructions were last updated, in ISO 8601 UTC format                                                  | Required          |
| `depositAddress`         | string    | Returns the deposit address that the client can use to deposit funds                                                                      | Required          |
| `depositCurrencyTagMemo` | string    | Only returns for networks that support currency/memo, such as XRP, XLM. Returns the currency tag/memo that the client is required to send | Optional          |