Transactions

Transaction Fields

Field	Data type	Description
account_guid	String	The unique identifier for the account associated with the transaction. Defined by MX.
account_id	String	The unique partner-defined identifier for the account associated with the transaction. This can only be set for partner-managed accounts. It should be ignored for user-managed transactions, even in occasional cases where it may return with a value.
amount	Decimal	The monetary amount of the transaction.
business_category	String	The name of the business category assigned to this transaction. This field only appears in the response when the business suite has been enabled.
business_category_guid	String	The unique identifier for the business category assigned to this transaction. Defined by MX. This field only appears in the response when the business suite has been enabled.
category	String	The category of the transaction.
category_guid	String	The unique identifier for the category assigned to the transaction.
check_number_string	String	The check number for the transaction.
created_at	String	The date and time the transaction was created.
currency_code	String	The three-character ISO 4217 currency code, e.g. USD.
date	String	The date on which the transaction took place. This is the field used when searching for transactions by date. This field is generally the same as transacted_at, but uses posted_at as a fallback.
description	String	A human-readable version of the original_description field described below. This is provided by the MX Platform.
guid	String	The unique identifier for the transaction. Defined by MX.
id	String	The unique partner-defined identifier for the transaction. This can only be set for partner-managed transactions. It should be ignored for user-managed transactions, even in occasional cases where it may return with a value.
is_bill_pay	Boolean	This indicates whether the transaction represents a bill pay.
is_business	Boolean	This indicates whether the transaction is for business or personal purposes. This field defaults to true when the associated account is set to "is_business: "true", and false otherwise. This field only appears in the response when the business suite has been enabled.
is_direct_deposit	Boolean	This indicates whether the transaction represents a direct deposit.
is_expense	Boolean	This indicates whether the transaction represents an expense.
is_fee	Boolean	This indicates whether the transaction represents a fee.
is_income	Boolean	This indicates whether the transaction represents income.
is_international	Boolean	If the transaction is international as defined by the data provider, this field will be true. If the data provider determines it is not international then it will be false. It will be null if the data provider does not have this information.
is_overdraft_fee	Boolean	This indicates whether the transaction represents an overdraft fee.
is_payroll_advance	Boolean	This indicates whether the transaction represents a payroll advance.
is_recurring	Boolean	This field should be ignored. If this information is required, please reach out to MX to discuss an alternative.
is_subscription	Boolean	This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible.
latitude	Decimal	The latitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's latitude is -22.9027800 and Tokyo's latitude is 35.689488).
localized_description	String	A human-readable description of the transaction, provided in a local language.
localized_memo	String	Additional descriptive information about the transaction, provided in a local language.
longitude	Decimal	The longitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706).
member_guid	String	The unique identifier for the member associated with the transaction Defined by MX.
member_is_managed_by_user	Boolean	This indicates whether the associated member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
memo	String	This field contains additional descriptive information about the transaction.
merchant_category_code	Integer	The ISO 18245 category code for the transaction.
merchant_guid	String	The unique identifier for the merchant associated with this transaction. Defined by MX.
merchant_location_guid	String	The unique identifier for the merchant_location associated with this transaction. Defined by MX.
original_description	String	The original description of the transaction as provided by our data feed. See description above for more information.
posted_at	String	The date and time the transaction was posted to the account.
status	String	The status of the transaction. This will be either POSTED or PENDING.
top_level_category	String	The parent category assigned to this transaction's category.
transacted_at	String	The date and time the transaction took place.
type	String	The type of transaction. This will be either CREDIT or DEBIT.
updated_at	String	The date and time the transaction was last updated.
user_guid	String	The unique identifier for the user associated with this transaction. Defined by MX.
user_id	String	The unique partner-defined identifier for the user associated with the transaction.

List All Transactions for a User

Requests to this endpoint return a list of transactions associated with the specified user, across all members and accounts associated with that user.

Query String Parameters

Field Name	Required	Data Type	Description
from_date	No	String	Return transactions occurring within a date range starting on this day. If not set, this defaults to 90 days prior to the day of the request. Must be in ISO 8601 format without a time component.
to_date	No	String	Return transactions occurring in a date range ending on this day. If not set, this defaults to 5 days forward from the day of the request so as to capture pending transactions. Must be in ISO 8601 format without a time component.

Endpoint: GET /users/{user_guid}/transactions

Request

Response

Language:shell

_10

curl -i -X GET 'https://int-api.mx.com/users/USR-fa7537f3-48aa-a683-a02a-b18940482f54/transactions?from_date=2015-09-20&page=1&records_per_page=10&to_date=2019-10-20' \

_10

-H 'Accept: application/vnd.mx.api.v1+json' \

_10

-u 'client_id:api_key'

Read a Transaction

Requests to this endpoint will return the attributes of the specified transaction.

Endpoint: GET /users/{user_guid}/transactions/{transaction_guid}

Request

Response

Language:shell

_10

curl -i -X GET 'https://int-api.mx.com/users/USR-fa7537f3-48aa-a683-a02a-b18940482f54/transactions/TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' \

_10

-H 'Accept: application/vnd.mx.api.v1+json' \

_10

-u 'client_id:api_key'

Update a Transaction

Use this endpoint to update various attributes of a specific transaction according to its unique GUID.

Parameters

Parameter	Required?
description	No
is_business	No

Endpoint: PUT /users/{user_guid}/transactions/{transaction_guid}

Request

Response

Language:shell

_10

curl -i -X PUT 'https://int-api.mx.com/users/USR-fa7537f3-48aa-a683-a02a-b18940482f54/transactions/TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' \

_10

-H 'Accept: application/vnd.mx.api.v1+json' \

_10

-H 'Content-Type: application/json' \

_10

-u 'client_id:api_key' \

_10

-d '{

_10

"transaction": {

_10

"description": "new description"

_10

}

_10

}'