API reference

Payments

Endpoints and input schemas from the console's API registry.

GET /api/payments

List payments received

Needs the payments.read permission on the API key's role.

No request-body schema is supplied for this operation in the registry.

Documented responses

  • 200 — OK
  • 400 — The body is not valid; `error` says why
  • 401 — No valid API key
  • 403 — The key's role lacks the permission, or the module is off

Other policy and state errors may also apply. See API key permissions and limits and the complete OpenAPI document.