v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Order and Pay

Order Notification

What your webhook implementation will receive when placing an order

postWebhookapeOrder notification

Payload

reasonstring

Reason for failure if applicable.

thirdPartyReferencestring

Third-party reference you provided when the order or payment was placed.

businessLocationIdinteger

The unique identifier for the business location.

ikentooAccountIdentifierstring

The K-series account identifier for a SUCCESS event (V3 format)

iKentooAccountIdinteger

The K-series account identifier for a SUCCESS event (V2 format)

Status of the order operation.

typestring

Notification type

Example payload

{
  "businessLocationId": 45454565682155,
  "account": {
    "clientCount": 4,
    "uuid": "a3bb189e-8f29-4cce-b0e9-f29b123dfe3d",
    "openDate": "2021-06-21T14:20:00Z",
    "closeDate": "2021-06-22T10:15:00Z",
    "paidAmount": 100,
    "serviceCharge": 10,
    "name": "ORDER A1C2E",
    "currentAmount": 110,
    "staffName": "Jane Smith",
    "staffId": 7701234,
    "salesEntries": [
      {
        "id": 1341648999023061,
        "uuid": "2c83b049-a2c1-4bc5-8479-eb152e5a54be",
        "itemName": "Burger",
        "itemSku": "14",
        "unitAmount": 10,
        "quantity": 1,
        "modifiers": [
          {
            "name": "Rare",
            "quantity": 1
          }
        ],
        "amountWithTax": 11.5,
        "amountLessTax": 10,
        "timeOfTransactionUtc": "2023-11-07T21:24:44.741+0000",
        "active": true,
        "subLineItems": [
          {
            "id": 1341648999023062,
            "uuid": "2c83b049-a2c1-4bc5-8479-eb152e5a54be",
            "itemName": "Extra Cheese",
            "itemSku": "35",
            "unitAmount": 1,
            "quantity": 1,
            "modifiers": [],
            "amountWithTax": 1.15,
            "amountLessTax": 1,
            "discountedAmount": 0,
            "grossUnitAmount": 1,
            "timeOfTransactionUtc": "2023-11-07T21:24:44.755+0000",
            "active": true,
            "subLineItems": [],
            "taxIncluded": false
          }
        ]
      }
    ],
    "paymentEntries": [
      {
        "paymentMethodDescription": "API Payment",
        "externalReference": "12345678901234",
        "paymentMethodCode": "APM",
        "amountPaid": 12.65,
        "paymentDate": "2023-11-07T22:05:16.127+0000",
        "active": true
      }
    ],
    "ikaccountId": "A78094.48",
    "tableNumber": 2,
    "posId": 54321
  }
}

Response

Your server returns this code if it accepts the callback