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

# Quick start

> The sandbox end to end: from your sandbox key to a paid QR, in order.

Every call goes to `https://api.staging.rampapay.com/v1` with your key in `X-API-Key`. Ask your Rampa contact for the Postman collection that runs these steps.

```bash theme={null}
export BASE="https://api.staging.rampapay.com/v1"
export RAMPA_API_KEY="rpk_..."   # from Rampa, server-side only
```

**1. Read your wallet**

[`GET /wallets`](/api-reference/wallet/get-wallet): your balance and `top_up_addresses`, your Tron address at Rampa.

**2. Set up a test wallet, once**

A Tron wallet on the Shasta testnet that you control (TronLink works), with a little Shasta TRX for network fees from any public Shasta faucet. To see the test tokens in it, add the sandbox test token (contract `TYR7yDZAns63L8Cmu4EyPPxDgktq9sguvB`) as a custom token, 2 decimals; your wallet may show it under its own name. Each token is credited as 1 USDT.

**3. Get test tokens**

[`POST /sandbox/faucet`](/api-reference/wallet/faucet) with your test wallet's address. It sends to your wallet, never to your top-up address.

**4. Top up**

From your test wallet, send the tokens to your top-up address. This step happens outside the API, just like a real deposit.

**5. Wait for the credit**

[`GET /wallets/transactions?direction=in`](/api-reference/wallet/list-transactions) shows the top-up as `pending` within seconds, then `completed` once it confirms — usually within a minute or two. Or wait for the `deposit.credited` webhook.

**6. Get a test QR**

[`POST /sandbox/qr-codes`](/api-reference/payouts/sandbox-qr-code) with a small amount, for example `10.00`. Sandbox only: in production your end user scans a merchant's QR.

**7. Read it**

[`POST /payouts/qr/resolve`](/api-reference/payouts/resolve-qr) with `qr.content`: who it pays, how much, and an `id` (`qrr_…`).

**8. Quote**

[`POST /fx/quotes`](/api-reference/payouts/create-fx-quote) with `target_amount` the QR's amount and `resolution_id` that `id`. Show `source.amount`: the quote is valid for up to 3 minutes.

**9. Pay**

[`POST /payouts`](/api-reference/payouts/create-payout) with your `transaction_id`, the QR and the `quote_id`. It answers `completed`, or why not.

**10. Check**

[`GET /wallets/transactions`](/api-reference/wallet/list-transactions): `payout_held`, then `payout_settled`, and your balance down by exactly `source.amount`.


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