Getting started

Pagination and filters

Every list endpoint returns the newest records first, 25 at a time. Ask for another page with ?page= and another size with ?per_page= (1 to 100). Alongside data you get Laravel's meta and links objects, so you can walk the pages without counting yourself.

GET https://api.velirapay.com/v1/charges?status=paid&per_page=50&page=2

{
  "data": [ … ],
  "links": { "first": "…", "last": "…", "prev": "…", "next": null },
  "meta": { "current_page": 2, "last_page": 2, "per_page": 50, "total": 63 }
}

Records created while you page are not skipped: ordering is by id descending, so a new record appears on page 1 rather than shifting the rest.

Filters

Each list endpoint takes the filters that make sense for it, and they combine with paging.

GET /v1/charges Filter with ?status= and ?payment_link=.
GET /v1/invoices Filter with ?status=.
GET /v1/events Filter with ?type=, ?charge= and ?invoice=.