Read a microdeposit - MX Documentation

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.

Path Parameters

micro_deposit_guid

string

required

The unique identifier for a microdeposit. Defined by MX.

Response

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

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"