Transactions

Transaction webhooks notify you when a transaction is created, updated, or deleted in the MX system for any user on that partner's client.

Field	Data Type	Definition
account_guid	String	The unique identifier for the account. Defined by MX.
account_id	String	The unique partner-defined identifier for the account.
amount	Decimal	The transaction amount. This will always be a positive value. The Transaction Type determines how the transaction affects the account.
amount_set_by	String	The source that set the data
category_guid	String	The unique identifier for the transaction category. Defined by MX.
category_name	String	The name of the transaction category. Defined by MX.
category_set_by	String	The source that set the data.
check_number	String	The check number for the transaction.
check_number_set_by	String	The source that set the data
created_at	Integer	The date and time the transaction was created.
currency_code	String	The ISO 4217 three-character currency code (for example, USD).
currency_code_set_by	String	The source that set the data
date	Integer	The date the transaction was created.
date_set_by	String	The source that set the data
description	String	A human-readable description of the transaction.
description_set_by	String	The source that set the data
feed_amount	Decimal	Transaction amount, as provided by our data feed. See amount for more information.
feed_check_number	Integer	Check number, as provided by our data feed. See check_number for more information.
feed_currency_code	String	Currency code, as provided by our data feed. See currency_code for more information.
feed_description	String	Description of the transaction, as provided by our data feed. See description for more information.
feed_is_international	Boolean	Whether the transaction is international, as determined by the data provider. See is_international for more information.
feed_latitude	Decimal	Latitude for the transaction, as provided by our data feed. See latitude for more information.
feed_longitude	Decimal	Longitude for the transaction, as provided by our data feed. See longitude for more information.
feed_memo	String	The transaction memo, as provided by our data feed. See memo for more information.
feed_posted_at	Integer	The date and time the transaction was posted, as provided by our data feed.
feed_status	String	Status of the transaction, as provided by our data feed. Will be either POSTED or PENDING.
feed_transacted_at	Integer	The date and time the transaction took place, as provided by our data feed.
feed_transaction_type	String	The type of transaction, as provided by our data feed. See transaction_type for more information.
guid	String	The unique identifier for the transaction. Defined by MX.
id	String	The unique partner-defined identifier for the transaction.
has_been_split	Boolean	This indicates whether the transaction is a split.
has_been_viewed	Boolean	If the transaction has been viewed.
is_bill_pay	Boolean	This indicates whether the transaction is a bill pay.
is_direct_deposit	Boolean	This indicates whether the transaction is a direct deposit.
is_expense	Boolean	This indicates whether the transaction is an expense.
is_fee	Boolean	This indicates whether the transaction is a fee.
is_flagged	Boolean	This indicates whether the transaction is flagged.
is_hidden	Boolean	This indicates whether the transaction is hidden.
is_income	Boolean	This indicates whether the transaction is income.
is_international	Boolean.	This indicates whether the transaction is international (as determined by the data provider), this field will be true. Possible values are: true, false, or null. This field will only be set to true or false if the value is explicitly provided by the data provider. Otherwise it will be null.
is_international_set_by	String	The source that set the data This field will be null if the is_international field is null.
is_overdraft_fee	Boolean	This indicates whether the transaction is an overdraft fee.
is_payroll_advance	Boolean	This indicates whether the transaction is 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.
latitude	Decimal	The latitude of the location where the transaction occurred. The number is a signed decimal. Rio de Janeiro’s latitude is -22.9027800 and Tokyo’s latitude is 35.689488.
latitude_set_by	String	The source that set the data
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. Rio de Janeiro’s longitude is -43.2075000 and Tokyo’s longitude is 139.691706.
longitude_set_by	String	The source that set the data
member_guid	String	The unique identifier for the member the transaction is associated with. Defined by MX.
member_is_managed_by_user	Boolean	If the member the transaction belongs to is managed by the user this field will be true. Otherwise, the member is managed by the MX partner and this field will be false.
memo	String	The memo is additional descriptive information about the transaction.
memo_set_by	String	The source that set the data
merchant_category_code	String	The merchant category code.
merchant_guid	String	The unique identifier for the merchant associated with the transaction. Defined by MX.
merchant_location_guid	String	The unique identifier for the merchant location associated with the transaction. Defined by MX.
metadata	String	Additional information a partner can store on the transaction.
parent_guid	String	The parent GUID of the transaction.
posted_at	Integer	The date and time the transaction was posted.
posted_at_set_by	String	The source that set the data
revision	Integer	The revision number for the transaction.
scheduled_payment_guid	String	The unique identifier for the scheduled payment associated with this transaction. Defined by MX.
status	String	The status of the transaction. Will be either POSTED or PENDING.
status_set_by	String	The source that set the data
top_level_category_guid	String	The unique identifier of the parent category that this transaction’s category is assigned to.
top_level_category_name	String	The parent category assigned to this transaction's category.
transaction_type	String	The type of transaction (1 = CREDIT, 2 = DEBIT).
transaction_type_set_by	String	The source that set the data
transacted_at	Integer	The date and time the transaction took place.
transacted_at_set_by	String	The source that set the data
updated_at	Integer	The date and time the transaction was updated.
user_guid	String	The unique identifier for the user the transaction is attached to. Defined by MX.
user_id	String	The unique partner-defined identifier for the user.

