Skip to main content
All authenticated requests to the Vaayu API use an API key.

API keys

An API key identifies your application when it calls Vaayu. Create a key using the API key registration endpoint:

Request

Response

The API key is a credential. Store it securely and do not expose it in browser code, mobile apps, or public repositories.

Send the API key

Include the API key in the x-api-key header for every authenticated request.
For example, a balance request can be authenticated like this:

Authentication errors

If the API key is missing or invalid, the API returns:
Example response:

Keep your API key secure

  • Store API keys in environment variables or a secure secret manager.
  • Never put a server API key in client-side JavaScript.
  • Never commit API keys to GitHub.
  • Use separate credentials for development and production when available.
  • Rotate a key immediately if you believe it has been exposed.

Quickstart

Ready to make your first request?

Start with Quickstart

Create a key, register a webhook, send a sandbox payment, and check its status.

API Reference

See the available endpoints and request formats.