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
  • 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​


See also​