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

# Create Static Address

> Create a Vanryx receiving address for a supported currency and network pair.

```text theme={null}
POST https://api.vanryx.com/api/v1/payment/static-address
```

Returns a receiving address for a supported currency and network pair. Incoming transactions to the address trigger [webhook callbacks](https://docs.vanryx.com/webhooks.md) with `type: Static`.

## Headers

**Merchant-API-Key** `string` *required*

Your active Vanryx API key. See [API keys and authentication](https://docs.vanryx.com/authentication.md).

**Content-Type** `string`

Use `application/json`. The examples send JSON request bodies.

## Body parameters

**to\_currency** `string` *required*

Maximum 32 characters. Must form a [supported pair](#supported-pairs) with `network`.

**network** `string` *required*

Maximum 32 characters. Must be a supported network paired with `to_currency`.

**auto\_withdrawal** `boolean` (default: false)

Optional address preference.

**callback\_url** `string`

URL that receives [webhook callbacks](https://docs.vanryx.com/webhooks.md) for this address. Maximum 2,048 characters. Must use HTTP or HTTPS and resolve only to public IP addresses.

**email** `string`

Valid email address. Maximum 255 characters.

**order\_id** `string`

Your order reference. Maximum 128 characters.

**label** `string`

Maximum 128 characters.

**description** `string`

Maximum 1,000 characters.

## Supported pairs

| `to_currency` | `network` | Notes |
| - | - | - |
| `BTC` | `BTC` | Bitcoin |
| `LTC` | `LTC` | Litecoin |
| `DOGE` | `DOGE` | Dogecoin |
| `BCH` | `BCH` | Bitcoin Cash |
| `ETH` | `ETH` | Ethereum |
| `BNB` | `BSC` | BSC is presented as BNB on this API pair. |
| `TRON` | `TRON` | Native TRON. `TRX` with network `TRON` is also accepted as an alias. |
| `USDT` | `TRON` | TRON token. |
| `SOL` | `SOL` | Solana |
| `XRP` | `XRP` | The response includes a generated Destination Tag. |
| `USDC` | `ETH` | Ethereum token. |

A valid pair alone does not ensure that an address can be created. The asset must be active, and your Merchant account must have the required account and address setup.

## XRP Destination Tag

> [!WARNING]
>
> For XRP, always show and use the returned `destination_tag` when it is not `null`. The receiving address may be shared, so the payer must include the tag. You do not supply the tag: Vanryx generates it.

## Response

**data** `object`

**properties**

**network** `string`

Network of the address.

**to\_currency** `string`

Currency of the address.

**address** `string`

Receiving address.

**destination\_tag** `integer | null`

Generated Destination Tag for XRP. Use it whenever it is not `null`.

**qr\_code** `null`

Currently `null`. The API does not return a QR image.

**date** `integer`

Creation time.

**message** `string`

Result message.

## Errors

| HTTP status | When |
| - | - |
| `401` | `Missing merchant API Key` or `Invalid or inactive API Key`. |
| `422` | `{"message":"Wrong currency code."}` for an unsupported currency and network pair. |
| `422` | A service message when the Merchant account, active asset, or address setup is unavailable. These messages vary and are not an exhaustive list. |
| `422` | Field validation failed. |

See [Errors and integration notes](https://docs.vanryx.com/errors.md).

```bash cURL theme={null}
curl --request POST \
  --url https://api.vanryx.com/api/v1/payment/static-address \
  --header 'Merchant-API-Key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "to_currency": "XRP",
    "network": "XRP",
    "label": "Online store",
    "order_id": "ORDER-2026-1042",
    "description": "Example order"
  }'
```

```json 200 theme={null}
{
  "data": {
    "network": "XRP",
    "to_currency": "XRP",
    "address": "rExampleSyntheticAddress123456789",
    "destination_tag": 123456789,
    "qr_code": null,
    "date": 1794996400
  },
  "message": "Operation completed successfully!"
}
```

```json 422 theme={null}
{
  "message": "Wrong currency code."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.