# CheckPaymentStatusUpdatedEvent_V20

`EVENT /websocket/events/checks/CheckPaymentStatusUpdatedEvent`

Core API · Checks - Events · base URL `https://core-api.ancon.io` · docs: https://ancon.dev/api/core/checks-events/check-payment-status-updated-event-v20

Sent when a check payment status is updated

Client types: POS, Express

Groups: CheckId, OutletId, CheckPaymentId, GroupId

Scopes: Outlet

## Responses

| Status | Description |
| --- | --- |
| 200 | Event payload schema |

### 200 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `messageId` | string (uuid) | no |  |
| `clientId` | string (uuid) or null | no |  |
| `correlationId` | string or null | no |  |
| `timestamp` | integer (int64) | no |  |
| `checkId` | string (uuid) | no |  |
| `checkPayment` | object or null | no |  |
| `checkPayment.id` | string (uuid) | no |  |
| `checkPayment.created` | string (date-time) | no |  |
| `checkPayment.modified` | string (date-time) | no |  |
| `checkPayment.checkId` | string (uuid) | no |  |
| `checkPayment.paymentType` | integer (int32) | no | Allowed values: `1`, `2`, `3`. |
| `checkPayment.amount` | object or null | no |  |
| `checkPayment.amount.amount` | number (double) | no |  |
| `checkPayment.amount.currency` | string or null | no |  |
| `checkPayment.cashBackAmount` | object or null | no |  |
| `checkPayment.cashBackAmount.amount` | number (double) | no |  |
| `checkPayment.cashBackAmount.currency` | string or null | no |  |
| `checkPayment.roundingAmount` | object or null | no |  |
| `checkPayment.roundingAmount.amount` | number (double) | no |  |
| `checkPayment.roundingAmount.currency` | string or null | no |  |
| `checkPayment.externalReference` | string or null | no |  |
| `checkPayment.status` | integer (int32) | no | Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `-1`. |
| `checkPayment.terminalId` | string (uuid) or null | no |  |
| `checkPayment.paymentMethod` | object or null | no |  |
| `checkPayment.paymentMethod.id` | string or null | no |  |
| `checkPayment.paymentMethod.type` | integer (int32) | no | 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`. |
| `checkPayment.paymentMethod.displayName` | string or null | no |  |
| `checkPayment.externalIdentifier` | string or null | no |  |
| `checkPayment.clientId` | string (uuid) | no |  |
| `checkPayment.externalTimeStamp` | string (date-time) or null | no |  |
| `checkPayment.paymentDoneAt` | string (date-time) or null | no |  |
| `checkPayment.errorType` | integer (int32) or null | no | 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`. |
| `checkPayment.tenantUserId` | string (uuid) | no |  |
| `checkPayment.tipAmount` | number (double) | no |  |
| `checkPayment.centralControlUnitSerial` | string or null | no |  |
| `checkPayment.isReceiptPrinted` | boolean | no |  |
| `checkPayment.invoiceReferenceNote` | string or null | no |  |
| `checkPayment.receipts` | array<object> or null | no |  |
| `checkPayment.receipts[].receiverType` | integer (int32) | no | Allowed values: `1`, `2`. |
| `checkPayment.receipts[].needsSignature` | boolean | no |  |
| `checkPayment.receipts[].receiptTexts` | array<object> or null | no |  |
| `checkPayment.receipts[].receiptTexts[].key` | string or null | no |  |
| `checkPayment.receipts[].receiptTexts[].value` | string or null | no |  |
| `checkPayment.receipts[].receiptTexts[].name` | string or null | no |  |
| `checkPayment.transactions` | array<object> or null | no |  |
| `checkPayment.transactions[].id` | string (uuid) | no |  |
| `checkPayment.transactions[].created` | string (date-time) | no |  |
| `checkPayment.transactions[].modified` | string (date-time) | no |  |
| `checkPayment.transactions[].type` | integer (int32) | no | Allowed values: `0`, `1`, `2`, `3`, `4`, `-2`, `-1`. |
| `checkPayment.transactions[].status` | integer (int32) | no | Allowed values: `0`, `1`, `2`, `3`, `-3`, `-2`, `-1`. |
| `checkPayment.transactions[].externalReference` | string or null | no |  |
| `checkPayment.transactions[].externalData` | string or null | no |  |
| `checkPayment.transactions[].errorDetails` | string or null | no |  |
| `checkPayment.transactions[].confirmationData` | string or null | no |  |
| `checkPayment.usedGiftCard` | object or null | no |  |
| `checkPayment.usedGiftCard.id` | string (uuid) | no |  |
| `checkPayment.usedGiftCard.giftCardNumber` | string or null | no |  |
| `checkPayment.usedGiftCard.giftCardNumberType` | integer (int32) | no | Allowed values: `0`, `1`, `2`. |
| `checkPayment.usedGiftCard.soldDate` | string (date-time) or null | no |  |
| `checkPayment.usedGiftCard.expiryDate` | string (date-time) or null | no |  |
| `checkPayment.usedGiftCard.amount` | object or null | no |  |
| `checkPayment.usedGiftCard.amount.amount` | number (double) | no |  |
| `checkPayment.usedGiftCard.amount.currency` | string or null | no |  |
| `checkPayment.usedGiftCard.balance` | object or null | no |  |
| `checkPayment.usedGiftCard.balance.amount` | number (double) | no |  |
| `checkPayment.usedGiftCard.balance.currency` | string or null | no |  |
| `checkPayment.usedWallet` | object or null | no |  |
| `checkPayment.usedWallet.id` | string (uuid) | no |  |
| `checkPayment.usedWallet.walletNumber` | string or null | no |  |
| `checkPayment.usedWallet.walletNumberType` | integer (int32) | no | Allowed values: `0`, `1`. |
| `checkPayment.usedWallet.soldDate` | string (date-time) or null | no |  |
| `checkPayment.usedWallet.expiryDate` | string (date-time) or null | no |  |
| `checkPayment.usedWallet.balance` | object or null | no |  |
| `checkPayment.usedWallet.balance.amount` | number (double) | no |  |
| `checkPayment.usedWallet.balance.currency` | string or null | no |  |
| `checkPayment.topUpWallets` | array<object> or null | no |  |
| `checkPayment.topUpWallets[].item1` | object or null | no |  |
| `checkPayment.topUpWallets[].item1.id` | string (uuid) | no |  |
| `checkPayment.topUpWallets[].item1.walletNumber` | string or null | no |  |
| `checkPayment.topUpWallets[].item1.walletNumberType` | integer (int32) | no | Allowed values: `0`, `1`. |
| `checkPayment.topUpWallets[].item1.soldDate` | string (date-time) or null | no |  |
| `checkPayment.topUpWallets[].item1.expiryDate` | string (date-time) or null | no |  |
| `checkPayment.topUpWallets[].item1.balance` | object or null | no |  |
| `checkPayment.topUpWallets[].item1.balance.amount` | number (double) | no |  |
| `checkPayment.topUpWallets[].item1.balance.currency` | string or null | no |  |
| `checkPayment.topUpWallets[].item2` | object or null | no |  |
| `checkPayment.topUpWallets[].item2.amount` | number (double) | no |  |
| `checkPayment.topUpWallets[].item2.currencyCode` | string or null | no |  |
| `checkPayment.omniboostRoomsInfo` | array<object> or null | no |  |
| `checkPayment.omniboostRoomsInfo[].id` | string (uuid) | no |  |
| `checkPayment.omniboostRoomsInfo[].name` | string or null | no |  |
| `additionalData` | any or null | no |  |

