Quick Start
Create an API key and read your first transactions in a few minutes.
This takes about five minutes. You need access to the Yuze dashboard as the account owner, or as a user with the Company permission.
Create a key
In the Yuze dashboard, go to Company, then API, and choose Create key. Name it after the tool it is for, tick transactions:read, and create it.
Copy the key straight away. It is shown once and Yuze cannot show it again. See API keys for every access level.
Check the key works
GET /v1/me needs no access, so it is the quickest check. It returns the key's name, branches and access.
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/me"A 401 means the key is wrong, expired or revoked. A 403 means it lacks the access that endpoint needs. API keys lists every code.
Read transactions
Ask for one day, one transaction.
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/transactions?from=2026-11-11&to=2026-11-11&limit=1"You get a page of results, a cursor for the next page, and the date range Yuze applied:
{
"data": [
{
"id": "YOUR_TRANSACTION_ID",
"transactionNo": "1042",
"branchId": "YOUR_BRANCH_ID",
"platform": "pos",
"orderType": "dine_in",
"status": "completed",
"isVoid": false,
"isRefunded": false,
"createdAt": "2026-11-11T19:42:10.000Z",
"updatedAt": null,
"currency": "GBP",
"subTotal": 24,
"totalPrice": 26.4,
"refundedAmount": 0,
"netTotal": 26.4,
"amountPaid": 24,
"tipAmount": 2.4,
"paymentMethods": ["Card"],
"discount": null,
"covers": 2,
"tableName": "Table 4"
}
],
"pagination": { "limit": 1, "hasMore": true, "nextCursor": "eyJ2IjoxLCJyIjoidHJhbnNhY3Rpb25zIn0.c2lnbmF0dXJl" },
"meta": {
"requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f",
"range": {
"from": "2026-11-11T00:00:00.000Z",
"to": "2026-11-12T00:00:00.000Z",
"fromInput": "2026-11-11",
"toInput": "2026-11-11",
"timezone": "Europe/London",
"toIsExclusive": true
},
"branchIds": "all"
}
}Get the next page
When pagination.hasMore is true, send pagination.nextCursor back as cursor with the same filters. Keep going until hasMore is false. Conventions explains dates, amounts and cursors.
Before release
The base URL above is the planned production address. Yuze will confirm the final address before keys are issued.