Skip to main content

API Reference

The public payments API for frontend developers, organised by feature rather than by the backend service that happens to serve each endpoint.

Everything here is reached through the payments proxy: your session-authenticated calls go to https://<host>/institution/payments/*, which projectx forwards to the payments backend (and, for some features, on to account-events-service). You never call the backend services directly, and you never send account or sub-account ids — scoping is resolved server-side.

Some features are proxied to account-events-service, which owns their data and schema. The proxy rewrites the route, so the path you call (e.g. /institution/payments/collect/schedules) is not the account-events path. Each proxied feature below says so and points at the owning service — but the request/response contract shown is the one you actually call.

For VALR-internal operator APIs and service-to-service endpoints, see Admin API and Internal API.

Want the whole surface as one file? Download the Web API OpenAPI spec (Postman / code generation).