Skip to main content

Message categories and types​

This is a comprehensive reference of all message types in the Banqup system, organized by category.
Check out this API recipe to set up a message listener using the desired message categories and types from this guide.

General information​

Message categories​

Messages are grouped by their category field:

  • document - Document lifecycle and operations
  • entity - Entities, spaces, and payment accounts
  • file - File operations and virus scanning
  • payment - Payment operations
  • paymentInformation - Payment transactions and movements
  • space - Space configuration, extensions, and partners
  • spaceAsset - Space-level assets
Versioning​

Some message types have multiple versions (v1, v2). Always check which version your system supports and consult the API documentation for version-specific changes.

Common fields​
  • category - The broad category of the message
  • type - The fully qualified message type identifier
  • data - The message payload containing event-specific data
  • resourceId - (Optional) The primary resource identifier for access control
  • scope - (Optional) The permission scope required to receive this message
  • channel - (Optional) The specific channel for message routing
  • orderGroup - (Optional) Used to maintain ordering of related messages
Payment status fields​

Payment-related messages include structured status information:

  • status.reason - Array of status codes providing context:

    • [] - Empty array indicates no specific reason
    • ["INSUFFICIENT_FUNDS"] - Account lacks sufficient balance
    • ["BANK_PROCESSING_ERROR"] - Error occurred during bank processing

  • status.auth - Authentication flow status (format: STATUS:URL):

    • PENDING:https://... - Authentication is pending user action
    • COMPLETED:https://... - Authentication flow completed

  • status.payment - Current payment state:

    • RECEIVED - Payment received by payment processor
    • FAILED - Payment processing failed
    • PAID - Payment successfully completed

  • levelOfCertainty - Reliability indicator for the payment status:

    • INFORMATIONAL - Status is informational and may change
UUIDs​

All UUID fields in examples are placeholders. Real implementations will contain actual UUID values following the standard UUID format.

Data payload​

The data field contains event-specific information. Only changed fields are included in update events to minimize payload size. btx-messages-doc.md Displaying btx-messages-doc.md.

Message categories and their types​


Document messages

Messages related to document lifecycle and operations.



DocumentCreated


Type: com.unifiedpost.btx.data.events.v1.DocumentCreated


Sent when a document is created in the data store.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentCreated",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "scope": "document_read",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "folder": "DRAFTS"
  }
}

DocumentUpdated


Type: com.unifiedpost.btx.data.events.v1.DocumentUpdated


Sent when a document is updated in the data store.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentUpdated",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "scope": "document_read",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "folder": "DRAFTS"
  }
}

DocumentUpdated (v2)


Type: com.unifiedpost.btx.data.events.v2.DocumentUpdated


Version 2 of the document updated event. This version includes additional fields and metadata compared to v1.


Example:

{
  "messageId": "message-uuid",
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v2.DocumentUpdated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "doc-uuid",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "folder": "SALES",
    "metadata": {
      "linesNetAmount": "0.05",
      "chargesNetAmount": "0",
      "allowancesNetAmount": "0",
      "documentTotals": {
        "chargesNetAmount": null,
        "linesNetAmount": null,
        "allowancesNetAmount": null
      }
    },
    "tags": ["SEEN"],
    "updatedAt": "2025-10-20T09:11:09.127801048Z"
  }
}

DocumentDeleted


Type: com.unifiedpost.btx.data.events.v1.DocumentDeleted


Sent when a document is deleted in the data store.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentDeleted",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "scope": "document_read",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "folder": "DRAFTS"
  }
}

DocumentAttachmentScanned


Type: com.unifiedpost.btx.data.events.v1.DocumentAttachmentScanned


Sent when a document's attachment is virus scanned.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentAttachmentScanned",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "orderGroup": "attachment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "id": "attachment-uuid",
    "scanResult": "clean"
  }
}

DocumentTaskCreated


Type: com.unifiedpost.btx.data.events.v1.DocumentTaskCreated


Sent when a document task (such as an approve or delete document action) is created in the Data Store.


Example:

{
  "messageId": "message-uuid",
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentTaskCreated",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "doc-uuid",
  "data": {
    "extensionName": "com.unifiedpost.btx.documents.actions:delete",
    "documentId": "doc-uuid"
  }
}

DocumentActionPerformed


Type: com.unifiedpost.btx.data.events.v1.DocumentActionPerformed


