Before you call an endpoint
Three things apply to every request, and each has its own page.Request and response conventions
These hold across every domain and every operation.Listing collections
Pagination
Collection endpoints take the same two query parameters.
Every paginated response carries the same envelope:
items and meta are always present. total counts the records matching your filters, not the records on the page, so the number of pages is total divided by per_page, rounded up.
Walking a collection with a large per_page costs fewer requests than many small pages, which is what Rate limits & Caching asks you to do.
Sorting
Where an endpoint supports ordering, it exposes a singlesort query parameter. Prefix the field with - to sort descending:
Filtering
Filters are query parameters named after the field they match. Three patterns recur.
Different filters combine with
AND. A filter that accepts several values, such as type on Rewards, matches any of them. Each operation page lists the ones it accepts.
Error responses
Failures raised by the application return the same problem-details envelope, whatever the endpoint. Throttling and gateway responses can arrive without it, so branch on the HTTP status first. The status codes, the Paylead error codes and the retry rules are on Errors; throttling and caching are on Rate limits & Caching.What’s next
Integration guidelines
Why Paylead ships no SDK, what the specification is safe to use for, and how to read its sample values.
Versions & Download
Browse every published version and download the raw OpenAPI specs.