Microdeposits Overview - MX Documentation

Microdeposits are small verification deposits used to confirm ownership of bank accounts for ACH transfer setup.

Microdeposit Fields

Field name	Data type	Definition
`account_name`	String	The name of the account associated with the verification.
`account_number`	String	The account number of the account associated with the microdeposit.
`account_type`	Integer	The general or parent type of the account associated with the microdeposit. Possible values are `1` (CHECKING) and `2` (SAVINGS).
`account_type_name`	String	The name of the account type. Possible values are `CHECKING` and `SAVINGS`.
`created_at`	String	The date and time the microdeposit was created, given in ISO 8601 format.
`email`	String	The end user’s email address.
`error_code`	String	The code for the error.
`error_message`	String	A message explaining the error.
`first_name`	String	The end user’s first name.
`guid`	String	The unique identifier for the microdeposit. Defined by MX.
`institution_name`	String	An easy-to-read name for an institution associated with the microdeposit, e.g., “Chase Bank” or “Wells Fargo Bank.”
`last_name`	String	The end user’s last name.
`routing_number`	String	The routing number for the account associated with the microdeposit.
`status`	Integer	The current status of the microdeposit.
`status_name`	String	The name of the current status.
`updated_at`	String	The date and time at which the microdeposit was last updated, given in ISO 8601 format.
`verified_at`	String	The date and time at which the microdeposit status changed from `DEPOSITED` to `VERIFIED`.

Microdeposit Statuses

Status	Status name	Definiton
`0`	`INITIATED`	The verification process has started.
`1`	`REQUESTED`	Microdeposits have been requested from the microdeposit provider.
`2`	`DEPOSITED`	Microdeposits have been deposited into the specified account and are ready to be verified by the end user.
`3`	`VERIFIED`	The microdeposit amounts have been successfully verified by the end user.
`4`	`ERRORED`	The microdeposit could not take place due to an ACH error. This may indicate an incorrect account or routing number.
`5`	`DENIED`	The microdeposit amounts provided by the end user were incorrect.
`6`	`PREVENTED`	1. The microdeposit amounts provided by the end user were incorrect three times consecutively; the microdeposit verification cannot proceed. 2. The microdeposit has already been successfully verified, but an attempt is made to verify it again.
`9`	`PREINITIATED`	The microdeposit was created with client-provided `first_name`, `last_name`, and `email`.

Verification Fields

Field name	Data type	Definition
`account_name`	String	The name of the account associated with the verification.
`account_number`	String	The account number of the account associated with the verification.
`account_number_guid`	String	The unique identifier for the account associated with the verification. Defined by MX.
`account_type`	Integer	The general or parent type of the account. Possible values are `1` (CHECKING) and `2` (SAVINGS).
`account_type_name`	String	The name of the account type. Possible values are `CHECKING` and `SAVINGS`.
`created_at`	String	The date and time the verification was created, given in ISO 8601 format.
`institution_name`	String	The human-readable name of the institution associated with the verification.
`micro_deposit_guid`	String	The unique identifier for the microdeposit associated with this verification. Defined by MX.
`routing_number`	String	The routing number for the account associated with the verification.
`updated_at`	String	The date and time at which the verification was last updated, given in ISO 8601 format.
`verification_method`	Integer	The verification method used.
`verification_method_name`	String	The name of the verification method.
`verified_at`	String	When `"verification_method_name": "CREDENTIALS"`: The date and time at which the associated `account` was created. When `"verification_method_name": "MICRO_DESPOSIT"`: The date and time at which the associated microdeposit status changed from `DEPOSITED` to `VERIFIED`.

Verification Methods

Method	Method name
`0`	`CREDENTIALS`
`1`	`MICRO_DEPOSIT`

Read merchant location

Create or Preinitiate a Microdeposit