Sent whenever a task (such as markAsRefused document action) is executed in the Data Store.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.DocumentActionPerformed",
  "orderGroup": "50000001-0000-0000-0000-000000000000",
  "data": {
    "action": "MARK_AS_REFUSED"
  }
}

TaskStatusUpdated


Type: com.unifiedpost.btx.data.events.v1.TaskStatusUpdated


Sent whenever a task status of a document action is updated in the Data Store.


Example:

{
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.TaskStatusUpdated",
  "channel": "space-uuid/doc-uuid",
  "orderGroup": "50000001-0000-0000-0000-000000000000",
  "data": {
    "action": "MARK_AS_REFUSED"
  }
}

VirusScanned (Document)


Type: com.unifiedpost.btx.data.events.v1.VirusScanned


Sent when a document has been scanned for viruses.


Example:

{
  "messageId": "message-uuid",
  "category": "document",
  "type": "com.unifiedpost.btx.data.events.v1.VirusScanned",
  "channel": "space-uuid/doc-uuid",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "doc-uuid",
  "data": {
    "spaceId": "space-uuid",
    "documentId": "doc-uuid",
    "id": "attachment-uuid",
    "scanResult": "clean"
  }
}
Entity messages

Messages related to entities, spaces, and payment accounts.



EntityCreated


Type: com.unifiedpost.btx.entity.events.v1.EntityCreated


Sent when a new entity is created.

EntityUpdated


Type: com.unifiedpost.btx.entity.events.v1.EntityUpdated


Sent when an entity is updated.


Example:

{
  "category": "entity",
  "type": "com.unifiedpost.btx.entity.events.v1.EntityUpdated",
  "data": {
    "entityId": "entity-uuid",
    "spaces": ["space-uuid"]
  }
}

EntityDeleted


Type: com.unifiedpost.btx.entity.events.v1.EntityDeleted


Sent when an entity is deleted.

SpaceCreated


Type: com.unifiedpost.btx.entity.events.v1.SpaceCreated


Sent when a new space is created.


Example:

{
  "category": "entity",
  "type": "com.unifiedpost.btx.entity.events.v1.SpaceCreated",
  "data": {
    "spaceId": "space-uuid",
    "entityId": "entity-uuid"
  }
}

SpaceUpdated


Type: com.unifiedpost.btx.entity.events.v1.SpaceUpdated


Sent when a space is updated.


Example:

{
  "category": "entity",
  "type": "com.unifiedpost.btx.entity.events.v1.SpaceUpdated",
  "data": {
    "spaceId": "space-uuid",
    "entityId": "entity-uuid"
  }
}

SpaceDeleted


Type: com.unifiedpost.btx.entity.events.v1.SpaceDeleted


Sent when a space is deleted.


Example:

{
  "category": "entity",
  "type": "com.unifiedpost.btx.entity.events.v1.SpaceDeleted",
  "data": {
    "spaceId": "space-uuid",
    "entityId": "entity-uuid"
  }
}

PaymentAccountCreated


Type: com.unifiedpost.btx.entity.events.v1.PaymentAccountCreated


Sent when a payment account is created.


Example:

{
  "category": "entity",
  "type": "com.unifiedpost.btx.entity.events.v1.PaymentAccountCreated",
  "data": {
    "entityId": "entity-uuid",
    "paymentAccount": {
      "id": "payment-account-uuid",
      "identifier": "BE68539007547034",
      "scheme": "IBAN",
      "country": "BE",
      "currency": "EUR",
      "bank": {
        "scheme": "BIC",
        "identifier": "GEBABEBB"
      }
    }
  }
}
File messages

Messages related to file operations and virus scanning.



FileCreated


Type: com.unifiedpost.btx.data.events.v1.FileCreated


Sent when a file is created in the data store.


Example:

{
  "category": "file",
  "type": "com.unifiedpost.btx.data.events.v1.FileCreated",
  "orderGroup": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
  "channel": "<space-uuid>/<file-uuid>",
  "data": {
    "spaceId": "34164365-4b16-472d-b6f6-0615ca1351d9",
    "fileId": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
    "description": "The file for document DOC-1",
    "status": "PROCESSING",
    "fileSize": 1024,
    "fileType": "xml",
    "contentType": "application/xml"
  }
}

FileUpdated


Type: com.unifiedpost.btx.data.events.v1.FileUpdated


