Read transaction

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}', 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/users/{user_guid}/transactions/{transaction_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "transactions": [
    {
      "account_guid": "ACT-0af29528-bb91-447f-b5de-85c1c42593e5",
      "account_id": "FdvkkAgLS0nbDNUujrblz6rYDSl5w-tTLwYRgIxe7jw",
      "amount": 5003.9,
      "category": "Paycheck",
      "category_guid": "CAT-982ea9e6-3f0e-0c5b-611b-6657a10ba819",
      "check_number_string": null,
      "created_at": "2024-12-20T18:52:36Z",
      "currency_code": null,
      "date": "2024-12-20",
      "description": "MX Technologies",
      "extended_transaction_type": null,
      "guid": "TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1",
      "id": "1734681600000-178fa8095c154a55b9172f977b4c5f9a-0",
      "is_bill_pay": false,
      "is_direct_deposit": false,
      "is_expense": false,
      "is_fee": false,
      "is_income": true,
      "is_international": null,
      "is_manual": false,
      "is_overdraft_fee": false,
      "is_payroll_advance": false,
      "is_recurring": null,
      "is_subscription": false,
      "latitude": null,
      "localized_description": null,
      "localized_memo": null,
      "longitude": null,
      "member_guid": "MBR-78b14c5f-7297-4fb5-a966-65ac45f74d8",
      "member_is_managed_by_user": true,
      "memo": "Transactions",
      "merchant_category_code": null,
      "merchant_guid": "MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1",
      "merchant_location_guid": null,
      "metadata": null,
      "original_description": "MX TECHNOLOGIES PAYMENT",
      "posted_at": "2024-12-20T12:00:00Z",
      "status": "POSTED",
      "top_level_category": "Income",
      "transacted_at": "2024-12-20T12:00:00Z",
      "type": "CREDIT",
      "updated_at": "2024-12-20T18:52:38Z",
      "user_guid": "USR-ef7a82f6-d6c1-42c4-9061-bdece5c4d44e",
      "user_id": null,
      "classification": {
        "parent_class": "Deposit",
        "guid": "MNC-3ad50f86-60d0-4545-a1f9-e66c2ac40f69"
      },
      "geolocation": {
        "country": "us",
        "state": "UT",
        "city": "lehi",
        "postal code": "84043"
      },
      "merchant": {
        "name": "MX",
        "guid": "MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84",
        "logo_url": "https://content.mx.com/logos/merchants/MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84.png",
        "website_url": "https://www.mx.com"
      },
      "repeating_transaction": {
        "recurrence_type": "EVERY_OTHER_WEEK",
        "guid": "RPT-065b8b1d-826a-45ce-8487-60ca1510e72a"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

GET

users

{user_guid}

transactions

{transaction_guid}

Read transaction

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}', 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/users/{user_guid}/transactions/{transaction_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/transactions/{transaction_guid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "transactions": [
    {
      "account_guid": "ACT-0af29528-bb91-447f-b5de-85c1c42593e5",
      "account_id": "FdvkkAgLS0nbDNUujrblz6rYDSl5w-tTLwYRgIxe7jw",
      "amount": 5003.9,
      "category": "Paycheck",
      "category_guid": "CAT-982ea9e6-3f0e-0c5b-611b-6657a10ba819",
      "check_number_string": null,
      "created_at": "2024-12-20T18:52:36Z",
      "currency_code": null,
      "date": "2024-12-20",
      "description": "MX Technologies",
      "extended_transaction_type": null,
      "guid": "TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1",
      "id": "1734681600000-178fa8095c154a55b9172f977b4c5f9a-0",
      "is_bill_pay": false,
      "is_direct_deposit": false,
      "is_expense": false,
      "is_fee": false,
      "is_income": true,
      "is_international": null,
      "is_manual": false,
      "is_overdraft_fee": false,
      "is_payroll_advance": false,
      "is_recurring": null,
      "is_subscription": false,
      "latitude": null,
      "localized_description": null,
      "localized_memo": null,
      "longitude": null,
      "member_guid": "MBR-78b14c5f-7297-4fb5-a966-65ac45f74d8",
      "member_is_managed_by_user": true,
      "memo": "Transactions",
      "merchant_category_code": null,
      "merchant_guid": "MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1",
      "merchant_location_guid": null,
      "metadata": null,
      "original_description": "MX TECHNOLOGIES PAYMENT",
      "posted_at": "2024-12-20T12:00:00Z",
      "status": "POSTED",
      "top_level_category": "Income",
      "transacted_at": "2024-12-20T12:00:00Z",
      "type": "CREDIT",
      "updated_at": "2024-12-20T18:52:38Z",
      "user_guid": "USR-ef7a82f6-d6c1-42c4-9061-bdece5c4d44e",
      "user_id": null,
      "classification": {
        "parent_class": "Deposit",
        "guid": "MNC-3ad50f86-60d0-4545-a1f9-e66c2ac40f69"
      },
      "geolocation": {
        "country": "us",
        "state": "UT",
        "city": "lehi",
        "postal code": "84043"
      },
      "merchant": {
        "name": "MX",
        "guid": "MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84",
        "logo_url": "https://content.mx.com/logos/merchants/MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84.png",
        "website_url": "https://www.mx.com"
      },
      "repeating_transaction": {
        "recurrence_type": "EVERY_OTHER_WEEK",
        "guid": "RPT-065b8b1d-826a-45ce-8487-60ca1510e72a"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Requests to this endpoint will return the attributes of the specified transaction. To read a manual transaction, use the manual transaction guid in the path as the transactionGuid.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the Optional Enhancement Query Parameter guide.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

user_guid

string

required

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

transaction_guid

string

required

The unique id for a transaction.

Query Parameters

includes

string

Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications,geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).
Merchants: Enriches transactions with merchant name.
Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.
Geolocation: Provides geographic metadata.

Response

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

transactions

object[]

Hide child attributes

transactions.account_guid

string | null

Example:

"ACT-0af29528-bb91-447f-b5de-85c1c42593e5"

transactions.account_id

string | null

Example:

"FdvkkAgLS0nbDNUujrblz6rYDSl5w-tTLwYRgIxe7jw"

transactions.amount

number | null

Example:

5003.9

transactions.category

string | null

Example:

"Paycheck"

transactions.category_guid

string | null

Example:

"CAT-982ea9e6-3f0e-0c5b-611b-6657a10ba819"

transactions.check_number_string

string | null

Example:

null

transactions.created_at

string | null

Example:

"2024-12-20T18:52:36Z"

transactions.currency_code

string | null

Example:

null

transactions.date

string | null

Example:

"2024-12-20"

transactions.description

string | null

Example:

"MX Technologies"

transactions.extended_transaction_type

string | null

Example:

null

transactions.guid

string | null

Example:

"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1"

transactions.id

string | null

Example:

"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0"

transactions.is_bill_pay

boolean | null

Example:

false

transactions.is_direct_deposit

boolean | null

Example:

false

transactions.is_expense

boolean | null

Example:

false

transactions.is_fee

boolean | null

Example:

false

transactions.is_income

boolean | null

Example:

true

transactions.is_international

boolean | null

Example:

null

transactions.is_manual

boolean | null

Example:

false

transactions.is_overdraft_fee

boolean | null

Example:

false

transactions.is_payroll_advance

boolean | null

Example:

false

transactions.is_recurring

boolean | null

Example:

null

transactions.is_subscription

boolean | null

Example:

false

transactions.latitude

number | null

Example:

null

transactions.localized_description

string | null

Example:

null

transactions.localized_memo

string | null

Example:

null

transactions.longitude

number | null

Example:

null

transactions.member_guid

string | null

Example:

"MBR-78b14c5f-7297-4fb5-a966-65ac45f74d8"

transactions.member_is_managed_by_user

boolean | null

Example:

true

transactions.memo

string | null

Example:

"Transactions"

transactions.merchant_category_code

integer | null

Example:

null

transactions.merchant_guid

string | null

Example:

"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1"

transactions.merchant_location_guid

string | null

Example:

null

transactions.metadata

string | null

Example:

null

transactions.original_description

string | null

Example:

"MX TECHNOLOGIES PAYMENT"

transactions.posted_at

string | null

Example:

"2024-12-20T12:00:00Z"

transactions.status

string | null

Example:

"POSTED"

transactions.top_level_category

string | null

Example:

"Income"

transactions.transacted_at

string | null

Example:

"2024-12-20T12:00:00Z"

transactions.type

string | null

Example:

"CREDIT"

transactions.updated_at

string | null

Example:

"2024-12-20T18:52:38Z"

transactions.user_guid

string | null

Example:

"USR-ef7a82f6-d6c1-42c4-9061-bdece5c4d44e"

transactions.user_id

string | null

Example:

null

transactions.classification

object | null

Hide child attributes

transactions.classification.parent_class

enum<string>

Available options:

Payroll,

Deposit,

Savings,

Transfer,

Refunds,

Spend,

Investment,

Buy,

Sell,

Income,

Fees,

Expenses,

Corporate Actions,

Other

Example:

"Deposit"

transactions.classification.guid

string

Example:

"MNC-3ad50f86-60d0-4545-a1f9-e66c2ac40f69"

transactions.geolocation

object | null

Hide child attributes

transactions.geolocation.country

string

Example:

"us"

transactions.geolocation.state

string

Example:

"UT"

transactions.geolocation.city

string

Example:

"lehi"

transactions.geolocation.postal code

string

Example:

"84043"

transactions.merchant

object | null

Hide child attributes

transactions.merchant.name

string

Example:

"MX"

transactions.merchant.guid

string

Example:

"MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84"

transactions.merchant.logo_url

string

Example:

"https://content.mx.com/logos/merchants/MCH-0c25f895-393c-42a4-9c18-95a0b26d4d84.png"

transactions.merchant.website_url

string

Example:

"https://www.mx.com"

transactions.repeating_transaction

object | null

Hide child attributes

transactions.repeating_transaction.repeating_transaction_type

enum<string>

Available options:

BILL,

SUBSCRIPTION,

INCOME,

UNKNOWN

transactions.repeating_transaction.recurrence_type

enum<string>

Available options:

EVERY_OTHER_WEEK

transactions.repeating_transaction.guid

string

Example:

"RPT-065b8b1d-826a-45ce-8487-60ca1510e72a"

pagination

object

Hide child attributes

pagination.current_page

integer

Example:

1

pagination.per_page

integer

Example:

25

pagination.total_entries

integer

Example:

1

pagination.total_pages

integer

Example:

1

List transactions

Update transaction