developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIChecks - Events

CheckPaymentStatusUpdatedEvent_V20

event/websocket/events/checks/CheckPaymentStatusUpdatedEvent
View .mdOpenAPI

Sent when a check payment status is updated

Client types: POS, Express

Groups: CheckId, OutletId, CheckPaymentId, GroupId

Scopes: Outlet

Responses

200Event payload schemaapplication/json
  • messageIdstring (uuid)
  • clientIdstring (uuid) | null
  • correlationIdstring | null
  • timestampinteger (int64)
  • checkIdstring (uuid)
  • checkPaymentobject | null
    28 fields in checkPayment
    • idstring (uuid)
    • createdstring (date-time)
    • modifiedstring (date-time)
    • checkIdstring (uuid)
    • paymentTypeinteger (int32)

      Allowed values: 1, 2, 3.

    • amountobject | null
      2 fields in amount
      • amountnumber (double)
      • currencystring | null
    • cashBackAmountobject | null
      2 fields in cashBackAmount
      • amountnumber (double)
      • currencystring | null
    • roundingAmountobject | null
      2 fields in roundingAmount
      • amountnumber (double)
      • currencystring | null
    • externalReferencestring | null
    • statusinteger (int32)

      Allowed values: 0, 1, 2, 3, 4, 5, -1.

    • terminalIdstring (uuid) | null
    • paymentMethodobject | null
      3 fields in paymentMethod
      • idstring | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23.

      • displayNamestring | null
    • externalIdentifierstring | null
    • clientIdstring (uuid)
    • externalTimeStampstring (date-time) | null
    • paymentDoneAtstring (date-time) | null
    • errorTypeinteger (int32) | null

      Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, -1.

    • tenantUserIdstring (uuid)
    • tipAmountnumber (double)
    • centralControlUnitSerialstring | null
    • isReceiptPrintedboolean
    • invoiceReferenceNotestring | null
    • receiptsarray<object> | null
      3 fields in receipts
      • receiverTypeinteger (int32)

        Allowed values: 1, 2.

      • needsSignatureboolean
      • receiptTextsarray<object> | null
        3 fields in receiptTexts
        • keystring | null
        • valuestring | null
        • namestring | null
    • transactionsarray<object> | null
      9 fields in transactions
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3, 4, -2, -1.

      • statusinteger (int32)

        Allowed values: 0, 1, 2, 3, -3, -2, -1.

      • externalReferencestring | null
      • externalDatastring | null
      • errorDetailsstring | null
      • confirmationDatastring | null
    • usedGiftCardobject | null
      7 fields in usedGiftCard
      • idstring (uuid)
      • giftCardNumberstring | null
      • giftCardNumberTypeinteger (int32)

        Allowed values: 0, 1, 2.

      • soldDatestring (date-time) | null
      • expiryDatestring (date-time) | null
      • amountobject | null
        2 fields in amount
        • amountnumber (double)
        • currencystring | null
      • balanceobject | null
        2 fields in balance
        • amountnumber (double)
        • currencystring | null
    • usedWalletobject | null
      6 fields in usedWallet
      • idstring (uuid)
      • walletNumberstring | null
      • walletNumberTypeinteger (int32)

        Allowed values: 0, 1.

      • soldDatestring (date-time) | null
      • expiryDatestring (date-time) | null
      • balanceobject | null
        2 fields in balance
        • amountnumber (double)
        • currencystring | null
    • topUpWalletsarray<object> | null
      2 fields in topUpWallets
      • item1object | null
        6 fields in item1
        • idstring (uuid)
        • walletNumberstring | null
        • walletNumberTypeinteger (int32)

          Allowed values: 0, 1.

        • soldDatestring (date-time) | null
        • expiryDatestring (date-time) | null
        • balanceobject | null
          2 fields in balance
          • amountnumber (double)
          • currencystring | null
      • item2object | null
        2 fields in item2
        • amountnumber (double)
        • currencyCodestring | null
    • omniboostRoomsInfoarray<object> | null
      2 fields in omniboostRoomsInfo
      • idstring (uuid)
      • namestring | null
  • additionalDataany | null