PHP wrapper for the MX Atrium API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
test
README.md
composer.json
git_push.sh
phpunit.xml.dist

README.md

MXClient-php

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

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mxenabled/atrium-php.git"
    }
  ],
  "require": {
    "mxenabled/atrium-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/MXClient-php/vendor/autoload.php');

Example Usage

Please see docs directory for additional endpoint examples

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$client = new atrium\Api\AtriumClient(
    "YOUR_API_KEY",
    "YOUR_CLIENT_ID",
    new GuzzleHttp\Client()
);

$account_guid = "ACT-123"; // string | The unique identifier for an `account`.
$user_guid = "USR-123"; // string | The unique identifier for a `user`.
$from_date = "2016-09-20"; // string | Filter transactions from this date.
$to_date = "2016-10-20"; // string | Filter transactions to this date.
$page = 1; // int | Specify current page.
$records_per_page = 12; // int | Specify records per page.

try {
    $result = $client->accounts->listAccountTransactions($account_guid, $user_guid, $from_date, $to_date, $page, $records_per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->listAccountTransactions: ', $e->getMessage(), PHP_EOL;
}

?>

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 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 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
TransactionsApi cleanseAndCategorizeTransactions POST /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

Documentation For Models