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

# Quickstart - Try Vaayu in 5 minutes

### Sandbox environment

You are using Vaayu's sandbox. Payments are executed using testnet funds through a Vaayu test wallet. The wallet\_address in the request specifies the recipient; it does not specify the funding wallet.

**Do not use real funds or production credentials.**

Where do I run these commands?

Copy the cURL examples below and run them in your terminal. On Windows, use Command Prompt or PowerShell. On macOS/Linux, use Terminal.

<Steps>
  <Step title="Register - Get an API Key">
    ```http theme={null}
    POST/create-api-key
    ```

    ```json theme={null}
    Request Body
    {
      "merchant_name": "ABC Brick Suppliers"
    }
    ```

    ```json theme={null}
    Response Body
    {
      "merchant_name": "ABC Brick Suppliers",
      "api_key": "YOUR_API_KEY"
    }
    ```

    ```json theme={null}
    curl -X 'POST' \
      'https://vaayuapi.onrender.com/create-api-key' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
      "merchant_name": "ABC Brick Suppliers"
    }'
    ```
  </Step>

  <Step title="Register a Webhook">
    ```http theme={null}
    POST /webhook/register
    ```

    ```http theme={null}
    Authorization
    x-api-key string (header)

    ```

    ```json theme={null}
    Request Body
    {
      "webhook_url": "https://webhook.site/4e755244-2d0a-49c8-9c12-72a1c7a3b7f3"
    }

    ```

    ```json theme={null}
    Successful Response Body
    {
      "success": true,
      "message": "Webhook registered successfully",
      "webhook_url": "https://webhook.site/4e755244-2d0a-49c8-9c12-72a1c7a3b7f3"
    }
    ```

    ```json theme={null}
    curl -X 'POST' \
      'https://vaayuapi.onrender.com/webhook/register' \
      -H 'accept: application/json' \
      -H 'x-api-key: YOUR_API_KEY' \
      -H 'Content-Type: application/json' \
      -d '{
      "webhook_url": "https://webhook.site/4e755244-2d0a-49c8-9c12-72a1c7a3b7f3"
    }'
    ```
  </Step>

  <Step title="Send a payment">
    ```http theme={null}
    POST /send-payment
    ```

    ```http theme={null}
    Authorization
    x-api-key string (header)

    ```

    ```json theme={null}
    Request Body
    {
      "wallet_address": "0x7E9B85417beC02A0Ef03A01c5973526xxxxxxxxx",
      "amount": 1000
    }

    ```

    ```json theme={null}
    Response Body
    {
      "tx_hash": "bfff8eb0ea0759d7ad2f6a4ff393906b585479dab25f558b79349aexxxxxxxxx",
      "amount": 1000,
      "status": "pending"
    }
    ```

    ```json theme={null}
    curl -X 'POST' \
      'https://vaayuapi.onrender.com/send-payment' \
      -H 'accept: application/json' \
      -H 'x-api-key: YOUR_API_KEY' \
      -H 'Content-Type: application/json' \
      -d '{
      "wallet_address": "0x7E9B85417beC02A0Ef03A01c5973526xxxxxxxxx",
      "amount": 1000
    }'
    ```
  </Step>

  <Step title="Check Transaction Status">
    ```http theme={null}
    GET /transaction/{tx_hash}
    ```

    ```http theme={null}
    Input
    tx_hash string (path) required
    Authorization
    x-api-key string (header)

    ```

    ```json theme={null}
    Response Body
    {
      "tx_hash": "f12446efd1f4de5cb2cec1a840c5d0b4a41098875c109cfda94c582740d1a14b",
      "amount": 1000000,
      "status": "confirmed",
      "webhook_delivered": true,
      "retry_count": 0
    }
    ```

    ```json theme={null}
    curl -X 'GET' \
      'https://vaayuapi.onrender.com/transaction/f12446efd1f4de5cb2cec1a840c5d0b4a41098875c109cfda94c582740d1a14b' \
      -H 'accept: application/json' \
      -H 'x-api-key: YOUR_API_KEY'
    ```
  </Step>
</Steps>

<Tip>
  Give people a way to get help. This could be a link to a support page, a chat with a customer support agent, or a forum for your product.

  Example: Need help? Reach out to us at [support@yourcompany.com](mailto:support@yourcompany.com).
</Tip>