Create or Preinitiate a Microdeposit

curl --request POST \
  --url https://int-data.moneydesktop.com/micro_deposits \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

{
  "micro_deposit": {
    "account_name": "My Test Account",
    "account_number": "333312345",
    "account_type": 1,
    "account_type_name": "CHECKING",
    "created_at": "2021-09-01T18:29:06.000Z",
    "email": "example@example.com",
    "error_code": null,
    "error_message": null,
    "first_name": "Josh",
    "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
    "institution_name": "MX Bank",
    "last_name": "James",
    "routing_number": 91000019,
    "status": 1,
    "status_name": "REQUESTED",
    "updated_at": "2021-09-01T18:29:07.000Z",
    "verified_at": "2021-09-01T18:29:07.000Z"
  }
}

Microdeposits

Create or Preinitiate a Microdeposit

Use this endpoint to create a microdeposit. To create a microdeposit include the first_name, last_name, email, account_number, routing_number, and account_type in the request body. The response will include the new microdeposit record with a status of INITIATED.
You can also use this endpoint to pre-initiate a microdeposit. If you want to preinitiate only include the first_name, last_name, and email in the request body. The response will include the new microdeposit record with a status of PREINITIATED.
Pre-initiating a microdeposit is optional. However, if you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.
Pre-initiating a microdeposit enables 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-inititiating, make sure to set the current_microdeposit_guid to the resulting microdeposit’s guid and set the mode to verification.

POST

micro_deposits

curl --request POST \
  --url https://int-data.moneydesktop.com/micro_deposits \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

{
  "micro_deposit": {
    "account_name": "My Test Account",
    "account_number": "333312345",
    "account_type": 1,
    "account_type_name": "CHECKING",
    "created_at": "2021-09-01T18:29:06.000Z",
    "email": "example@example.com",
    "error_code": null,
    "error_message": null,
    "first_name": "Josh",
    "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
    "institution_name": "MX Bank",
    "last_name": "James",
    "routing_number": 91000019,
    "status": 1,
    "status_name": "REQUESTED",
    "updated_at": "2021-09-01T18:29:07.000Z",
    "verified_at": "2021-09-01T18:29:07.000Z"
  }
}

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Body

application/vnd.mx.nexus.v1+json

micro_deposit

object

Hide child attributes

micro_deposit.account_number

string

required

The account number of the account associated with the microdeposit.

micro_deposit.account_type_name

string

required

The name of the account type. Possible values are CHECKING and SAVINGS.

micro_deposit.routing_number

string

required

The routing number for the account associated with the microdeposit.

micro_deposit.first_name

string

The end user's first name.

micro_deposit.last_name

string

The end user's last name.

micro_deposit.email

string

The end user's email address.

micro_deposit.account_name

string

The name of the account associated with the verification.

Response

200 - application/vnd.mx.nexus.v1+json

Option 1
Option 2

micro_deposit

object

Hide child attributes

micro_deposit.account_name

string

The name of the account associated with the verification.

Example:

"My Test Account"

micro_deposit.account_number

string

The account number of the account associated with the microdeposit.

Example:

"333312345"

micro_deposit.account_type

integer

The general or parent type of the account associated with the microdeposit. Possible values are 1 (CHECKING) and 2 (SAVINGS).

Example:

1

micro_deposit.account_type_name

string

The name of the account type. Possible values are CHECKING and SAVINGS.

Example:

"CHECKING"

micro_deposit.created_at

string

The date and time the microdeposit was created, given in ISO 8601 format.

Example:

"2021-09-01T18:29:06.000Z"

micro_deposit.email

string

The end user's email address.

Example:

"example@example.com"

micro_deposit.error_code

string

The code for the error.

Example:

null

micro_deposit.error_message

string

A message explaining the error.

Example:

null

micro_deposit.first_name

string

The end user's first name.

Example:

"Josh"

micro_deposit.guid

string

The unique identifier for the microdeposit. Defined by MX.

Example:

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

micro_deposit.institution_name

string

An easy-to-read name for an institution associated with the microdeposit, e.g., "Chase Bank" or "Wells Fargo Bank."

Example:

"MX Bank"

micro_deposit.last_name

string

The end user's last name.

Example:

"James"

micro_deposit.routing_number

string

The routing number for the account associated with the microdeposit.

Example:

91000019

micro_deposit.status

integer

The current status of the microdeposit.

Example:

1

micro_deposit.status_name

string

The name of the current status.

Example:

"REQUESTED"

micro_deposit.updated_at

string

The date and time at which the microdeposit was last updated, given in ISO 8601 format.

Example:

"2021-09-01T18:29:07.000Z"

micro_deposit.verified_at

string

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

Example:

"2021-09-01T18:29:07.000Z"

Microdeposits Overview

List all microdeposits for a user