README
1Ofxconnect is a utility to test OFX Direct Connect. And it's a sample so you
2can understand how to use it in your own code.
3
4Direct Connect consists of two separate steps: First, contacting the partner
5server to retrieve information about your bank. Second, contacting your bank
6to retrieve your accounts and statements. The partner server should be
7contacted when the user sets up his accounts.
8
9Common mistakes with the partner server are to contact it EVERY time you
10contact the bank, and contacting it just once to cache the contact
11info for all banks. The former is overkill, the latter means users won't
12have up-to-date bank contact information.
13
14Step-by-step guide to using the ofxconnect utility
15
161. Retrieve the list of banks
17
18 $ofxconnect -b
19
202. Find your bank in the list. Retrieve the FI partner ID's (fipid's) for that bank
21
22 $ofxconnect -f "Wells Fargo"
23 101458
24 102078
25 5571
26
273. Retrieve the service capabilities of each fipid to find the one which has the services you want.
28Note that all the 6-digit fipids don't seem to work well with libofx right now.
29
30 $ofxconnect -v 5571
31 Statements? Yes
32 Billpay? Yes
33 Investments? No
34
354. Retrieve and view the list of all your accounts
36
37 $ofxconnect -a --fipid=5571 --user=myusername --pass=mypassword accounts.ofx
38 $ofxdump accounts.ofx 2>/dev/null
39
40Look for entries like this:
41
42 Account ID: 999888777 00 123456789
43 Account name: Bank account 1234567890
44 Account type: CHECKING
45 Bank ID: 999888777
46 Branch ID: 00
47 Account #: 1234567890
48
495. Retrieve a statement for one of the accounts
50
51 $ofxconnect -s --fipid=5571 --user=myusername --pass=mypassword --bank=xxx --account=xxx --type=x --past=xx statement.ofx
52 $ofxdump statement.ofx 2>/dev/null
53
54 The --bank and --account parameters should be exactly like the "Bank ID" and "Account #" results from the account request.
55 The --type is: 1=CHECKING, 2=INVESTMENT, 3=CREDITCARD. Other types are not supported
56 The --past is how many days previous from today you want.
57