Microdeposits - MX Documentation

Microdeposits webhooks notify you when a microdeposit is created or updated in the MX system for any user in the client. The payload for this webhook includes an action field that specifies the associated value of created or updated.

Field name	Data type	Definition
`account_number`	String	The account number.
`account_type`	Integer	The general or parent type of the account.
`created_at`	String	The date and time when the microdeposit was created. Given in ISO 8601 format.
`guid`	String	The unique identifier for the microdeposit. Defined by MX.
`institution_guid`	String	The unique identifier for the institution. Defined by MX.
`routing_number`	String	The routing number for the account.
`status`	Integer	The current status of the microdeposit.
`status_name`	String	The name of the current status.
`updated_at`	String	The date and time when the microdeposit was last updated. Given in ISO 8601 format.
`user_guid`	String	The unique identifier for the user. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.
`verified_at`	String	The date and time when the associated microdeposit status changed from `DEPOSITED` to `VERIFIED`.

Example Payload

JSON

{
  "action": "created",
  "version": 1,
  "micro_deposit": {
    "account_number": "333312345",
    "account_type": 1,
    "created_at": "2021-10-22T21:44:38.000+00:00",
    "guid": "MIC-34aeae9d-94c2-4d07-8cba-e8cb05a5c454",
    "institution_guid": null,
    "routing_number": "091000019",
    "status": 0,
    "status_name": "INITIATED",
    "updated_at": "2021-10-22T21:44:38.000+00:00",
    "user_guid": "USR-3bfab518-ef2b-4139-a8a5-7779e97ea4a1",
    "user_id": "user-2345"
  }
}