List payments
Returns payments, newest first, for a date range. Needs payments:read. Voided and declined payments are left
out unless you add includeVoided=true, and Card and Credit Card count as the same method.
bearerAuthAuthorizationBearer <api_key>branchId?stringString. One branch id from List branches. A branch outside the key's branch list returns 403 branch_forbidden; an id that is not in your company returns 404. Left out: every branch the key can read.
^[A-Za-z0-9_-]{1,128}$from?stringDate YYYY-MM-DD (a London day) or an ISO-8601 date-time with offset. Start of the range, included. Left out: 6 days before to.
to?stringDate YYYY-MM-DD (a London day, included) or an ISO-8601 date-time with offset (excluded). End of the range, at most 92 days after from. Left out: today in London.
method?stringString. Only payments with this method name, case-insensitive, such as Cash, Card or Online. Card and Credit Card both return all card payments. Left out: every method.
length <= 64includeVoided?booleanBoolean. true adds voided records to the list. Left out: false.
falselimit?integerInteger, 1 to 200. Records per page. Left out: 50.
1 <= value <= 20050cursor?stringString. pagination.nextCursor from the previous page, sent with the same filters. Left out: the first page.
length <= 2048include?"card"card. Adds the card provider and last four digits to each payment. Left out: no card details.
"card"A page of payments
application/json- response
data*array<>pagination*meta*curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/payments?branchId=YOUR_BRANCH_ID&from=2026-11-11&to=2026-11-11&method=Card&includeVoided=false&limit=50&include=card'{ "data": [ { "id": "pubapiPay002", "transactionId": "YOUR_TRANSACTION_ID", "branchId": "YOUR_BRANCH_ID", "method": "Card", "amount": 24, "tipAmount": 2.4, "change": 0, "currency": "GBP", "currencySource": "payment", "createdAt": "2026-11-11T19:42:08.000Z", "status": "completed", "isVoid": false, "isDeclined": false, "isRefunded": false, "refundedAmount": 0 } ], "pagination": { "limit": 50, "hasMore": true, "nextCursor": "eyJ2IjoxLCJyIjoicGF5bWVudHMifQ.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" }}