Getting started

VeliraPay API

A small REST API for creating payment links and charges, checking their status and getting told the moment a payment lands. JSON in, JSON out.

  • Base URL https://api.velirapay.com/v1
  • Format JSON request bodies and responses, UTF-8
  • Rate limit 120 requests per minute per key
  • Versioning The version is in the path; breaking changes get a new one

Your first request

Create an API key under Developers → API keys, send it as a bearer token, and ask the API which account it belongs to and what it can be paid in.

curl https://api.velirapay.com/v1/account \
  -H "Authorization: Bearer vp_live_…" \
  -H "Accept: application/json"

Find your way around

Every page below is one topic. The sidebar keeps them within reach wherever you are.

Getting started

How to authenticate, repeat a request safely, page through a list and read an error.

API reference

Every object and endpoint: the account behind your key, payment links, charges, invoices and events.

Webhooks

Get told the moment a payment lands, prove the delivery came from us, and survive a receiver that is down.

Checkout

What the customer sees between opening a link and the money arriving.

AI assistants

Let an assistant raise invoices, make payment links and check what has been paid.

Ready to build?

Create an account, add an API key and a webhook endpoint, and send yourself a test event. Everything here is free during the beta.

Create a free account