Yuze API Docs
Read your Yuze transactions, payments, branches and reports over HTTP with a read-only API key, or let an AI assistant read them for you.
Start here
Quick Start
Create a key and make your first request in a few minutes.
API keys
Create a key, send it, and what a 401 or 403 means.
API reference
One page per endpoint, with a request and a response you can try.
Use MCP with AI tools
Connect Claude, Cursor or another assistant to your Yuze data.
Go deeper
Conventions
London dates, amounts in pounds, cursors, include and the error shape.
Postman
Import the collection and send a request without writing code.
Transactions
List transactions, and read their line items and payments.
Reports
Sales summary, product sales and takings by payment type.
Two journeys
| You are | Read |
|---|---|
| A developer or partner building an integration | Quick Start, Conventions, API reference |
| A merchant owner or manager connecting a tool | API keys, MCP, Postman |
Both journeys meet at the same contract: a key created in the Yuze dashboard decides exactly what the API returns.