API reference
Waffy API Explorer
A reference for the core external API, built from its OpenAPI specification. It lists the endpoints with their parameters and responses.
What is in it
The reference covers the OAuth token, user sign-up, authorize and link, contracts and their parties and milestones, balances and bank accounts. It is documentation: to send requests use the Postman collection, and authenticate with the tokens described in Authentication. There are no API keys.
- Interactive reference: browse the endpoints and their schemas.
- Integration notes: a plain page with the user and contract flow.
This reference is a subset
It is not updated with every release and does not include newer calls such as consent, payment tickets or settlement. The step-by-step pages under Build a payment and the Postman collection are the current reference.
Where to go next
- Quick start: your first calls in the sandbox.
- Dashboard: your API clients and the Postman environments.
- Integration guides