Example Payload

_87

POST /admin/webhooks

_87

HTTP/1.1

_87

content-type: application/json; charset=utf-8

_87

accept: application/json

_87

User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2

_87

(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231

_87

Host: abc.com

_87

{

_87

"action": "updated",

_87

"transaction": {

_87

"account_guid": "ACT-9b295368-a4f1-4119-9057-67e57a7af31c",

_87

"account_id": "1008479116",

_87

"amount": 46.06,

_87

"amount_set_by": "FEED",

_87

"category_guid": "CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f",

_87

"category_name": "SHOPPING",

_87

"category_set_by": "SYSTEM",

_87

"check_number": null,

_87

"check_number_set_by": null,

_87

"currency_code": null,

_87

"currency_code_set_by": null,

_87

"created_at": 1587920713,

_87

"date": 1587902400,

_87

"date_set_by": "FEED",

_87

"description": "Amazon.com",

_87

"description_set_by": "SYSTEM",

_87

"feed_amount": 46.06,

_87

"feed_check_number": null,

_87

"feed_currency_code": null,

_87

"feed_description": "AMZN Mktp US*C36PF6W13",

_87

"feed_is_international": null,

_87

"feed_latitude": null,

_87

"feed_longitude": null,

_87

"feed_memo": null,

_87

"feed_posted_at": 1587898800,

_87

"feed_status": 1,

_87

"feed_transacted_at": 1587898800,

_87

"feed_transaction_type": "DEBIT",

_87

"guid": "TRN-cb363ca3-3608-4c72-b69f-3fc6e60547f2",

_87

"id": "101854670493",

_87

"has_been_split": false,

_87

"has_been_viewed": false,

_87

"is_bill_pay": false,

_87

"is_direct_deposit": null,

_87

"is_expense": true,

_87

"is_fee": false,

_87

"is_flagged": false,

_87

"is_hidden": false,

_87

"is_income": false,

_87

"is_international": null,

_87

"is_international_set_by": null,

_87

"is_overdraft_fee": null,

_87

"is_payroll_advance": null,

_87

"is_recurring": null,

_87

"is_subscription": null,

_87

"latitude": null,

_87

"latitude_set_by": null,

_87

"localized_description": null,

_87

"localized_memo": null,

_87

"longitude": null,

_87

"longitude_set_by": null,

_87

"member_guid": "MBR-5404e8d0-50b0-4d51-9b05-6213d70e8a49",

_87

"member_is_managed_by_user": true,

_87

"memo": null,

_87

"memo_set_by": null,

_87

"merchant_category_code": null,

_87

"merchant_guid": "MCH-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a",

_87

"merchant_location_guid": "MCL-1a50a9d7-5c66-4ca9-b193-0ad57da57095",

_87

"metadata": null,

_87

"parent_guid": null,

_87

"posted_at": 1587898800,

_87

"posted_at_set_by": "FEED",

_87

"scheduled_payment_guid": null,

_87

"status": "POSTED",

_87

"status_set_by": "FEED",

_87

"top_level_category_name": "SHOPPING",

_87

"top_level_category_guid": "CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f",

_87

"transaction_type": "DEBIT",

_87

"transaction_type_set_by": "FEED",

_87

"transacted_at": 1587898800,

_87

"transacted_at_set_by": "FEED",

_87

"user_id": "u-12345",

_87

"user_guid": "USR-0b001ddc-f759-4759-bd36-96c9fb903070",

_87

"revision": 2,

_87

"updated_at": 1587920715

_87

}

_87

}