Overview

This page provides detailed definitions for each supported Message Queue (MQ) topic. Topics are logical groupings of related events that clients can subscribe to for real-time updates. Understanding these definitions helps ensure your subscriptions align with your business needs.

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

RTP Settlement Payload Example:

{
{
  customer_external_uid: '9vZz5Up4YzVXWpEY',
  customer_uid: 'X3wrzgf4Hkg1fdqt',
  transfer_uid: 'S3s16vP4iTjmVKde',
  transaction_uid: '4kpBYX7UkQEJ4WUt',
  transaction_uids: ['4kpBYX7UkQEJ4WUt', 'MyhsiAUo4jgfbEF9'],
  destination_synthetic_account_uid: 'UWniK6K7w83TFzBr',
  destination_customer_external_uid: 'customer_defined_uid',
  destination_customer_uid: 'dXDxCgpvxWd4GW48',
  network: 'tch | fednow',
  network_transaction_id: '202602020430000961BAAAA00041250796',
  virtual_reference_number_uid: nil
  }
}

RTP Settlement Payload Fields

RTP Settlement events include the following fields in their payload:

customer_external_uid (string): The external unique identifier for the customer, typically defined by your system.
customer_uid (string): The internal unique identifier for the customer within the platform.
transfer_uid (string): The unique identifier for the transfer associated with this settlement event.
transaction_uid (string): The primary transaction unique identifier associated with this settlement.
transaction_uids (array): An array of all transaction unique identifiers related to this settlement. May include multiple transactions if the settlement involves multiple transaction records.
destination_synthetic_account_uid (string): The unique identifier for the destination synthetic account receiving the funds.
destination_customer_external_uid (string): The external unique identifier for the destination customer.
destination_customer_uid (string): The internal unique identifier for the destination customer.
network (string): Identifies the instant payments network used for the settlement.
Example values include:
- tch — The Clearing House RTP network
- fednow — Federal Reserve FedNow network Additional values may be added in future updates as new instant payment networks are supported.
network_transaction_id (string): The unique transaction identifier assigned by the instant payments network (RTP or FedNow) for tracking and reconciliation purposes.
virtual_reference_number_uid (string | null): The unique identifier for the Virtual Reference Number (VRN) if applicable to this settlement. Will be null if no VRN is associated.

🔗 Related Pages

📘
Note For guidance on how events are delivered and authenticated, see the Message Queue Documentation is identifying which topics support your operational or customer-facing workflows.