atrium-go

module
v3.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 28, 2020 License: MIT

README

Go API client for atrium

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.

Installation

Put the package under your project folder and add the following in import:

import "github.com/mxenabled/atrium-go"

Example Usage

Please see docs directory for additional endpoint examples


package main

import (
	"context"
	"fmt"
	"github.com/mxenabled/atrium-go"
	"github.com/antihax/optional"
)

func main() {
	client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
	ctx := context.Background()

	accountGUID := "ACT-123" // string | The unique identifier for an `account`.
	userGUID := "USR-123" // string | The unique identifier for a `user`.
	opts := &atrium.ListAccountTransactionsOpts{ 
		FromDate: optional.NewString("2016-09-20"), // string | Filter transactions from this date.
		ToDate: optional.NewString("2016-10-20"), // string | Filter transactions to this date.
		Page: optional.NewInt32(1), // int32 | Specify current page.
		RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
	}

	response, _, err := client.Accounts.ListAccountTransactions(ctx, accountGUID, userGUID, , opts)
	if err != nil {
		fmt.Printf("Error: %v\n", err)
	} else {
		fmt.Printf("Response: %s\n", response)
	}
}

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

Documentation For Models

Directories

Path Synopsis
v3
atrium

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.