Static Addresses
Static deposit addresses are permanent addresses strictly assigned to a specific user by internal_user_id and/or email. All deposits made to a static address trigger webhooks (see Webhooks → Static Address Deposit Webhooks).
Create Static Address
This endpoint creates a new static deposit address strictly assigned to a user by internal_user_id AND/OR email.
POST /api/addresses/v1/static-deposits
Headers
| Header | Value |
|---|---|
Authorization | Bearer YOUR_PUBLIC_TOKEN |
Content-Type | application/json |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
internal_user_id | string | Yes | A unique user ID to which the address will be assigned. If a request is made with an existing ID, the corresponding user and their deposit address will be returned |
email | string | No | A unique user's email address. If a request is made with an existing email, the corresponding user and their deposit address will be returned independently of internal_user_id provided |
asset | string | Yes | The asset for which the address will be created. Values: usdt, usdc, btc, eth, sol, ton, bnb, ltc, trx, bch |
network | string | Yes | The network for which the address will be created. Should correspond to the asset parameter value (see mapping below) |
Asset + Network Mapping
| Asset | Network values |
|---|---|
btc, eth, sol, ton, bnb, ltc, trx, bch | same as asset (e.g., btc → btc) |
usdt | trc20usdt, usdterc20, solusdt, bep20usdt |
usdc | usdc, solusdc, bep20usdc |
cURL
curl --location 'https://my.paidlys.com/api/addresses/v1/static-deposits' \
--header 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '<body>'
Body:
{
"internal_user_id": "user1",
"email": "user1@service.domain",
"asset": "usdt",
"network": "trc20usdt"
}
Response
{
"id": "1f1380ea-e3c4-6960-99ae-7c37e1116bd7",
"internal_user_id": "user06",
"address": "TG2QjmRbdDVKNL2dE8Esyg1K2vFbNdw565",
"asset": "usdt",
"network": "trc20usdt",
"email": null
}
Response Fields
| Field | Description |
|---|---|
id | Address identifier |
internal_user_id | Unique internal user ID provided within the address-creation request |
address | Static deposit address value for the provided user ID and/or email, asset, and network |
asset | Address asset name |
network | Address network name |
email | User's email address. null if not provided within the request |
tag | Address tag for TON-asset addresses. Won't be returned for any other asset |
Get Static Address
This endpoint retrieves an already existing static deposit address.
GET /api/addresses/v1/static-deposits?network={network_name}&{secondary_filter}={filter_value}
Headers
| Header | Value |
|---|---|
Authorization | Bearer YOUR_PUBLIC_TOKEN |
Content-Type | application/json |
Query Parameters
To receive the address info, apply the following filtering options in the request URL with & separator:
network(required) — the network name- Plus one of the secondary filters:
id— address idinternal_user_id— user's internal IDemail+asset— user's email combined with asset
cURL
curl --location 'https://my.paidlys.com/api/addresses/v1/static-deposits?network=trc20usdt&internal_user_id=user1' \
--header 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
--header 'Content-Type: application/json'
Response
Same structure as the Create Static Address response:
{
"id": "1f1380ea-e3c4-6960-99ae-7c37e1116bd7",
"internal_user_id": "user06",
"address": "TG2QjmRbdDVKNL2dE8Esyg1K2vFbNdw565",
"asset": "usdt",
"network": "trc20usdt",
"email": null
}