API reference

Events

Everything that happens to a charge or an invoice is recorded as an event, the same ones your webhook endpoints receive. Read them here to catch up after downtime, to reconcile without a public endpoint, or to show a customer's payment history.

The event object

Field	Type	Description
`id`	string	UUID, the same one the webhook delivery carries. Use it to skip events you have already handled.
`type`	string	One of the event names listed under Webhooks, such as charge.paid.
`details`	object	What changed, for instance the amount received or the transaction id. Empty for events that carry nothing extra.
`charge`	object\|null	The full charge the event is about, or null for invoice events.
`invoice`	object\|null	The full invoice the event is about, or null for charge events.
`created_at`	string	ISO 8601 timestamp in UTC.

See every event name and what it means →

Endpoints

GET /v1/events List events, newest first. Filter with ?type=, ?charge= and ?invoice=.
GET /v1/events/{id} Retrieve one event by its UUID.

curl "https://api.velirapay.com/v1/events?type=charge.paid&per_page=100" \
  -H "Authorization: Bearer vp_live_…"

Webhooks are still the quickest way to hear about a payment; polling this endpoint every minute or so is the belt and braces behind them. Handle both by event id so a payment handled twice is a no-op.