Skip to main content

PostMessage Events

A postMessage is an event-based protocol that allows partners to take action in their own codebase in response to events triggered within a widget’s user interface. They are intended specifically to allow a partner’s code and a widget user interface to work in concert, not to give a full picture of events happening on MX servers. PostMessage events should not be used for keeping data in sync between platforms.

Events from MX will have the properties mx, type, and metadata.

The mx field is provided as an easy way for partners to filter out postMessage events coming from MX.

The type field identifies what the event represents at a high level. This field is a string with the format mx/microdeposits/<event>.

The metadata field is an object that has information related to the type that may be important, such as the, microdeposit_guid, user_guid etc.

Account Details Submitted​

Triggered when a user submits account details for a given institution for the first time and a microdeposit object is created on the MX platform.


_10
{
_10
"type": "mx/connect/microdeposits/detailsSubmitted",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123",
_10
"microdeposit_guid": "MIC-123"
_10
}
_10
}

Blocked Routing Number​

Triggered when the end user submits a blocked routing number on the ender details step.

ReasonDefinition
BLOCKEDMX has blocked this routing number. Neither microdeposit verification nor IAV can proceed.
CLIENT_BLOCKEDAn MX client has requested that this routing number be blocked. Neither microdeposit verification nor IAV can proceed.
IAV_PREFERREDThe institution associated with the routing number wishes to only support IAV and not microdeposits. The end user will be automatically taken to the IAV flow.

_10
{
_10
"type": "mx/connect/microdeposits/blockedRoutingNumber",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123",
_10
"routing_number": "123456789", # This is the user-entered routing number
_10
"reason": "BLOCKED",
_10
}
_10
}

Microdeposit Come Back, Primary Action Selected​

Triggered when user selects the primary button on the come back step.


_10
{
_10
"type": "mx/connect/microdeposits/comeBack/primaryAction",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123"
_10
}
_10
}

Microdeposit Error, Primary Action Selected​

Triggered when user selects the primary button on the microdeposit errors step for a PREVENTED status.


_10
{
_10
"type": "mx/connect/microdeposits/error/primaryAction",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123",
_10
"microdeposit_guid": "MIC-123",
_10
"microdeposit_status": "PREVENTED"
_10
}
_10
}

Microdeposit Flow Loaded​

Triggered when the microdeposit flow is loaded in Connect.


_10
{
_10
"type": "mx/connect/microdeposits/loaded",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123",
_10
"initial_step": "enterDetails"
_10
}
_10
}

Microdeposit Verified​

Triggered when a user successfully verifies the microdeposit amounts.


_10
{
_10
"type": "mx/connect/microdeposits/verified",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123",
_10
"microdeposit_guid": "MIC-123"
_10
}
_10
}

Microdeposit Verified, Primary Action Selected​

Triggered when user selects the primary button on verified step.


_10
{
_10
"type": "mx/connect/microdeposits/verified/primaryAction",
_10
"mx": true,
_10
"metadata": {
_10
"user_guid": "USR-123",
_10
"session_guid": "ANS-123"
_10
}
_10
}

On this page