#### Example (from schema)

```json
{
  "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "correlationId": "string",
  "timestamp": 0,
  "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "checkPayment": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created": "2026-01-15T12:00:00Z",
    "modified": "2026-01-15T12:00:00Z",
    "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentType": 1,
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "cashBackAmount": {
      "amount": 0,
      "currency": "string"
    },
    "roundingAmount": {
      "amount": 0,
      "currency": "string"
    },
    "externalReference": "string",
    "status": 0,
    "terminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": {
      "id": "string",
      "type": 0,
      "displayName": "string"
    },
    "externalIdentifier": "string",
    "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalTimeStamp": "2026-01-15T12:00:00Z",
    "paymentDoneAt": "2026-01-15T12:00:00Z",
    "errorType": 0,
    "tenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipAmount": 0,
    "centralControlUnitSerial": "string",
    "isReceiptPrinted": true,
    "invoiceReferenceNote": "string",
    "receipts": [
      {
        "receiverType": 1,
        "needsSignature": true,
        "receiptTexts": [
          {
            "key": "string",
            "value": "string",
            "name": "string"
          }
        ]
      }
    ],
    "transactions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "type": 0,
        "status": 0,
        "externalReference": "string",
        "externalData": "string",
        "errorDetails": "string",
        "confirmationData": "string"
      }
    ],
    "usedGiftCard": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "giftCardNumber": "string",
      "giftCardNumberType": 0,
      "soldDate": "2026-01-15T12:00:00Z",
      "expiryDate": "2026-01-15T12:00:00Z",
      "amount": {
        "amount": 0,
        "currency": "string"
      },
      "balance": {
        "amount": 0,
        "currency": "string"
      }
    },
    "usedWallet": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "walletNumber": "string",
      "walletNumberType": 0,
      "soldDate": "2026-01-15T12:00:00Z",
      "expiryDate": "2026-01-15T12:00:00Z",
      "balance": {
        "amount": 0,
        "currency": "string"
      }
    },
    "topUpWallets": [
      {
        "item1": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "walletNumber": "string",
          "walletNumberType": 0,
          "soldDate": "2026-01-15T12:00:00Z",
          "expiryDate": "2026-01-15T12:00:00Z",
          "balance": {
            "amount": 0,
            "currency": "string"
          }
        },
        "item2": {
          "amount": 0,
          "currencyCode": "string"
        }
      }
    ],
    "omniboostRoomsInfo": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    ]
  },
  "additionalData": null
}
```