curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/micro_deposits \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "micro_deposit": {
    "account_name": "My test account",
    "account_number": "3331261",
    "account_type": "CHECKING",
    "email": "example@example.com",
    "first_name": "Josh",
    "last_name": "Grobanne",
    "routing_number": "091000019"
  }
}
'

{
  "micro_deposit": {
    "account_name": "My test account",
    "account_number": "3331261",
    "account_type": "CHECKING",
    "email": "example@example.com",
    "first_name": "Josh",
    "last_name": "Grobanne",
    "routing_number": "091000019",
    "created_at": "2024-01-15T12:00:00+00:00",
    "error_code": "R03",
    "error_message": null,
    "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
    "institution_code": "mxbank",
    "institution_name": "MX Bank",
    "status": "INITIATED",
    "updated_at": "2025-02-13T18:09:00+00:00",
    "verified_at": null
  }
}

Microdeposits

Create or pre-initiate a microdeposit

Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of INITIATED or PREINITIATED respectively.

To pre-initiate a microdeposit, you only need to set email (string), first_name (string), and last_name (string) in the request body.

Pre-initiating a microdeposit allows you to pass the end user’s first name, last name, and email if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated micro_deposit will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated micro_deposit will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-initiating, make sure to set the current_microdeposit_guid to the resulting microdeposit’s guid and set data_request.products to include account_verification. If you use this enhanced flow, a micro_deposit should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as current_microdeposit_guid and set data_request.products to include account_verification when requesting a Connect URL. Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.

POST

users

{user_guid}

micro_deposits

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/micro_deposits \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "micro_deposit": {
    "account_name": "My test account",
    "account_number": "3331261",
    "account_type": "CHECKING",
    "email": "example@example.com",
    "first_name": "Josh",
    "last_name": "Grobanne",
    "routing_number": "091000019"
  }
}
'

{
  "micro_deposit": {
    "account_name": "My test account",
    "account_number": "3331261",
    "account_type": "CHECKING",
    "email": "example@example.com",
    "first_name": "Josh",
    "last_name": "Grobanne",
    "routing_number": "091000019",
    "created_at": "2024-01-15T12:00:00+00:00",
    "error_code": "R03",
    "error_message": null,
    "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
    "institution_code": "mxbank",
    "institution_name": "MX Bank",
    "status": "INITIATED",
    "updated_at": "2025-02-13T18:09:00+00:00",
    "verified_at": null
  }
}

Authorizations

Authorization

string

header

required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:

-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20260929

required

MX Platform API version.

Example:

"v20260929"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Body

application/json

micro_deposit

object

required

Setting account_number creates a microdeposit, and then account_type, routing_number, email, first_name and last_name are also required. Omit account_number to pre-initiate one with only email, first_name and last_name.

Hide child attributes

micro_deposit.account_name

string | null

The human-readable name for the account.

Example:

"My test account"

micro_deposit.account_number

string | null

conditionally required

The account number associated with the account. This will typically be a masked or partial account number.

Example:

"3331261"

micro_deposit.account_type

enum<string>

conditionally required

The type of account. Microdeposits support checking and savings accounts.

Available options:

CHECKING,

SAVINGS

Example:

"CHECKING"

micro_deposit.email

string

conditionally required

The email address associated with the account.

Example:

"example@example.com"

micro_deposit.first_name

string

conditionally required

The account owner's first name. This may also include a middle name. This field returns null if the first name can't be derived from the entity (such as a business or trust) or if name splitting isn't enabled. To enable name splitting, contact MX.

Example:

"Josh"

micro_deposit.last_name

string

conditionally required

The account owner's last name. This field returns null if the last name can't be derived from the entity (such as a business or trust) or if name splitting isn't enabled. To enable name splitting, contact MX.

Example:

"Grobanne"

micro_deposit.routing_number

string | null

conditionally required

The routing number for the account.

Example:

"091000019"

Response

200 - application/json

micro_deposit

object

required

Hide child attributes

micro_deposit.account_name

string | null

required

The human-readable name for the account.

Example:

"My test account"

micro_deposit.account_number

string | null

required

The account number associated with the account. This will typically be a masked or partial account number.

Example:

"3331261"

micro_deposit.account_type

enum<string> | null

required

The type of account. UNKNOWN or null until account details are provided, such as on a pre-initiated microdeposit.

Available options:

CHECKING,

SAVINGS,

UNKNOWN,

null

Example:

"CHECKING"

micro_deposit.email

string

required

The email address associated with the account.

Example:

"example@example.com"

micro_deposit.first_name

string

required

Example:

"Josh"

micro_deposit.last_name

string

required

Example:

"Grobanne"

micro_deposit.routing_number

string | null

required

The routing number for the account.

Example:

"091000019"

micro_deposit.created_at

string | null

required

The date and time the microdeposit was created, in ISO 8601 format with a timestamp.

Example:

"2024-01-15T12:00:00+00:00"

micro_deposit.error_code

string | null

required

A code describing an error that occurred.

Example:

"R03"

micro_deposit.error_message

string | null

required

A message describing an error that occurred.

Example:

null

micro_deposit.guid

string

required

The unique identifier for the microdeposit. Defined by MX.

Example:

"MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb"

micro_deposit.institution_code

string | null

required

The code identifying a financial institution.

Example:

"mxbank"

micro_deposit.institution_name

string | null

required

An easy-to-read name for an institution. May be null for institutions that are not in the MX system.

Example:

"MX Bank"

micro_deposit.status

string

required

The name of the current status. See Microdeposit Statuses.

Example:

"INITIATED"

micro_deposit.updated_at

string

required

The date and time the resource was last updated in ISO 8601 format with a timestamp.

For categories, this field will always be null when is_default is true.

Example:

"2025-02-13T18:09:00+00:00"

micro_deposit.verified_at

string | null

required

The date and time at which the microdeposit status changed from DEPOSITED to VERIFIED.

Example:

null