# VeliraPay API

A small REST API for charging customers in crypto, checking on their payments and getting told the moment one lands. JSON in, JSON out.

[Make your first test payment](https://velirapay.com/docs/charge-a-customer) [Set up your language](https://velirapay.com/docs/libraries)

Request examples in cURL, PHP, Laravel, Node.js, Python and C#. Pick a language once and every example follows your choice.

- 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

[Download the OpenAPI specification](https://velirapay.com/openapi.json) for endpoint methods, permissions, request fields and response schemas.

## Your first request

Have an owner or admin 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.

```bash
curl 'https://api.velirapay.com/v1/account' \
  --fail-with-body --silent --show-error --max-time 30 \
  -H "Authorization: Bearer ${VELIRAPAY_API_KEY:?Set VELIRAPAY_API_KEY}" \
  -H 'Accept: application/json'
```

The root of the API, https://api.velirapay.com/, answers without a key, with its name, status, version and a link to these pages, which makes it a handy health check.

Working in PHP or Laravel, or selling on WooCommerce? The official libraries and plugin handle authentication, retries and webhook signatures for you. [See the libraries](https://velirapay.com/docs/libraries)

## Charging a customer

To take a payment from a customer, create a charge with POST /v1/charges. Say how much and in which coin, add whatever you already know about the customer and the order, and send them to the checkout_url that comes back. That is the default, and you do not need a payment link for it.

- Use an invoice when the bill is to be paid later, or the customer should choose the coin on our page.
- Use a payment link for one public page many customers pay through, such as a product or a tip jar. Create it once and share it: do not make a new one per customer or per order.

[Charge a customer, step by step](https://velirapay.com/docs/charge-a-customer)

## Find your way around

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

### Getting started

How to charge a customer, the official libraries, then how to authenticate, repeat a request safely, page through a list and read an error.

- [Overview](https://velirapay.com/docs)
- [Charge a customer](https://velirapay.com/docs/charge-a-customer)
- [Libraries](https://velirapay.com/docs/libraries)
- [Authentication](https://velirapay.com/docs/authentication)
- [Idempotency](https://velirapay.com/docs/idempotency)
- [Pagination and filters](https://velirapay.com/docs/pagination)
- [Errors](https://velirapay.com/docs/errors)

### API reference

Every object and endpoint: the account behind your key, the coins on offer, charges, invoices, payment links, coupons, payouts and events.

- [Account](https://velirapay.com/docs/account)
- [Account overview](https://velirapay.com/docs/overview)
- [Supported coins](https://velirapay.com/docs/assets)
- [Charges](https://velirapay.com/docs/charges)
- [Invoices](https://velirapay.com/docs/invoices)
- [Payment links](https://velirapay.com/docs/payment-links)
- [Coupons](https://velirapay.com/docs/coupons)
- [Payouts](https://velirapay.com/docs/payouts)
- [Payout addresses](https://velirapay.com/docs/payout-addresses)
- [Events](https://velirapay.com/docs/events)
- [Activity log](https://velirapay.com/docs/activity)
- [API keys](https://velirapay.com/docs/api-keys)
- [Members](https://velirapay.com/docs/members)

### Webhooks

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

- [Webhooks](https://velirapay.com/docs/webhooks)
- [Verifying signatures](https://velirapay.com/docs/webhooks/signatures)
- [Retries and failures](https://velirapay.com/docs/webhooks/retries)

### Checkout

What the customer sees between opening a page and the money arriving, and how it reaches your wallet.

- [Checkout flow](https://velirapay.com/docs/checkout)
- [Settlement and payouts](https://velirapay.com/docs/settlement)

### AI assistants

Let an assistant charge customers, raise invoices and check what has been paid.

- [MCP server](https://velirapay.com/docs/mcp)