A member represents the relationship between a user and an institution. A user may have multiple members, one each for their bank, their mortgage broker, their credit card provider, etc. Aggregation, verification, and many other processes are centered around a member, meaning this is probably the most important type of object you’ll be working with.
A transaction rule allows partners to specify a match_description
and a category
; all transactions matching the specified description will be placed in the chosen category.
Transaction rules override the default category
MX gives to a transaction
. Once a rule is created, all past transactions with a matching cleansed description
are placed in the partner-chosen category
, and any future transactions will be placed in the chosen category as well.
For example, creating a rule with the match_description
“Wal-mart” and the category_guid
for “Groceries” will automatically apply that category_guid
to any transaction
with a matching description
, including both existing and future transactions.
Partners may also provide an optional description
when creating or updating a transaction_rule
. This string will replace all matched transactions’ description
value.
Endpoint: DELETE
/users/:user_guid/transaction_rules/:transaction_rule_guid
Use this endpoint to permanently delete a transaction rule based on its unique GUID.
curl -X DELETE /users/:user_guid/transaction_rules/:transaction_rule_guid \\
-H 'Content-Type: application/json' \\
-H "Authorization: Bearer {access_token}" \\
Endpoint: GET
/users/:user_guid/transaction_rules/:transaction_rule_guid
This endpoint is used to read the attributes of an existing transaction rule based on the rule’s unique GUID.