Message Queue Topic Definitions

Overview

Use this page to identify the Message Queue (MQ) topics and events available for subscription.

Topics are logical groupings of related events that you can subscribe to for real-time updates.

How Topics Work

Each topic represents a category of events tied to a specific entity (e.g., Transfers, Transactions). Clients can subscribe at:

• Topic-level: Receive all events under a topic.
• Event-level: Subscribe to specific event types.
• Combination: Mix topic and event-level subscriptions for granular control.

Topic Naming Convention

MQ topics follow this format:

/topic/<client>.<environment>.<topic_name>

Example:\ /topic/neal.abc-enterprises.sandbox.transfer

Topic Definitions

Transfer

• Transfer Initiated: A transfer has been created.
• Transfer Status Changed: The status of a transfer has been updated.
• RTP Transfer Queued: A transfer has entered a queued state and is awaiting processing.
• RTP Settlement: An instant payment transfer has reached settlement.

Transaction

• Transaction Created: A transaction record has been generated.
• Transaction Status Updated: The transaction status has changed.

Synthetic Account

• Account Created: A synthetic account has been created.
• Status Changed: The account status has changed.
• Name Updated: The account name has been updated.

Virtual Reference Numbers (VRNs)

• VRN Created: A new VRN has been issued.
• Instant Payment Rail Registration Status Changed: The registration status has changed.

Customer (Beta)

• Status Changed: A customer’s status has changed.
• Locked/Unlocked: Indicates account access changes.

Debit Card (Beta)

• Requested/Issued: A card has been requested or issued.
• Status Updated: The card status has changed.
• Reissued/Locked/Unlocked: Lifecycle and access events.
• PIN Events: PIN changed, staging failed, or commit failed.

Example Payloads

Each event includes:

• event_type (e.g., created, status_change)
• details object with relevant data
• Unique event_id for idempotency

Related Pages

• MQ Topics
• MQ Topic Publication
• MQ Subscriptions