Sent when a file is updated in the data store.


Example:

{
  "category": "file",
  "type": "com.unifiedpost.btx.data.events.v1.FileUpdated",
  "orderGroup": "00000001-0004-0000-0000-000000000000",
  "channel": "<space-uuid>/<file-uuid>",
  "data": {
    "spaceId": "34164365-4b16-472d-b6f6-0615ca1351d9",
    "fileId": "00000001-0004-0000-0000-000000000000",
    "description": "The file for document DOC-1",
    "status": "PROCESSING",
    "filename": "legal_xml.xml",
    "fileSize": 1024,
    "fileType": "xml",
    "contentType": "application/xml",
    "creatorType": "user",
    "creatorSubject": "00000001-0001-0001-0001-000000000000",
    "retentionTime": "2129-01-14T19:58:47Z",
    "updatedAt": "2024-07-30T04:14:36.158600375Z",
    "tags": ["tag1", "tag2"]
  }
}

FileUpdated (v2)


Type: com.unifiedpost.btx.data.events.v2.FileUpdated


Version 2 of the file updated event. This version includes additional fields and metadata compared to v1.


Example:

{
  "messageId": "message-uuid",
  "category": "file",
  "type": "com.unifiedpost.btx.data.events.v2.FileUpdated",
  "channel": "space-uuid/file-uuid",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "file-uuid",
  "data": {
    "spaceId": "space-uuid",
    "fileId": "file-uuid",
    "path": "pending/file/space-uuid/file-uuid",
    "fileSize": "46577",
    "description": "description",
    "contentType": "application/pdf",
    "fileType": "application/pdf",
    "status": "AWAITING_UPLOAD",
    "updatedAt": "2025-10-20T09:16:09.610126747Z"
  }
}

FileDeleted


Type: com.unifiedpost.btx.data.events.v1.FileDeleted


Sent when a file is deleted in the data store.


Example:

{
  "category": "file",
  "type": "com.unifiedpost.btx.data.events.v1.FileDeleted",
  "orderGroup": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
  "channel": "<space-uuid>/<file-uuid>",
  "data": {
    "spaceId": "34164365-4b16-472d-b6f6-0615ca1351d9",
    "fileId": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
    "description": "The file for document DOC-1",
    "status": "PROCESSING",
    "fileSize": 1024,
    "fileType": "xml",
    "contentType": "application/xml"
  }
}

VirusScanned (Document)


Type: com.unifiedpost.btx.data.events.v1.VirusScanned


Sent when a file has been scanned for viruses.


Example:

{
  "category": "file",
  "type": "com.unifiedpost.btx.data.events.v1.VirusScanned",
  "orderGroup": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
  "channel": "<space-uuid>/<file-uuid>",
  "data": {
    "spaceId": "34164365-4b16-472d-b6f6-0615ca1351d9",
    "fileId": "ee0be6a3-32ba-41f4-8a63-4143354014ab",
    "description": "The file for document DOC-1",
    "status": "PROCESSING",
    "fileSize": 1024,
    "fileType": "xml",
    "contentType": "application/xml",
    "scanResult": "clean",
    "updatedAt": "2024-07-30T04:47:35.667546145Z"
  }
}
Payment messages

Messages related to payment operations.



PaymentCreated


Type: com.unifiedpost.btx.data.events.v1.PaymentCreated


Sent when a payment is created in the data store.


Example:

{
  "messageId": "message-uuid",
  "category": "payment",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentCreated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "type": "SINGLE",
    "amountValue": "5",
    "amountCurrency": "EUR",
    "endToEndId": "BTX1234567890abcdef1234567890abcd"
  }
}

PaymentUpdated


Type: com.unifiedpost.btx.data.events.v1.PaymentUpdated


Sent when a payment is updated in the data store. Contains all "dirty" changes (fields that have been modified).


Example:

{
  "messageId": "message-uuid",
  "category": "payment",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentUpdated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "levelOfCertainty": "INFORMATIONAL",
    "status": {
      "reason": ["INSUFFICIENT_FUNDS"],
      "auth": "COMPLETED:https://example.com/payment-accounts/?showPaymentStatus=true",
      "payment": "FAILED"
    },
    "updatedAt": "2025-10-20T09:33:50.338795855Z"
  }
}

