Statement download allows a customer to receive transactions and balances that are typically part of a regular paper statement. Clients can retrieve transactions and balances on a daily basis if they wish. Coupled with the information returned by statement closing information request (see section 11.5), a client can construct an “electronic statement” that contains all of the information that appears on a regular paper statement.
Clients typically allow customers to view these transactions and guide customers through a process of updating their account registers based on the downloaded transactions. By using transaction IDs supplied by financial institutions, Open Financial Exchange makes it possible for clients to ensure that a server downloads each transaction only once. The request also contains starting and ending dates to limit the amount of downloaded data. Clients can remember the last date they received data and use it as the starting date in the next request.
The messages in this chapter are appropriate for checking, savings, money market, credit card, and line of credit accounts. Investment statement download is a superset of bank statement download. Chapter 13 describes the messages specific to investment statement download.
Statement download requires the client to designate an account for the download, and to indicate if the server should download transactions and/or balances. If the client wishes to download transactions, it can specify a date range that the transactions fall within.
The server returns transactions that match the date range (if the client specifies one), and balance information for the account.
-
Client Sends
|
Server Responds
|
Account information
|
|
Include transactions?
|
|
Date range
|
|
|
Transactions
|
|
Cycle-ending information
|
Bank Statement Download
A client can request a download of balances separately from transaction detail. The server downloads transactions only if the aggregate is present and the flag is set to Y. The current ledger balance (and balance date) are always downloaded.
You can use the … request and response pair to download transactions and balances for checking, savings, money market, and line of credit accounts. Section 11.4.2 describes download for credit card accounts.
and should be interpreted by clients and servers as described in Chapter 3.
Request
This does not apply to Active Statements.
Response
A statement response comprises tags supplying various balances, plus zero or more aggregates, each describing one statement transaction.
The response must appear within a transaction wrapper.
See Chapter 3, “Common Aggregates, Elements, and Data Types,” for size and type information for common elements (such as dollar values).
-
Tag
|
Description
|
|
Statement-response aggregate
|
|
Default currency for the statement, currsymbol
|
|
Account-from aggregate, see section 11.3.1
|
|
|
|
Statement-transaction-data aggregate
|
|
Start date for transaction data, date
|
|
Value that client should send in next request to ensure that it does not miss any transactions, date
|
|
Opening tag for each statement transaction (0 or more),
see section
|
|
End tag for each statement transaction
|
|
|
|
Ledger balance aggregate
|
|
Ledger balance amount, amount
|
|
Balance date, datetime
|
|
|
|
Available balance aggregate
|
|
Available balance amount, amount
|
|
Balance date, datetime
|
|
|
|
Marketing information (at most 1), A-360
|
|
| Status Codes -
Only Success applies to Active Statements
Credit Card Statement Download
The credit card download request is semantically identical to the bank statement download request. However, the aggregate contains the credit card request, not the aggregate.
Request
The request must appear within a transaction wrapper.
-
Tag
|
Description
|
|
Credit-card-download-request aggregate
|
|
Credit-card-account-from aggregate
|
|
Account number, A-22
|
|
Checksum for international banks, A-22
|
|
|
|
Include transactions
|
|
Start date of statement requested, datetime
|
|
Ending date of statement requested, datetime
|
|
Include transacti_ons flag, Boolean
|
|
|
|
| Response
The credit card download response is semantically identical to the bank statement download response. However, the aggregate contains the credit card response, not the aggregate.
The response must appear within a transaction wrapper.
-
Tag
|
Description
|
|
Credit-card-download-response aggregate
|
|
Default currency for the statement, currsymbol
|
|
Account from aggregate, see section 11.3.2
|
|
|
|
Opening tag for statement transaction data
|
|
Start date for transaction data, date
|
|
Value client should send in next request to ensure that it does not miss any transactions, date
|
|
Opening tag for each statement transaction (0 or more),
see section 11.4.2.3.1
|
|
End tag for each statement transaction
|
|
|
|
Ledger-balance aggregate
|
|
Ledger balance amount, amount
|
|
Balance date, datetime
|
|
|
|
Available balance aggregate
|
|
Available balance amount, amount
|
|
Balance date, datetime
|
|
|
|
Marketing information (at most 1), A-360
|
|
| Status Codes -
Only Success applies to Active Statements
Statement Transaction
A aggregate describes a single transaction. It identifies the type of the transaction and the date it was posted. The aggregate can also provide additional information to help the customer recognize the transaction: check number, payee name, and memo. The transaction can have a Standard Industrial Code that a client can use to categorize the transaction.
Each contains an that the client uses to detect whether the server has previously downloaded the transaction.
Transaction amounts are signed from the perspective of the customer. For example, a credit card payment is positive while a credit card purchase is negative.
-
Tag
|
Description
|
|
Statement-transaction aggregate
|
|
Transaction type, see section 11.4.2.3.1.1 for possible values
|
|
Date transaction was posted to account, datetime
|
|
Date user initiated transaction, if known, datetime
|
|
Date funds are available, datetime
|
|
Amount of transaction, amount
|
|
Transaction ID issued by financial institution.
Used to detect duplicate downloads, FITID
|
|
If present, the FITID of a previously sent transaction that is corrected by this record. This transaction replaces or deletes the transaction that it corrects, based on the value of below, FITID
|
|
Actions can be REPLACE or DELETE. REPLACE replaces the transaction referenced by CORRECTFITID; DELETE deletes it.
|
|
Server assigned transaction ID; used for transactions initiated by client, such as payment or funds transfer. SRVRTID
|
|
Check (or other reference) number, A-12
|
|
Reference number that uniquely identifies the transaction. Can be used in addition to or instead of a , A-32
|
|
Standard Industrial Code, N-6
|
|
Payee identifier if available, A-12
|
Payee options. Choose either or
.
|
|
|
Name of payee or description of transaction, A-32
NOTE: Provide NAME or PAYEE, not both
|
or-
|
|
|
Payee aggregate, see section 12.5.2.1
|
|
|
Account-to options. Choose either or .
|
|
|
If this was a transfer to an account and the account information is available, see section 11.3.1
|
|
|
or-
|
|
|
|
|
|
|
Extra information (not in ), A-255
|
-
Tag
|
Description
|
Currency options. Choose either or .
|
|
|
Currency, if different from CURDEF
|
-or-
|
|
|
|
|
| Transaction types used in
Type
|
Description
|
CREDIT
|
Generic credit
|
DEBIT
|
Generic debit
|
INT
|
Interest earned or paid
NOTE: depends on signage of amount
|
DIV
|
Dividend
|
FEE
|
FI fee
|
SRVCHG
|
Service charge
|
DEP
|
Deposit
|
ATM
|
ATM debit or credit
NOTE: depends on signage of amount
|
POS
|
Point of sale debit or credit
NOTE: depends on signage of amount
|
XFER
|
Transfer
|
CHECK
|
Check
|
PAYMENT
|
Electronic payment
|
CASH
|
Cash withdrawal
|
DIRECTDEP
|
Direct deposit
|
DIRECTDEBIT
|
Merchant initiated debit
|
REPEATPMT
|
Repeating payment/standing order
|
OTHER
|
Other
| |