Retrieve a transaction

GET

/v1/transactions/{id}

GET

/v1/transactions/{id}

Returns one transaction with its line items, and its payments when the key also has payments:read. Needs transactions:read. A transaction in a branch the key cannot read returns 404, as if it did not exist.

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?string

Comma-separated list of unit_cost, discount_code, card. Adds line item unitCost, discount.code, and the card provider and last four digits on payments (card needs payments:read). Left out: none of them.

Response Body

The transaction

application/json

response

data*

meta*

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/transactions/YOUR_TRANSACTION_ID?include=unit_cost%2Cdiscount_code'

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/transactions/YOUR_TRANSACTION_ID?include=unit_cost%2Cdiscount_code'

Example ResponseSchema

{
  "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",
    "items": [
      {
        "id": "YOUR_TRANSACTION_ID_L1",
        "transactionId": "YOUR_TRANSACTION_ID",
        "branchId": "YOUR_BRANCH_ID",
        "name": "Margherita Pizza",
        "productId": "prod_margherita",
        "variantId": null,
        "categoryId": "cat_mains",
        "quantity": 2,
        "unitPrice": 10,
        "currency": "GBP",
        "taxRate": 0.2,
        "discount": null,
        "discountTotal": 0,
        "lineTotal": 20,
        "netLineTotal": 20,
        "modifiers": [],
        "isVoid": false,
        "isComp": false,
        "createdAt": "2026-11-11T19:31:02.000Z"
      },
      {
        "id": "YOUR_TRANSACTION_ID_L2",
        "transactionId": "YOUR_TRANSACTION_ID",
        "branchId": "YOUR_BRANCH_ID",
        "name": "Cola",
        "productId": "prod_cola",
        "variantId": null,
        "categoryId": "cat_drinks",
        "quantity": 2,
        "unitPrice": 2,
        "currency": "GBP",
        "taxRate": 0.2,
        "discount": null,
        "discountTotal": 0,
        "lineTotal": 4,
        "netLineTotal": 4,
        "modifiers": [],
        "isVoid": false,
        "isComp": false,
        "createdAt": "2026-11-11T19:31:05.000Z"
      }
    ],
    "payments": [
      {
        "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
      }
    ]
  },
  "meta": {
    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"
  }
}

{  "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",    "items": [      {        "id": "YOUR_TRANSACTION_ID_L1",        "transactionId": "YOUR_TRANSACTION_ID",        "branchId": "YOUR_BRANCH_ID",        "name": "Margherita Pizza",        "productId": "prod_margherita",        "variantId": null,        "categoryId": "cat_mains",        "quantity": 2,        "unitPrice": 10,        "currency": "GBP",        "taxRate": 0.2,        "discount": null,        "discountTotal": 0,        "lineTotal": 20,        "netLineTotal": 20,        "modifiers": [],        "isVoid": false,        "isComp": false,        "createdAt": "2026-11-11T19:31:02.000Z"      },      {        "id": "YOUR_TRANSACTION_ID_L2",        "transactionId": "YOUR_TRANSACTION_ID",        "branchId": "YOUR_BRANCH_ID",        "name": "Cola",        "productId": "prod_cola",        "variantId": null,        "categoryId": "cat_drinks",        "quantity": 2,        "unitPrice": 2,        "currency": "GBP",        "taxRate": 0.2,        "discount": null,        "discountTotal": 0,        "lineTotal": 4,        "netLineTotal": 4,        "modifiers": [],        "isVoid": false,        "isComp": false,        "createdAt": "2026-11-11T19:31:05.000Z"      }    ],    "payments": [      {        "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      }    ]  },  "meta": {    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"  }}

Retrieve a transaction

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Query Parameters

Response Body