Status Field Details:

  • levelOfCertainty - Indicates the reliability of the payment status (e.g., "INFORMATIONAL")
  • status.reason - Array of status reasons/error codes (e.g., "INSUFFICIENT_FUNDS", "BANK_PROCESSING_ERROR")
  • status.auth - Authentication flow status with redirect URL
  • status.payment - Current payment processing state (e.g., "RECEIVED", "FAILED", "PAID")

PaymentUpdated (v2)


Type: com.unifiedpost.btx.data.events.v2.PaymentUpdated


Version 2 of the payment updated event. This version includes additional fields and metadata compared to v1.


Example:

{
  "messageId": "message-uuid",
  "category": "payment",
  "type": "com.unifiedpost.btx.data.events.v2.PaymentUpdated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "levelOfCertainty": "INFORMATIONAL",
    "status": {
      "reason": ["INSUFFICIENT_FUNDS"],
      "auth": "COMPLETED:https://example.com/payment-accounts/?showPaymentStatus=true",
      "payment": "FAILED"
    },
    "updatedAt": "2025-10-20T09:33:50.338795855Z"
  }
}

Note: The structure is similar to v1, but v2 may include additional metadata fields depending on the update context.

Payment information messages

Messages related to payment transactions and movements.



PaymentTransactionCreated


Type: com.unifiedpost.btx.data.events.v1.PaymentTransactionCreated


Sent when a payment transaction is created in the data store.


Example:

{
  "messageId": "message-uuid",
  "category": "paymentInformation",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentTransactionCreated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "paymentTransactionId": "payment-transaction-uuid",
    "amountValue": "5",
    "amountCurrency": "EUR",
    "endToEndId": "BTX1234567890abcdef1234567890abcd"
  }
}

PaymentTransactionUpdated


Type: com.unifiedpost.btx.data.events.v1.PaymentTransactionUpdated


Sent when a payment transaction is updated in the data store. Contains all "dirty" changes.


Example:

{
  "messageId": "message-uuid",
  "category": "paymentInformation",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentTransactionUpdated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "paymentTransactionId": "payment-transaction-uuid",
    "source": {
      "provider": "PXG",
      "transactionId": "transaction-uuid"
    },
    "status": {
      "reason": ["INSUFFICIENT_FUNDS"],
      "auth": "COMPLETED:https://example.com/payment-accounts/?showPaymentStatus=true",
      "payment": "FAILED"
    },
    "updatedAt": "2025-10-20T09:33:50.326481741Z"
  }
}

Common Status Values:

  • status.reason - Array of error/info codes such as:
    • INSUFFICIENT_FUNDS - Not enough funds in the account
    • BANK_PROCESSING_ERROR - Error during bank processing
    • Empty array [] - No specific reason/error
  • status.auth - Authentication status with URL:
    • PENDING:https://... - Authentication pending
    • COMPLETED:https://... - Authentication completed
  • status.payment - Payment processing status:
    • RECEIVED - Payment received by processor
    • FAILED - Payment processing failed
    • PAID - Payment successfully completed

PaymentTransactionUpdated (v2)


Type: com.unifiedpost.btx.data.events.v2.PaymentTransactionUpdated


Version 2 of the payment transaction updated event. This version includes additional fields and metadata compared to v1.


Example:

{
  "messageId": "message-uuid",
  "category": "paymentInformation",
  "type": "com.unifiedpost.btx.data.events.v2.PaymentTransactionUpdated",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "payment-uuid",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "paymentTransactionId": "payment-transaction-uuid",
    "source": {
      "provider": "PXG",
      "transactionId": "transaction-uuid"
    },
    "status": {
      "reason": []
    },
    "updatedAt": "2025-10-20T09:28:34.470918666Z"
  }
}

PaymentMovementCreated


Type: com.unifiedpost.btx.data.events.v1.PaymentMovementCreated


Sent when a payment movement is created in the data store.


Example:

{
  "category": "payment_movement",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentMovementCreated",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "paymentMovementId": "paymentMovement-uuid",
    "amountValue": "20.15",
    "amountCurrency": "EUR",
    "reference": "payment-reference",
    "endToEndId": "identifier",
    "originatingPaymentAccountId": "originatingPaymentAccount-uuid",
    "counterpartyPaymentAccountId": "counterpartyPaymentAccount-uuid"
  }
}

PaymentMovementUpdated


