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.

1. Register - Get an API Key

   POST/create-api-key
   

   Request Body
   {
     "merchant_name": "ABC Brick Suppliers"
   }
   

   Response Body
   {
     "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

   POST /webhook/register
   

   Authorization
   x-api-key string (header)
   
   

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

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

   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"
   }'
   
3. Send a payment

   POST /send-payment
   

   Authorization
   x-api-key string (header)
   
   

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

   Response Body
   {
     "tx_hash": "bfff8eb0ea0759d7ad2f6a4ff393906b585479dab25f558b79349aexxxxxxxxx",
     "amount": 1000,
     "status": "pending"
   }
   

   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
   }'
   
4. Check Transaction Status

   GET /transaction/{tx_hash}
   

   Input
   tx_hash string (path) required
   Authorization
   x-api-key string (header)
   
   

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

   curl -X 'GET' \
     'https://vaayuapi.onrender.com/transaction/f12446efd1f4de5cb2cec1a840c5d0b4a41098875c109cfda94c582740d1a14b' \
     -H 'accept: application/json' \
     -H 'x-api-key: YOUR_API_KEY'
   

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 [e-mail].