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

# Quickstart

> Receive your first crypto deposit and check your balance in a few API calls.

[Stablecoin Account API Publisher Disclaimer](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)

This guide walks you through the core deposit flow on the sandbox environment: discover which assets you can receive, get a deposit address, and confirm the funds arrived. By the end, you will have exercised the endpoints that every Stablecoin Account integration starts with.

<Info>
  **Prerequisites**

  * A UQPAY sandbox account with Stablecoin Account enabled
  * An API token from the [Access Token](/account-center/v1.6/api-reference/access-token) endpoint, sent as the `x-auth-token` header
</Info>

<Steps>
  <Step title="Check supported assets and networks">
    Ask the system which currencies and networks are available, and whether deposits are currently enabled for each.

    ```bash theme={null}
    curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/config/assets?asset_type=CRYPTO" \
      -H "x-auth-token: YOUR_API_TOKEN" \
      -H "Content-Type: application/json"
    ```

    **Response (abbreviated):**

    ```json theme={null}
    {
      "code": 200,
      "message": "Success",
      "data": [
        {
          "asset": "USDT",
          "asset_name": "Tether USD",
          "asset_type": "CRYPTO",
          "networks": [
            {
              "network": "ETH",
              "network_name": "Ethereum (ERC20)",
              "deposit_enabled": true,
              "withdraw_enabled": true,
              "min_deposit_amount": "10.00",
              "min_withdraw_amount": "20.00",
              "withdraw_precision": 2,
              "estimated_arrival_time": 15
            }
          ]
        }
      ]
    }
    ```

    Pick an asset and network pair with `deposit_enabled: true`, and note the `min_deposit_amount` — deposits below it are not credited.
  </Step>

  <Step title="Get a deposit address">
    Request the deposit address for your chosen asset and network. The address is generated once and stays bound to your account, so you can reuse it for later deposits.

    ```bash theme={null}
    curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/deposit/address?asset=USDT&network=ETH" \
      -H "x-auth-token: YOUR_API_TOKEN" \
      -H "Content-Type: application/json"
    ```

    **Response:**

    ```json theme={null}
    {
      "code": 200,
      "message": "Success",
      "data": {
        "asset": "USDT",
        "network": "ETH",
        "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "qr_code": "https://cdn.uqpaytech.com/qr/...",
        "minimum_deposit": "10.00",
        "create_time": "2024-07-18T14:19:52+08:00"
      }
    }
    ```

    <Warning>
      Send only the matching asset on the matching network to this address. Funds sent as a different token or over a different network cannot be credited automatically.
    </Warning>
  </Step>

  <Step title="Send funds and receive the deposit webhook">
    Transfer the asset to the deposit address from an external wallet. When the system detects the transaction, it creates a deposit order and sends a `ramp.deposit.pending` event to your webhook endpoint, followed by `ramp.deposit.success` once the deposit confirms:

    ```json theme={null}
    {
      "version": "V1.6.0",
      "event_name": "DEPOSIT",
      "event_type": "ramp.deposit.pending",
      "event_id": "38614827-7666-4c0c-abae-cc3abef24903",
      "source_id": "eda7be90-8fbc-444c-b747-542faf5d3e10",
      "data": {
        "amount": "10",
        "currency": "USDC",
        "network": "ETH",
        "order_id": "eda7be90-8fbc-444c-b747-542faf5d3e10",
        "order_status": "Pending",
        "short_order_id": "DP260227-QZOXQND1",
        "from_address": "0x303039d7632c7341c681e889ea0073c3af1a2f6a",
        "txid": "0x65590ef2a2ef1902f3644da38b19eaf4b953831c0deaac73cadce02ee356d5d1",
        "transaction_type": "Deposit",
        "create_time": "2026-02-27 10:19:19 +0800 CST",
        "complete_time": "0001-01-01 00:00:00 +0000 UTC",
        "fee": "0",
        "reason": "test-remark",
        "need_travel_rule": true
      }
    }
    ```

    Use `source_id` (the deposit `order_id`) to look the order up later.

    <Note>
      If the event includes `"need_travel_rule": true`, the deposit needs originator information before it can proceed. See [Travel Rule for deposits](/stablecoin-account/v1.6/guide/travel-rule-for-deposits).
    </Note>
  </Step>

  <Step title="Confirm the deposit and check your balance">
    Retrieve the deposit order by ID, or query your wallet balance for the credited currency.

    ```bash theme={null}
    curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/deposit/eda7be90-8fbc-444c-b747-542faf5d3e10" \
      -H "x-auth-token: YOUR_API_TOKEN" \
      -H "Content-Type: application/json"
    ```

    Once `order_status` is `Success`, the funds appear in your asset wallet:

    ```bash theme={null}
    curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/asset/USDT" \
      -H "x-auth-token: YOUR_API_TOKEN" \
      -H "Content-Type: application/json"
    ```

    **Response:**

    ```json theme={null}
    {
      "code": 200,
      "message": "Success",
      "data": {
        "balance_id": "5e56e5de-f354-4570-8cbc-cc134d7a5b75",
        "balance_currency": "USDT",
        "balance_status": "Active",
        "available_balance": "9100",
        "margin_balance": "0",
        "frozen_balance": "0",
        "create_time": "2025-06-30 17:03:06 +08:00",
        "last_trade_time": "2025-10-24 17:51:24 +08:00"
      }
    }
    ```
  </Step>
</Steps>

## What's next

<CardGroup cols={2}>
  <Card title="Send withdrawals" href="/stablecoin-account/v1.6/guide/send-withdrawals" icon="arrow-up-from-bracket">
    Register a destination address and withdraw funds off-platform.
  </Card>

  <Card title="Convert currencies" href="/stablecoin-account/v1.6/guide/convert-currencies" icon="arrow-right-arrow-left">
    Lock a quote and convert between crypto and fiat.
  </Card>

  <Card title="Transfer funds" href="/stablecoin-account/v1.6/guide/transfer-funds-between-stablecoin-account-and-global-account" icon="building-columns">
    Move fiat to your Global Account.
  </Card>

  <Card title="Core concepts" href="/stablecoin-account/v1.6/guide/core-concepts" icon="book">
    Understand assets, order types, statuses, and idempotency.
  </Card>
</CardGroup>