Type: com.unifiedpost.btx.data.events.v1.PaymentMovementUpdated


Sent when a payment movement is updated in the data store.


Example:

{
  "category": "payment_movement",
  "type": "com.unifiedpost.btx.data.events.v1.PaymentMovementUpdated",
  "data": {
    "spaceId": "space-uuid",
    "paymentId": "payment-uuid",
    "paymentMovementId": "paymentMovement-uuid",
    "<<changedfields>>"
  }
}

PaymentMovementUpdated (v2)


Type: com.unifiedpost.btx.data.events.v2.PaymentMovementUpdated


Version 2 of the payment movement updated event.

Space messages

Messages related to space configuration, extensions, partners, and payment accounts.



ExtensionCreated


Type: com.unifiedpost.btx.entity.events.v1.ExtensionCreated


Sent when an extension is created in a space.


Example:

{
  "messageId": "message-uuid",
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.ExtensionCreated",
  "channel": "space-uuid/extension-uuid",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "space-uuid/extension-uuid",
  "data": {
    "spaceId": "space-uuid",
    "extensionId": "extension-uuid",
    "name": "google-drive-app",
    "namespace": "com.unifiedpost.btx.accounting",
    "serviceAccount": "service-account-uuid",
    "category": "APPLICATION",
    "version": "2.2.0",
    "status": "INACTIVE",
    "spaceType": "BUSINESS",
    "lastUpdatedAt": "2025-10-20T09:48:02.414888390Z"
  }
}

ExtensionUpdated


Type: com.unifiedpost.btx.entity.events.v1.ExtensionUpdated


Sent when an extension is updated in a space.


Example:

{
  "messageId": "message-uuid",
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.ExtensionUpdated",
  "channel": "space-uuid/extension-uuid",
  "resourceId": "space-uuid",
  "scope": "space_read",
  "orderGroup": "space-uuid/extension-uuid",
  "data": {
    "spaceId": "space-uuid",
    "extensionId": "extension-uuid",
    "name": "google-drive-app",
    "namespace": "com.unifiedpost.btx.accounting",
    "serviceAccount": "service-account-uuid",
    "category": "APPLICATION",
    "version": "2.2.0",
    "status": "ACTIVE",
    "spaceType": "BUSINESS",
    "changes": {
      "status": "ACTIVE",
      "updatedAt": "2025-10-20T09:49:15.371389289Z"
    },
    "lastUpdatedAt": "2025-10-20T09:49:15.399083261Z"
  }
}

Changes Object: The changes field contains details about what was modified. Common change types include:

  • status - Status change (e.g., from "INACTIVE" to "ACTIVE")
  • settings - Updated configuration settings for the extension (e.g., authentication details, connection parameters)
  • updatedAt - Timestamp of when the changes were made

Extension Status Values:

  • INACTIVE - Extension is installed but not yet active
  • ACTIVE - Extension is fully configured and active

ExtensionDeleted


Type: com.unifiedpost.btx.entity.events.v1.ExtensionDeleted


Sent when an extension is deleted from a space.

PlanExtensionsChanged


Type: com.unifiedpost.btx.entity.events.v1.PlanExtensionsChanged


Sent when plan extensions are added or removed from a space.


Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PlanExtensionsChanged",
  "data": {
    "spaceId": "space-uuid",
    "entityId": "entity-uuid",
    "extensions": {
      "added": [
        {
          "name": "Payments",
          "namespace": "com.unifiedpost.payments.PayMe"
        }
      ],
      "removed": [
        {
          "extensionId": "extension-uuid",
          "name": "ocr",
          "namespace": "com.unifiedpost.ocr"
        }
      ]
    }
  }
}

PaymentAccountAssigned


Type: com.unifiedpost.btx.entity.events.v1.PaymentAccountAssigned


Sent when a payment account is assigned to a space.


Example:

{
  "messageId": "message-uuid",
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PaymentAccountAssigned",
  "resourceId": "entity-uuid",
  "scope": "entity_read",
  "orderGroup": "order-group-uuid",
  "data": {
    "spaceId": "space-uuid",
    "entityId": "entity-uuid",
    "paymentAccount": {
      "identifier": "BE68539007547034",
      "scheme": "IBAN",
      "country": "BE",
      "currency": "EUR",
      "ownerName": "John Doe",
      "bank": {
        "scheme": "BIC",
        "identifier": "GEBABEBB"
      }
    }
  }
}

