Verify a microdeposit - MX Documentation

Verify a Microdeposit

curl --request PUT \
  --url https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "micro_deposit": {
    "deposit_amount_1": 0.12,
    "deposit_amount_2": 0.15
  }
}
'

import requests

url = "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify"

payload = { "micro_deposit": {
        "deposit_amount_1": 0.12,
        "deposit_amount_2": 0.15
    } }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({micro_deposit: {deposit_amount_1: 0.12, deposit_amount_2: 0.15}})
};

fetch('https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'micro_deposit' => [
        'deposit_amount_1' => 0.12,
        'deposit_amount_2' => 0.15
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify"

	payload := strings.NewReader("{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "micro_deposit": [
    {
      "account_number": "3331261",
      "account_type": "CHECKING",
      "routing_number": "091000019",
      "account_name": "My test account",
      "email": "example@example.com",
      "first_name": "Josh",
      "last_name": "Grobanne",
      "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
    }
  ]
}

PUT

micro_deposits

{micro_deposit_guid}

verify

Verify a Microdeposit

curl --request PUT \
  --url https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "micro_deposit": {
    "deposit_amount_1": 0.12,
    "deposit_amount_2": 0.15
  }
}
'

import requests

url = "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify"

payload = { "micro_deposit": {
        "deposit_amount_1": 0.12,
        "deposit_amount_2": 0.15
    } }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({micro_deposit: {deposit_amount_1: 0.12, deposit_amount_2: 0.15}})
};

fetch('https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'micro_deposit' => [
        'deposit_amount_1' => 0.12,
        'deposit_amount_2' => 0.15
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify"

	payload := strings.NewReader("{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/micro_deposits/{micro_deposit_guid}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"micro_deposit\": {\n    \"deposit_amount_1\": 0.12,\n    \"deposit_amount_2\": 0.15\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "micro_deposit": [
    {
      "account_number": "3331261",
      "account_type": "CHECKING",
      "routing_number": "091000019",
      "account_name": "My test account",
      "email": "example@example.com",
      "first_name": "Josh",
      "last_name": "Grobanne",
      "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:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

micro_deposit_guid

string

required

The unique identifier for the microdeposit. Defined by MX.

Body

application/json

micro_deposit

object

Hide child attributes

micro_deposit.deposit_amount_1

number

The amount of the first microdeposit sent for account verification.

Example:

0.12

micro_deposit.deposit_amount_2

number

The amount of the second microdeposit sent for account verification.

Example:

0.15

Response

200 - application/json

micro_deposit

object[]

Hide child attributes

micro_deposit.account_number

string

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. Some account types may include subtypes.

Available options:

ANY,

CASH,

CHECKING,

CHECKING_LINE_OF_CREDIT,

CREDIT_CARD,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY

Example:

"CHECKING"

micro_deposit.routing_number

string

required

The routing number for the account.

Example:

"091000019"

micro_deposit.account_name

string

The human-readable name for the account.

Example:

"My test account"

micro_deposit.email

string

The email address associated with the account.

Example:

"example@example.com"

micro_deposit.first_name

string

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

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.error_message

string | null

A message describing an error that occurred.

Example:

null

micro_deposit.guid

string

The unique identifier for the microdeposit. Defined by MX.

Example:

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

micro_deposit.institution_code

string

The code identifying a financial institution.

Example:

"mxbank"

micro_deposit.institution_name

string

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

The name of the current status. See Microdeposit Statuses.

Example:

"INITIATED"

micro_deposit.updated_at

string

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

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

Example:

null