Atrium API
Transactions
A transaction represents any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, etc. Each transaction belongs to only one account.
Transaction Fields
| Field Name | Data Type | Description |
|---|---|---|
account_guid | String | A unique identifier for the account to which the transaction belongs. Defined by MX. |
amount | Decimal | The monetary amount of the transaction. Max length is 10,2. |
category | String | The category of the transaction. |
check_number | Integer | DEPRECATED. Use check_number_string instead. |
check_number_string | String | The check number for the transaction. |
created_at | String | The date and time the transaction was stored in the MX system. |
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. This is provided by the MX Platform. |
guid | String | A unique identifier for the transaction. Defined by MX. |
is_bill_pay | Boolean | If the transaction is a bill pay, this field will be true. Otherwise, this field will be false. |
is_direct_deposit | Boolean | If the transaction is a direct deposit, this field will be true. Otherwise, this field will be false. |
is_expense | Boolean | If the transaction is an expense, this field will be true. Otherwise, this field will be false. |
is_fee | Boolean | If the transaction is a fee, this field will be true. Otherwise, this field will be false. |
is_income | Boolean | If the transaction is income, this field will be true. Otherwise, this field will be false. |
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 | If the transaction is an overdraft fee, this field will be true. Otherwise, this field will be false. |
is_payroll_advance | Boolean | If the transaction is a payroll advance fee, this field will be true. Otherwise, this field will be false. |
is_subscription | Boolean | If the transaction represents a payment for a subscription service. |
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). |
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 | A unique identifier for the member to which the transaction belongs. Defined by MX. |
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 for more information. |
posted_at | String | The date and time the transaction was posted to the account. |
status | String | The status of the transaction, i.e., POSTED or PENDING. |
top_level_category | String | The parent category that this transaction's category is assigned to. |
transacted_at | String | The date and time the transaction took place. |
type | String | The type of transaction, i.e., CREDIT or DEBIT. |
updated_at | String | The date and time the transaction was updated. |
user_guid | String | A unique identifier for the user to which this transaction belongs. Defined by MX. |
Transaction Categories
- Auto & Transport
- Auto Insurance
- Auto Payment
- Gas
- Parking
- Public Transportation
- Service & Parts
- Bills & Utilities
- Domain Names
- Fraud Protection
- Home Phone
- Hosting
- Internet
- Mobile Phone
- Television
- Utilities
- Business Services
- Advertising
- Legal
- Office Supplies
- Printing
- Shipping
- Education
- Books & Supplies
- Student Loan
- Tuition
- Entertainment
- Amusement
- Arts
- Movies & DVDs
- Music
- Newspapers & Magazines
- Fees & Charges
- ATM Fee
- Banking Fee
- Finance Charge
- Late Fee
- Service Fee
- Trade Commissions
- Financial
- Financial Advisor
- Life Insurance
- Food & Dining
- Alcohol & Bars
- Coffee Shops
- Fast Food
- Groceries
- Restaurants
- Gifts & Donations
- Charity
- Gift
- Health & Fitness
- Dentist
- Doctor
- Eyecare
- Gym
- Health Insurance
- Pharmacy
- Sports
- Home
- Furnishings
- Home Improvement
- Home Insurance
- Home Services
- Home Supplies
- Lawn & Garden
- Mortgage & Rent
- Income
- Bonus
- Interest Income
- Paycheck
- Reimbursement
- Rental Income
- Investments
- Buy
- Deposit
- Dividend & Cap Gains
- Sell
- Withdrawal
- Kids
- Allowance
- Baby Supplies
- Babysitter & Daycare
- Child Support
- Kids Activities
- Toys
- Personal Care
- Hair
- Laundry
- Spa & Massage
- Pets
- Pet Food & Supplies
- Pet Grooming
- Veterinary
- Shopping
- Books
- Clothing
- Electronics & Software
- Hobbies
- Sporting Goods
- Taxes
- Federal Tax
- Local Tax
- Property Tax
- Sales Tax
- State Tax
- Transfer
- Credit Card Payment
- Transfer for Cash Spending
- Mortgage Payment
- Travel
- Air Travel
- Hotel
- Rental Car & Taxi
- Vacation
- Uncategorized
- Cash
- Check
Merchant Category Codes
| Merchant Category Code | MX Category | Merchant Category |
|---|---|---|
| 742 | Veterinary | Veterinary Services |
| 763 | Food & Dining | Agricultural Cooperative |
| 780 | Lawn & Garden | Landscaping Services |
| 1520 | Home Improvement | General Contractors |
| 1711 | Home Improvement | Heating, Plumbing, A/C |
| 1731 | Home Improvement | Electrical Contractors |
| 1740 | Home Improvement | Masonry, Stonework, and Plaster |
| 1750 | Home Improvement | Carpentry Contractors |
| 1761 | Home Improvement | Roofing/Siding, Sheet Metal |
| 1771 | Home Improvement | Concrete Work Contractors |
| 1799 | Home Improvement | Special Trade Contractors |
| 2741 | Printing | Miscellaneous Publishing and Printing |
| 2791 | Printing | Typesetting, Plate Making, and Related Services |
| 2842 | Home Services | Specialty Cleaning |
| 3000 | Air Travel | Default Category For 3000-3301 |
| 3351 | Rental Car & Taxi | Default Category For 3351-3441 |
| 3501 | Hotel | Default Category For 3501-3836 |
| 4011 | Travel | Railroads |
| 4111 | Travel | Commuter Transport, Ferries |
| 4112 | Travel | Passenger Railways |
| 4119 | Doctor | Ambulance Services |
| 4121 | Rental Car & Taxi | Taxicabs/Limousines |
| 4131 | Travel | Bus Lines |
| 4214 | Shipping | Motor Freight Carriers and Trucking |
| 4215 | Shipping | Courier Services |
| 4225 | Shipping | Public Warehousing and Storage - Farm Products, Refrigerated Goods |
| 4411 | Travel | Cruise Lines |
| 4457 | Travel | Boat Rentals and Leases |
| 4468 | Travel | Marinas, Service and Supplies |
| 4511 | Air Travel | Airlines, Air Carriers |
| 4582 | Travel | Airports, Flying Fields |
| 4722 | Travel | Travel Agencies, Tour Operators |
| 4723 | Travel | TUI Travel - Germany |
| 4784 | Travel | Tolls/Bridge Fees |
| 4789 | Travel | Transportation Services (Not Elsewhere Classified) |
| 4812 | Home Phone | Telecommunication Equipment and Telephone Sales |
| 4814 | Home Phone | Telecommunication Services |
| 4816 | Internet | Computer Network Services |
| 4821 | Bills & Utilities | Telegraph Services |
| 4829 | Transfer | Wires, Money Orders |
| 4899 | Utilities | Cable, Satellite, and Other Pay Television and Radio |
| 4900 | Utilities | Utilities |
| 5013 | Service & Parts | Motor Vehicle Supplies and New Parts |
| 5021 | Furnishings | Office and Commercial Furniture |
| 5039 | Home Improvement | Construction Materials (Not Elsewhere Classified) |
| 5044 | Business Services | Photographic, Photocopy, Microfilm Equipment, and Supplies |
| 5045 | Electronics & Software | Computers, Peripherals, and Software |
| 5046 | Shopping | Commercial Equipment (Not Elsewhere Classified) |
| 5047 | Health & Fitness | Medical, Dental, Ophthalmic, and Hospital Equipment and Supplies |
| 5051 | Home | Metal Service Centers |
| 5065 | Home | Electrical Parts and Equipment |
| 5072 | Home | Hardware, Equipment, and Supplies |
| 5074 | Home | Plumbing, Heating Equipment, and Supplies |
| 5085 | Home | Industrial Supplies (Not Elsewhere Classified) |
| 5094 | Shopping | Precious Stones and Metals, Watches and Jewelry |
| 5099 | Shopping | Durable Goods (Not Elsewhere Classified) |
| 5111 | Office Supplies | Stationary, Office Supplies, Printing and Writing Paper |
| 5122 | Pharmacy | Drugs, Drug Proprietaries, and Druggist Sundries |
| 5131 | Clothing | Piece Goods, Notions, and Other Dry Goods |
| 5137 | Clothing | Uniforms, Commercial Clothing |
| 5139 | Clothing | Commercial Footwear |
| 5169 | Home | Chemicals and Allied Products (Not Elsewhere Classified) |
| 5172 | Gas | Petroleum and Petroleum Products |
| 5192 | Books | Books, Periodicals, and Newspapers |
| 5193 | Shopping | Florists Supplies, Nursery Stock, and Flowers |
| 5198 | Home Supplies | Paints, Varnishes, and Supplies |
| 5199 | Home | Nondurable Goods (Not Elsewhere Classified) |
| 5200 | Home | Home Supply Warehouse Stores |
| 5211 | Home | Lumber, Building Materials Stores |
| 5231 | Home | Glass, Paint, and Wallpaper Stores |
| 5251 | Home | Hardware Stores |
| 5261 | Lawn & Garden | Nurseries, Lawn and Garden Supply Stores |
| 5271 | Shopping | Mobile Home Dealers |
| 5300 | Shopping | Wholesale Clubs |
| 5309 | Shopping | Duty Free Stores |
| 5310 | Shopping | Discount Stores |
| 5311 | Shopping | Department Stores |
| 5331 | Shopping | Variety Stores |
| 5399 | Shopping | Miscellaneous General Merchandise |
| 5411 | Groceries | Grocery Stores, Supermarkets |
| 5422 | Groceries | Freezer and Locker Meat Provisioners |
| 5441 | Groceries | Candy, Nut, and Confectionery Stores |
| 5451 | Groceries | Dairy Products Stores |
| 5462 | Groceries | Bakeries |
| 5499 | Groceries | Miscellaneous Food Stores - Convenience Stores and Specialty Markets |
| 5511 | Auto & Transport | Car and Truck Dealers (New & Used) Sales, Service, Repairs Parts and Leasing |
| 5521 | Auto & Transport | Car and Truck Dealers (Used Only) Sales, Service, Repairs Parts and Leasing |
| 5531 | Auto & Transport | Auto and Home Supply Stores |
| 5532 | Auto & Transport | Automotive Tire Stores |
| 5533 | Auto & Transport | Automotive Parts and Accessories Stores |
| 5541 | Gas | Service Stations |
| 5542 | Gas | Automated Fuel Dispensers |
| 5551 | Auto & Transport | Boat Dealers |
| 5561 | Auto & Transport | Motorcycle Shops, Dealers |
| 5571 | Auto & Transport | Motorcycle Shops and Dealers |
| 5592 | Auto & Transport | Motor Homes Dealers |
| 5598 | Sporting Goods | Snowmobile Dealers |
| 5599 | Auto & Transport | Miscellaneous Auto Dealers |
| 5611 | Clothing | Men's and Boy's Clothing and Accessories Stores |
| 5621 | Clothing | Women's Ready-To-Wear Stores |
| 5631 | Clothing | Women's Accessory and Specialty Shops |
| 5641 | Clothing | Children's and Infant's Wear Stores |
| 5651 | Clothing | Family Clothing Stores |
| 5655 | Clothing | Sports and Riding Apparel Stores |
| 5661 | Clothing | Shoe Stores |
| 5681 | Clothing | Furriers and Fur Shops |
| 5691 | Clothing | Men's, Women's Clothing Stores |
| 5697 | Clothing | Tailors, Alterations |
| 5698 | Hair | Wig and Toupee Stores |
| 5699 | Clothing | Miscellaneous Apparel and Accessory Shops |
| 5712 | Furnishings | Furniture, Home Furnishings, and Equipment Stores, Except Appliances |
| 5713 | Furnishings | Floor Covering Stores |
| 5714 | Furnishings | Drapery, Window Covering, and Upholstery Stores |
| 5718 | Furnishings | Fireplace, Fireplace Screens, and Accessories Stores |
| 5719 | Furnishings | Miscellaneous Home Furnishing Specialty Stores |
| 5722 | Home | Household Appliance Stores |
| 5732 | Electronics & Software | Electronics Stores |
| 5733 | Music | Music Stores-Musical Instruments, Pianos, and Sheet Music |
| 5734 | Electronics & Software | Computer Software Stores |
| 5735 | Music | Record Stores |
| 5811 | Restaurants | Caterers |
| 5812 | Restaurants | Eating Places, Restaurants |
| 5813 | Alcohol & Bars | Drinking Places |
| 5814 | Fast Food | Fast Food Restaurants |
| 5815 | Entertainment | Digital Goods Media - Books, Movies, Music |
| 5816 | Entertainment | Digital Goods - Games |
| 5817 | Shopping | Digital Goods - Applications (Excludes Games) |
| 5818 | Shopping | Digital Goods - Large Digital Goods Merchant |
| 5912 | Pharmacy | Drug Stores and Pharmacies |
| 5921 | Alcohol & Bars | Package Stores-Beer, Wine, and Liquor |
| 5931 | Clothing | Used Merchandise and Secondhand Stores |
| 5932 | Shopping | Antique Shops |
| 5933 | Shopping | Pawn Shops |
| 5935 | Service & Parts | Wrecking and Salvage Yards |
| 5937 | Shopping | Antique Reproductions |
| 5940 | Sporting Goods | Bicycle Shops |
| 5941 | Sporting Goods | Sporting Goods Stores |
| 5942 | Books | Book Stores |
| 5943 | Office Supplies | Stationery Stores, Office, and School Supply Stores |
| 5944 | Shopping | Jewelry Stores, Watches, Clocks, and Silverware Stores |
| 5945 | Shopping | Hobby, Toy, and Game Shops |
| 5946 | Shopping | Camera and Photographic Supply Stores |
| 5947 | Shopping | Gift, Card, Novelty, and Souvenir Shops |
| 5948 | Shopping | Luggage and Leather Goods Stores |
| 5949 | Shopping | Sewing, Needlework, Fabric, and Piece Goods Stores |
| 5950 | Shopping | Glassware, Crystal Stores |
| 5960 | Financial | Direct Marketing - Insurance Services |
| 5962 | Travel | Direct Marketing - Travel |
| 5963 | Shopping | Door-To-Door Sales |
| 5964 | Shopping | Direct Marketing - Catalog Merchant |
| 5965 | Shopping | Direct Marketing - Combination Catalog and Retail Merchant |
| 5966 | Shopping | Direct Marketing - Outbound Tele |
| 5967 | Shopping | Direct Marketing - Inbound Tele |
| 5968 | Shopping | Direct Marketing - Subscription |
| 5969 | Shopping | Direct Marketing - Other |
| 5970 | Shopping | Artist's Supply and Craft Shops |
| 5971 | Arts | Art Dealers and Galleries |
| 5972 | Shopping | Stamp and Coin Stores |
| 5973 | Shopping | Religious Goods Stores |
| 5975 | Health & Fitness | Hearing Aids Sales and Supplies |
| 5976 | Health & Fitness | Orthopedic Goods - Prosthetic Devices |
| 5977 | Personal Care | Cosmetic Stores |
| 5978 | Office Supplies | Typewriter Stores |
| 5983 | Gas | Fuel Dealers (Non Automotive) |
| 5992 | Shopping | Florists |
| 5993 | Shopping | Cigar Stores and Stands |
| 5994 | Books | News Dealers and Newsstands |
| 5995 | Pet Food & Supplies | Pet Shops, Pet Food, and Supplies |
| 5996 | Home | Swimming Pools Sales |
| 5997 | Personal Care | Electric Razor Stores |
| 5998 | Shopping | Tent and Awning Shops |
| 5999 | Shopping | Miscellaneous Specialty Retail |
| 6010 | Cash | Manual Cash Disburse |
| 6011 | Cash | Automated Cash Disburse |
| 6012 | Financial | Financial Institutions |
| 6050 | Uncategorized | Quasi Cash - Member Financial Institution |
| 6051 | Transfer | Non-FI, Money Orders |
| 6211 | Investments | Security Brokers/Dealers |
| 6300 | Financial | Insurance Underwriting, Premiums |
| 6399 | Financial | Insurance - Default |
| 6513 | Mortgage & Rent | Real Estate Agents and Managers - Rentals |
| 6536 | Transfer | MoneySend Intracountry |
| 6540 | Uncategorized | Non-Financial Institutions - Stored Value Card Purchase/Load |
| 7011 | Hotel | Hotels, Motels, and Resorts |
| 7012 | Vacation | Timeshares |
| 7032 | Vacation | Sporting/Recreation Camps |
| 7033 | Vacation | Trailer Parks, Campgrounds |
| 7210 | Laundry | Laundry, Cleaning Services |
| 7211 | Laundry | Laundries |
| 7216 | Laundry | Dry Cleaners |
| 7217 | Home Services | Carpet/Upholstery Cleaning |
| 7221 | Shopping | Photographic Studios |
| 7230 | Hair | Barber and Beauty Shops |
| 7251 | Clothing | Shoe Repair/Hat Cleaning |
| 7261 | Uncategorized | Funeral Services, Crematories |
| 7273 | Entertainment | Dating/Escort Services |
| 7276 | Financial | Tax Preparation Services |
| 7277 | Doctor | Counseling Services |
| 7278 | Shopping | Buying/Shopping Services |
| 7296 | Clothing | Clothing Rental |
| 7297 | Spa & Massage | Massage Parlors |
| 7298 | Spa & Massage | Health and Beauty Spas |
| 7299 | Business Services | Miscellaneous General Services |
| 7311 | Advertising | Advertising Services |
| 7321 | Financial | Credit Reporting Agencies |
| 7333 | Business Services | Commercial Photography, Art and Graphics |
| 7338 | Printing | Quick Copy, Repro, and Blueprint |
| 7339 | Business Services | Secretarial Support Services |
| 7342 | Home | Exterminating Services |
| 7349 | Home | Cleaning and Maintenance |
| 7361 | Business Services | Employment/Temp Agencies |
| 7372 | Business Services | Computer Programming |
| 7375 | Business Services | Information Retrieval Services |
| 7379 | Electronics & Software | Computer Repair |
| 7392 | Business Services | Consulting, Public Relations |
| 7393 | Business Services | Detective Agencies |
| 7394 | Business Services | Equipment Rental |
| 7395 | Business Services | Photo Developing |
| 7399 | Business Services | Miscellaneous Business Services |
| 7511 | Gas | Truck Stop |
| 7512 | Rental Car & Taxi | Car Rental Agencies |
| 7513 | Rental Car & Taxi | Truck/Utility Trailer Rentals |
| 7519 | Rental Car & Taxi | Recreational Vehicle Rentals |
| 7523 | Parking | Parking Lots, Garages |
| 7531 | Service & Parts | Auto Body Repair Shops |
| 7534 | Service & Parts | Tire Retreading and Repair |
| 7535 | Service & Parts | Auto Paint Shops |
| 7538 | Service & Parts | Auto Service Shops |
| 7542 | Service & Parts | Car Washes |
| 7549 | Service & Parts | Towing Services |
| 7622 | Electronics & Software | Electronics Repair Shops |
| 7623 | Home | A/C, Refrigeration Repair |
| 7629 | Home | Small Appliance Repair |
| 7631 | Shopping | Watch/Jewelry Repair |
| 7641 | Furnishings | Furniture Repair, Refinishing |
| 7692 | Service & Parts | Welding Repair |
| 7699 | Service & Parts | Miscellaneous Repair Shops |
| 7829 | Movies & DVDs | Picture/Video Production |
| 7800 | Entertainment | Government-Owned Lotteries |
| 7801 | Entertainment | Government Licensed On-Line Casinos (On-Line Gambling) |
| 7802 | Entertainment | Government-Licensed Horse/Dog Racing |
| 7832 | Movies & DVDs | Motion Picture Theaters |
| 7841 | Movies & DVDs | Video Tape Rental Stores |
| 7911 | Entertainment | Dance Hall, Studios, Schools |
| 7922 | Entertainment | Theatrical Ticket Agencies |
| 7929 | Entertainment | Bands, Orchestras |
| 7932 | Entertainment | Billiard/Pool Establishments |
| 7933 | Entertainment | Bowling Alleys |
| 7941 | Entertainment | Sports Clubs/Fields |
| 7991 | Entertainment | Tourist Attractions and Exhibits |
| 7992 | Entertainment | Golf Courses - Public |
| 7993 | Entertainment | Video Amusement Game Supplies |
| 7994 | Entertainment | Video Game Arcades |
| 7995 | Entertainment | Betting/Casino Gambling |
| 7996 | Entertainment | Amusement Parks/Carnivals |
| 7997 | Entertainment | Country Clubs |
| 7998 | Entertainment | Aquariums |
| 7999 | Entertainment | Miscellaneous Recreation Services |
| 8011 | Doctor | Doctors |
| 8021 | Dentist | Dentists, Orthodontists |
| 8031 | Doctor | Osteopaths |
| 8041 | Doctor | Chiropractors |
| 8042 | Eyecare | Optometrists, Ophthalmologist |
| 8043 | Eyecare | Opticians, Eyeglasses |
| 8044 | Eyecare | Opticians, Eyeglasses |
| 8049 | Doctor | Chiropodists, Podiatrists |
| 8050 | Health & Fitness | Nursing/Personal Care |
| 8062 | Doctor | Hospitals |
| 8071 | Doctor | Medical and Dental Labs |
| 8099 | Doctor | Medical Services |
| 8111 | Legal | Legal Services, Attorneys |
| 8211 | Education | Elementary, Secondary Schools |
| 8220 | Education | Colleges, Universities |
| 8241 | Education | Correspondence Schools |
| 8244 | Education | Business/Secretarial Schools |
| 8249 | Education | Vocational/Trade Schools |
| 8299 | Education | Educational Services |
| 8351 | Babysitter & Daycare | Child Care Services |
| 8398 | Gifts & Donations | Charitable and Social Service Organizations - Fundraising |
| 8641 | Gifts & Donations | Civic, Social, Fraternal Associations |
| 8651 | Gifts & Donations | Political Organizations |
| 8661 | Gifts & Donations | Religious Organizations |
| 8675 | Gifts & Donations | Automobile Associations |
| 8699 | Gifts & Donations | Membership Organizations |
| 8734 | Health & Fitness | Testing Laboratories |
| 8911 | Business Services | Architectural/Surveying Services |
| 8931 | Business Services | Accounting/Bookkeeping Services |
| 8999 | Business Services | Professional Services |
| 9211 | Legal | Court Costs, Including Alimony and Child Support - Courts of Law |
| 9222 | Legal | Fines - Government Administrative Entities |
| 9223 | Legal | Bail and Bond Payments |
| 9311 | Taxes | Tax Payments - Government Agencies |
| 9399 | Uncategorized | Government Services (Not Elsewhere Classified) |
| 9402 | Shipping | Postal Services - Government Only |
| 9405 | Taxes | U.S. Federal Government Agencies or Departments |
| 9950 | Business Services | Intra-Company Purchases |
Transaction Statuses
Transactions may have one of two statuses: PENDING or POSTED. How these statuses are reconciled depends on a number of factors.
- All transaction data on MX systems represent what we get through our data feed, i.e., what institutions make available for aggregation. Many institutions simply do not provide data for pending transactions; transactions from those accounts will always have a status of
POSTED. - For pending data we do get, it is sometimes possible for a single
transactionto be updated fromPENDINGtoPOSTEDand keep the same unique GUID. This is done through various matching methods performed automatically by MX. - If a single
transactioncan't be updated, thePENDINGtransactionwill often be deleted and replaced with a newPOSTEDtransaction(with a new GUID) when it is sent to us; this is the most common scenario when pending data is available. - In unusual circumstances, there may be separate
PENDINGandPOSTEDtransactions on MX systems for up to 14 days. AllPENDINGtransactions are deleted after 14 days as a failsafe.
Categorize Transactions
Categorize Transaction Fields
| Field Name | Data Type | Definition |
|---|---|---|
amount | Decimal | The monetary amount of the transaction. |
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. This is provided by the MX Platform. |
identifier | 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. |
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 for more information. |
type | String | The type of transaction. This will be either CREDIT or DEBIT. |
categorized_by Values
| Integer | Enum | Definition |
|---|---|---|
| 0 | CATEGORIZATION_SOURCE_AUTOCAT | This is obsolete and will no longer assign categories. |
| 1 | CATEGORIZATION_SOURCE_USER | The end user assigned a category manually. |
| 2 | CATEGORIZATION_SOURCE_FEED | The data feed assigned a category. |
| 3 | CATEGORIZATION_SOURCE_LEVENSHTEIN | This is obsolete and will no longer assign categories. |
| 4 | CATEGORIZATION_SOURCE_PARSER | A parser created by MX assigned the category based on patterns in the available data. |
| 5 | CATEGORIZATION_SOURCE_TRAINER | This is obsolete and will no longer assign categories. |
| 6 | CATEGORIZATION_SOURCE_SPHINX | This is obsolete and will no longer assign categories. |
| 7 | CATEGORIZATION_SOURCE_NAIVE_BAYES | This is obsolete and will no longer assign categories. |
| 8 | CATEGORIZATION_SOURCE_TERMINATION | After other methods failed to assign a category, it was set to 'UNCATEGORIZED'. |
| 9 | CATEGORIZATION_SOURCE_KEYWORD_CATEGORIZER | The category was assigned based on keywords appearing in the original description (feed description). |
| 10 | CATEGORIZATION_SOURCE_CATCHER | The category was assigned by a catcher based on the available data. |
| 11 | CATEGORIZATION_SOURCE_HOPSCOTCH | This is obsolete and will no longer assign categories. |
| 12 | CATEGORIZATION_SOURCE_USER_RULE | A transaction rule created by the end user assigned the category. |
| 13 | CATEGORIZATION_SOURCE_SYSTEM_RULE | A transaction rule created by MX assigned the category. |
| 14 | CATEGORIZATION_SOURCE_CLIENT_RULE | A transaction rule created by the partner assigned the category. |
| 15 | CATEGORIZATION_SOURCE_MERCHANT_CATEGORY_CODE | The category was assigned based on the merchant category code. |
| 16 | CATEGORIZATION_SOURCE_FLOOR | The transaction was assigned UNCATEGORIZED because it was uncategorizable as such, rather than because other methods failed; for example, the description simply contained withdrawal with no other information. |
| 17 | CATEGORIZATION_SOURCE_QUICKVERSE | The category was assigned by a machine-learning model. |
| 18 | CATEGORIZATION_SOURCE_MAPPING | The category was assigned by mapping from our new extended category system to legacy categories. This new system has yet to be fully released to clients. |
| 19 | CATEGORIZATION_SOURCE_TRANSFER_CATEGORIZER | The category was assigned by a categorizer designed specifically to look for transfers. |
described_by Values
| Integer | Enum | Definition |
|---|---|---|
| 0 | DESCRIPTION_SOURCE_SCRUBBER | The description is the result of various pattern replacement and other cleansing mechanisms. |
| 1 | DESCRIPTION_SOURCE_USER | The end user provided the description. |
| 2 | DESCRIPTION_SOURCE_FEED | The data feed provided the description. |
| 3 | DESCRIPTION_SOURCE_LEVENSHTEIN | This is obsolete and will no longer provide descriptions. |
| 4 | DESCRIPTION_SOURCE_USER_RULE | A transaction rule created by the end user provided the description. |
| 5 | DESCRIPTION_SOURCE_TRAINER | This is obsolete and will no longer provide descriptions. |
| 6 | DESCRIPTION_SOURCE_SYSTEM_RULE | A transaction rule created by MX provided the description. |
| 7 | DESCRIPTION_SOURCE_CLIENT_RULE | A transaction rule created by the partner provided the description. |
| 8 | DESCRIPTION_SOURCE_FLOOR | No cleansed description could be provided as such, rather than because other methods failed. |
Users
A user represents a person using Atrium via your application, be it a mobile app, web app, desktop app, etc.
info
The development environment limits you to 100 users.
| Field Name | Data Type | Description |
|---|---|---|
guid | String | A unique identifier, defined by MX. |
identifier | String | A unique, enforced identifier for the user, defined by you. |
is_disabled | Boolean | This indicates whether the user has been disabled. |
metadata | String | Additional information you can store about this user. MX recommends using JSON-structured data. |