Skip to Content
YuzeDocs
Transactions

List a transaction's payments

GET
/v1/transactions/{id}/payments

Returns every payment taken against one transaction, oldest first, including voided and declined ones. Needs payments:read. A tip added after the bill was paid shows as its own payment with amount 0.

Authorization

bearerAuth
headerAuthorizationBearer <api_key>

Path Parameters

id*string

String. The transaction id from List transactions.

Match^[A-Za-z0-9_-]{1,128}$

Query Parameters

include?"card"

card. Adds the card provider and last four digits to each payment. Left out: no card details.

Value in"card"

Response Body

Payments, oldest first

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/transactions/YOUR_TRANSACTION_ID/payments?include=card'
Example Response
{  "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,      "card": {        "provider": "visa",        "last4": "4242"      }    }  ],  "meta": {    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"  }}

List a transaction's line items GET

Previous Page

List transactions GET

Next Page