Enhance Business Transactions
Use this endpoint to enhance your partner-provided transactional data. Each transaction you provide will be categorized, given a cleansed description, and possibly assigned one or more classifications, merchants, or merchant locations.
Enhanced transactions are not persisted or stored by MX. They are simply returned in their enhanced form. Enhanced transactions are returned with only a subset of the fields stored on persistent transactions.
info
This endpoint is limited to 100 transactions per request.
Enhanced Transaction Fields
| Field | Data Type | Definition |
|---|---|---|
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. |
categorized_by | Integer | The method used to determine the category assigned to the transaction. |
category | String | The category of the transaction. |
category_guid | String | The unique identifier for the category assigned to the transaction. |
described_by | Integer | The method used to describe the transaction. |
description | String | A human-readable version of the original_description field described below, e.g., "Sam's Club," "Johnny's Tavern." This is provided by the MX Platform. |
extended_transaction_type | String | The transaction type assigned by the partner. |
id | String | The unique partner-defined identifier for the transaction. |
is_bill_pay | Boolean | This indicates whether the transaction represents a bill pay. |
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_subscription | Boolean | This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible. |
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. |
type | String | The type of transaction. This will be either CREDIT or DEBIT. |
Endpoint: POST /transactions/enhance
Parameters
| Field Name | Required? |
|---|---|
amount | No |
description | Yes |
extended_transaction_type | No |
id | Yes |
merchant_category_code | No |
type | No |
Language:shell