Transactions - MX Documentation

Transactions webhooks notify you when a transaction is created, updated, or deleted in the MX system for any user in the client. The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

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` field determines how the transaction affects the account.
`amount_set_by`	String	The source that set the data for the amount.
`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 for the category.
`check_number`	String	The check number for the transaction.
`check_number_set_by`	String	The source that set the data for the check number.
`created_at`	Integer	The date and time when the transaction was created.
`currency_code`	String	The ISO 4217 currency code.
`currency_code_set_by`	String	The source that set the data for the currency code.
`date`	Integer	The date the transaction was created.
`date_set_by`	String	The source that set the data for the date.
`description`	String	A human-readable description of the transaction.
`description_set_by`	String	The source that set the data for the description.
`feed_amount`	Decimal	The transaction amount, as provided by our data feed. See `amount` for more information.
`feed_check_number`	Integer	The check number, as provided by our data feed. See `check_number` for more information.
`feed_currency_code`	String	The currency code, as provided by our data feed. See `currency_code` for more information.
`feed_description`	String	The 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	The latitude of the location where the transaction occurred, as provided by our data feed. See `latitude` for more information.
`feed_longitude`	Decimal	The longitude of the location where the transaction occurred, 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 when the transaction was posted, as provided by our data feed.
`feed_status`	String	The status of the transaction, as provided by our data feed. Possible values include `POSTED` and `PENDING`.
`feed_transacted_at`	Integer	The date and time when the transaction occurred, 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	Whether the transaction is a split.
`has_been_viewed`	Boolean	Whether the transaction has been viewed.
`is_bill_pay`	Boolean	Whether the transaction is a bill pay.
`is_direct_deposit`	Boolean	Whether the transaction is a direct deposit.
`is_expense`	Boolean	Whether the transaction is an expense.
`is_fee`	Boolean	Whether the transaction is a fee.
`is_flagged`	Boolean	Whether the transaction is flagged.
`is_hidden`	Boolean	Whether the transaction is hidden.
`is_income`	Boolean	Whether the transaction is income.
`is_international`	Boolean.	Whether the transaction is international, as determined by the data provider. This field will only be set to `true` or `false` if the value is explicitly provided by the data provider. Otherwise, the value will be `null`.
`is_international_set_by`	String	The source that set the data for the international status. If the value of `is_international` is `null`, the value of this field will also be `null`.
`is_overdraft_fee`	Boolean	Whether the transaction is an overdraft fee.
`is_payroll_advance`	Boolean	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	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. For example, 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 for the latitude.
`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. For example, 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 for the longitude.
`member_guid`	String	The unique identifier for the member. Defined by MX.
`member_is_managed_by_user`	Boolean	Whether the member the transaction belongs to is managed by the user.
`memo`	String	Additional descriptive information about the transaction.
`memo_set_by`	String	The source that set the data for the memo.
`merchant_category_code`	String	The merchant category code.
`merchant_guid`	String	The unique identifier for the merchant. Defined by MX.
`merchant_location_guid`	String	The unique identifier for the merchant location. 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 when the transaction was posted.
`posted_at_set_by`	String	The source that set the data for the posted date and time of the transaction.
`revision`	Integer	The revision number for the transaction.
`scheduled_payment_guid`	String	The unique identifier for the scheduled payment. Defined by MX.
`status`	String	The status of the transaction. Possible values include `POSTED` and `PENDING`.
`status_set_by`	String	The source that set the data for the status of the transaction.
`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, where `1` is a credit and `2` is a debit.
`transaction_type_set_by`	String	The source that set the data for the transaction type.
`transacted_at`	Integer	The date and time when the transaction occurred.
`transacted_at_set_by`	String	The source that set the data for the transaction date and time.
`updated_at`	Integer	The date and time when 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

JSON

POST /admin/webhooks
HTTP/1.1
content-type: application/json; charset=utf-8
accept: application/json
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "action": "updated",
  "transaction": {
    "account_guid": "ACT-9b295368-a4f1-4119-9057-67e57a7af31c",
    "account_id": "1008479116",
    "amount": 46.06,
    "amount_set_by": "FEED",
    "category_guid": "CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f",
    "category_name": "SHOPPING",
    "category_set_by": "SYSTEM",
    "check_number": null,
    "check_number_set_by": null,
    "currency_code": null,
    "currency_code_set_by": null,
    "created_at": 1587920713,
    "date": 1587902400,
    "date_set_by": "FEED",
    "description": "Amazon.com",
    "description_set_by": "SYSTEM",
    "feed_amount": 46.06,
    "feed_check_number": null,
    "feed_currency_code": null,
    "feed_description": "AMZN Mktp US*C36PF6W13",
    "feed_is_international": null,
    "feed_latitude": null,
    "feed_longitude": null,
    "feed_memo": null,
    "feed_posted_at": 1587898800,
    "feed_status": 1,
    "feed_transacted_at": 1587898800,
    "feed_transaction_type": "DEBIT",
    "guid": "TRN-cb363ca3-3608-4c72-b69f-3fc6e60547f2",
    "id": "101854670493",
    "has_been_split": false,
    "has_been_viewed": false,
    "is_bill_pay": false,
    "is_direct_deposit": null,
    "is_expense": true,
    "is_fee": false,
    "is_flagged": false,
    "is_hidden": false,
    "is_income": false,
    "is_international": null,
    "is_international_set_by": null,
    "is_overdraft_fee": null,
    "is_payroll_advance": null,
    "is_recurring": null,
    "is_subscription": null,
    "latitude": null,
    "latitude_set_by": null,
    "localized_description": null,
    "localized_memo": null,
    "longitude": null,
    "longitude_set_by": null,
    "member_guid": "MBR-5404e8d0-50b0-4d51-9b05-6213d70e8a49",
    "member_is_managed_by_user": true,
    "memo": null,
    "memo_set_by": null,
    "merchant_category_code": null,
    "merchant_guid": "MCH-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a",
    "merchant_location_guid": "MCL-1a50a9d7-5c66-4ca9-b193-0ad57da57095",
    "metadata": null,
    "parent_guid": null,
    "posted_at": 1587898800,
    "posted_at_set_by": "FEED",
    "scheduled_payment_guid": null,
    "status": "POSTED",
    "status_set_by": "FEED",
    "top_level_category_name": "SHOPPING",
    "top_level_category_guid": "CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f",
    "transaction_type": "DEBIT",
    "transaction_type_set_by": "FEED",
    "transacted_at": 1587898800,
    "transacted_at_set_by": "FEED",
    "user_id": "u-12345",
    "user_guid": "USR-0b001ddc-f759-4759-bd36-96c9fb903070",
    "revision": 2,
    "updated_at": 1587920715
  }
}