PaymentAccountUnassigned


Type: com.unifiedpost.btx.entity.events.v1.PaymentAccountUnassigned


Sent when a payment account is unassigned from a space.

PartnerLinkCreated


Type: com.unifiedpost.btx.entity.events.v1.PartnerLinkCreated


Sent when a partner link is created.

Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PartnerLinkCreated",
  "data": {
    "entityId": "ee277964-523c-46be-bc13-386048882228",
    "spaceId": "716d7bfc-eb6a-4968-9837-aad3ca95ac4b",
    "partnerId": "3ca55e67-22d3-4a67-b569-5c133771f1a6",
    "clientId": "e8b5ed7b-5391-436d-bd20-8333f1f97b0c"
  }
}

PartnerLinkDeleted


Type: com.unifiedpost.btx.entity.events.v1.PartnerLinkDeleted


Sent when a partner link is deleted.


Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PartnerLinkDeleted",
  "data": {
    "spaceId": "716d7bfc-eb6a-4968-9837-aad3ca95ac4b",
    "partnerId": "3ca55e67-22d3-4a67-b569-5c133771f1a6",
    "clientId": "e8b5ed7b-5391-436d-bd20-8333f1f97b0c"
  }
}

PartnerExtensionCreated


Type: com.unifiedpost.btx.entity.events.v1.PartnerExtensionCreated


Sent when a partner extension is installed in the partner space.


Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PartnerExtensionCreated",
  "resourceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
  "scope": "space_read",
  "data": {
    "partnerSpaceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
    "spaceId": "da575e5d-160f-4db3-8d06-9c74377ccff0",
    "extensionId": "960f7570-78e5-46b4-b99f-d85df5ded8ec",
    "serviceAccount": "eb1faa60-b64b-4910-a9ee-458fed74a502",
    "name": "mail-partner-app",
    "namespace": "com.unifiedpost.btx.accounting",
    "timestamp": "2025-01-01T10:09:08+02:00"
  }
}

PartnerExtensionUpdated


Type: com.unifiedpost.btx.entity.events.v1.PartnerExtensionUpdated


Sent when a partner extension installed in the partner space is updated.


Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PartnerExtensionUpdated",
  "resourceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
  "scope": "space_read",
  "data": {
    "partnerSpaceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
    "spaceId": "da575e5d-160f-4db3-8d06-9c74377ccff0",
    "extensionId": "960f7570-78e5-46b4-b99f-d85df5ded8ec",
    "serviceAccount": "eb1faa60-b64b-4910-a9ee-458fed74a502",
    "name": "mail-partner-app",
    "namespace": "com.unifiedpost.btx.accounting",
    "status": "ACTIVE",
    "timestamp": "2025-01-01T10:09:08+02:00"
  }
}

PartnerExtensionDeleted


Type: com.unifiedpost.btx.entity.events.v1.PartnerExtensionDeleted


Sent when a partner extension installed in the partner space is deleted.


Example:

{
  "category": "space",
  "type": "com.unifiedpost.btx.entity.events.v1.PartnerExtensionDeleted",
  "resourceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
  "scope": "space_read",
  "data": {
    "partnerSpaceId": "458dc713-0e8b-416c-b404-e327162cc0dc",
    "spaceId": "da575e5d-160f-4db3-8d06-9c74377ccff0",
    "extensionId": "960f7570-78e5-46b4-b99f-d85df5ded8ec",
    "serviceAccount": "eb1faa60-b64b-4910-a9ee-458fed74a502",
    "name": "mail-partner-app",
    "namespace": "com.unifiedpost.btx.accounting",
    "timestamp": "2025-01-01T10:09:08+02:00"
  }
}
Space asset messages

Messages related to space-level assets.



SpaceAssetCreated


Type: com.unifiedpost.btx.data.events.v1.SpaceAssetCreated


Sent when a space asset is created.

SpaceAssetUpdated


Type: com.unifiedpost.btx.data.events.v2.SpaceAssetUpdated


Sent when a space asset is updated (version 2).

SpaceAssetDeleted


Type: com.unifiedpost.btx.data.events.v1.SpaceAssetDeleted


Sent when a space asset is deleted.

VirusScanned (Space asset)


Type: com.unifiedpost.btx.data.events.v1.VirusScanned


Sent when a space asset has been scanned for viruses.

See also​