Invoices & payments

List payments

GET /api/v1/payments

Payments received against your institution’s invoices.

You need an institution key with the invoices:read scope. Your administrator makes one in Settings › API access.

Parameters

from

date · optional

Earliest payment date, YYYY-MM-DD.

to

date · optional

Latest payment date, YYYY-MM-DD.

invoice_id

string · optional

Only payments of this invoice.

page

integer · optional

Page number. Default 1.

page_size

integer · optional

Results per page, up to 100. Default 25.

updated_since

datetime · optional

Only records changed at or after this ISO 8601 time, for example 2026-10-27T00:00:00Z.

from

invoice_id

page

page_size

updated_since

Sample data only; nothing is sent. Have a key? Sign in to try it on real data.

401 invalid_key

The key is missing, unknown, revoked or expired.

403 ip_not_allowed

The request came from an address the key is not allowed to use.

429 rate_limited

Too many requests this minute. Wait for Retry-After seconds.

429 quota_exceeded

The monthly allowance is used up. It resets on the first of the month.

403 wrong_key

This is a comparables key. Use an institution key for this endpoint.

403 api_not_enabled

API access isn’t switched on for your institution.

403 not_in_plan

This API isn’t part of your institution’s plan. Ask ValueApps to add it.

403 insufficient_scope

The key doesn’t have the access this call needs.