atrium-java

MX API

The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access.

Requirements

Building the API client library requires: Java 1.7+

Releases

Download the latest release .jar files and add them to your project

Build your own .jar files

First generate the .jars by executing:

mvn clean package

Then manually install the following JARs:

target/atrium-java-2.8.5.jar
target/lib/*.jar

Example Usage

Please see docs directory for additional endpoint examples

import com.mx.atrium.*;
import com.mx.model.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");

        String accountGuid = "ACT-123"; // String | The unique identifier for an `account`.
        String userGuid = "USR-123"; // String | The unique identifier for a `user`.
        String fromDate = "2016-09-20"; // String | Filter transactions from this date.
        String toDate = "2016-10-20"; // String | Filter transactions to this date.
        Integer page = 1; // Integer | Specify current page.
        Integer recordsPerPage = 12; // Integer | Specify records per page.

        try {
            TransactionsResponseBody response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);
            System.out.println(response);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#listAccountTransactions");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

Class	Method	HTTP request	Description
AccountsApi	listAccountTransactions	GET /users/{user_guid}/accounts/{account_guid}/transactions	List account transactions
AccountsApi	listUserAccounts	GET /users/{user_guid}/accounts	List accounts for a user
AccountsApi	readAccount	GET /users/{user_guid}/accounts/{account_guid}	Read an account
AccountsApi	readAccountByMemberGUID	GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}	Read an account
ConnectWidgetApi	getConnectWidget	POST /users/{user_guid}/connect_widget_url	Embedding in a website
HoldingsApi	listHoldings	GET /users/{user_guid}/holdings	List holdings
HoldingsApi	listHoldingsByAccount	GET /users/{user_guid}/accounts/{account_guid}/holdings	List holdings by account
HoldingsApi	listHoldingsByMember	GET /users/{user_guid}/members/{member_guid}/holdings	List holdings by member
HoldingsApi	readHolding	GET /users/{user_guid}/holdings/{holding_guid}	Read holding
IdentityApi	identifyMember	POST /users/{user_guid}/members/{member_guid}/identify	Identify
IdentityApi	listAccountOwners	GET /users/{user_guid}/members/{member_guid}/account_owners	List member account owners
InstitutionsApi	listInstitutions	GET /institutions	List institutions
InstitutionsApi	readInstitution	GET /institutions/{institution_code}	Read institution
InstitutionsApi	readInstitutionCredentials	GET /institutions/{institution_code}/credentials	Read institution credentials
MembersApi	aggregateMember	POST /users/{user_guid}/members/{member_guid}/aggregate	Aggregate member
MembersApi	aggregateMemberBalances	POST /users/{user_guid}/members/{member_guid}/balance	Aggregate member account balances
MembersApi	createMember	POST /users/{user_guid}/members	Create member
MembersApi	deleteMember	DELETE /users/{user_guid}/members/{member_guid}	Delete member
MembersApi	extendHistory	POST /users/{user_guid}/members/{member_guid}/extend_history	Extend history
MembersApi	listMemberAccounts	GET /users/{user_guid}/members/{member_guid}/accounts	List member accounts
MembersApi	listMemberCredentials	GET /users/{user_guid}/members/{member_guid}/credentials	List member credentials
MembersApi	listMemberMFAChallenges	GET /users/{user_guid}/members/{member_guid}/challenges	List member MFA challenges
MembersApi	listMemberTransactions	GET /users/{user_guid}/members/{member_guid}/transactions	List member transactions
MembersApi	listMembers	GET /users/{user_guid}/members	List members
MembersApi	readMember	GET /users/{user_guid}/members/{member_guid}	Read member
MembersApi	readMemberStatus	GET /users/{user_guid}/members/{member_guid}/status	Read member connection status
MembersApi	resumeMember	PUT /users/{user_guid}/members/{member_guid}/resume	Resume aggregation from MFA
MembersApi	updateMember	PUT /users/{user_guid}/members/{member_guid}	Update member
MerchantsApi	readMerchant	GET /merchants/{merchant_guid}	Read merchant
StatementsApi	downloadStatementPdf	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf	Download statement PDF
StatementsApi	fetchStatements	POST /users/{user_guid}/members/{member_guid}/fetch_statements	Fetch statements
StatementsApi	listMemberStatements	GET /users/{user_guid}/members/{member_guid}/statements	List member statements
StatementsApi	readMemberStatement	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}	Read statement JSON
TransactionsApi	cleanseAndCategorizeTransactions	POST /transactions/cleanse_and_categorize	Categorize transactions
TransactionsApi	listUserTransactions	GET /users/{user_guid}/transactions	List transactions for a user
TransactionsApi	readTransaction	GET /users/{user_guid}/transactions/{transaction_guid}	Read a transaction
UsersApi	createUser	POST /users	Create user
UsersApi	deleteUser	DELETE /users/{user_guid}	Delete user
UsersApi	listUsers	GET /users	List users
UsersApi	readUser	GET /users/{user_guid}	Read user
UsersApi	updateUser	PUT /users/{user_guid}	Update user
VerificationApi	listAccountNumbers	GET /users/{user_guid}/members/{member_guid}/account_numbers	Read account numbers
VerificationApi	listAccountNumbersByAccount	GET /users/{user_guid}/accounts/{account_guid}/account_numbers	Read account numbers by account GUID
VerificationApi	verifyMember	POST /users/{user_guid}/members/{member_guid}/verify	Verify