Quickstart

Make your first Vaayu sandbox payment in about five minutes.

Build your first Vaayu integration using the sandbox environment.

Sandbox environment: Payments currently use testnet infrastructure and a Vaayu test wallet. Do not use real funds or production credentials.

What you’ll build

By the end of this guide, you will have:

1. An API key
2. A registered webhook
3. A submitted payment
4. A way to check the payment status

1. Register and get an API key

   Create a merchant account and receive an API key.

   POST /create-api-key
   

   {
     "merchant_name": "ABC Brick Suppliers"
   }
   

   {
     "merchant_name": "ABC Brick Suppliers",
     "api_key": "YOUR_API_KEY"
   }
   

   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"
     }'
   
2. Register a webhook

   Register the endpoint where your application should receive payment notifications.

   POST /webhook/register
   

   x-api-key: YOUR_API_KEY
   

   {
     "webhook_url": "https://your-server.example/webhook"
   }
   

   {
     "success": true,
     "message": "Webhook registered successfully",
     "webhook_url": "https://your-server.example/webhook"
   }
   
3. Send a payment

   Submit a sandbox payment to a recipient wallet.

   POST /send-payment
   

   x-api-key: YOUR_API_KEY
   

   {
     "wallet_address": "0x7E9B85417beC02A0Ef03A01c5973526xxxxxxxxx",
     "amount": 1000
   }
   

   {
     "tx_hash": "bfff8eb0ea0759d7ad2f6a4ff393906b585479dab25f558b79349aexxxxxxxxx",
     "amount": 1000,
     "status": "pending"
   }
   
4. Check transaction status

   Query the transaction using its transaction hash.

   GET /transaction/{tx_hash}
   

   x-api-key: YOUR_API_KEY
   

   {
     "tx_hash": "f12446efd1f4de5cb2cec1a840c5d0b4a41098875c109cfda94c582740d1a14b",
     "amount": 1000000,
     "status": "confirmed",
     "webhook_delivered": true,
     "retry_count": 0
   }
   

What’s next?

Explore the API reference for individual endpoints, or learn how Vaayu webhooks work.