Every review, grade, rate and fee we publish, over HTTP. The catalogue is public and needs no key.
Full endpoint reference · OpenAPI document
All endpoints are relative to https://api.paymentreview.com/v1.
curl https://api.paymentreview.com/v1/reviews?limit=5
Reading the catalogue needs no credentials. A key is only needed for your own records — it authenticates as your account, carries exactly your permissions, and cannot change a review. Generate one at app.paymentreview.com/connect/.
curl https://api.paymentreview.com/v1/edit-suggestions \ -H "Authorization: users API-Key YOUR_KEY"
The users prefix is part of the value, not a typo — it names the collection the key belongs to.
List endpoints take limit (default 10, max 100) and page, and return the documents in docs alongside totalDocs, totalPages, hasNextPage and hasPrevPage.
Filters use bracket syntax. Documented filters are where[slug][equals], where[grade][equals] and where[type][equals]. The server currently accepts more than that; anything not in the reference is unsupported and may change without notice.
Results can also be sorted with sort, one of companyName, -companyName, updatedAt or -updatedAt.
curl "https://api.paymentreview.com/v1/reviews?where[grade][equals]=A%2B&sort=companyName"
Published reviews only. Drafts and unpublished listings are filtered out for every caller, keyed or not.
Failures return the matching HTTP status and a JSON body of the form { "errors": [{ "message": "..." }] }. A missing or invalid key gives 403; an unknown id gives 404.
None enforced today. Be reasonable, set a descriptive User-Agent, and we will tell you here before that changes.