### Simplified OFX Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

A simplified example demonstrating the structure of an Open Financial Exchange request file. This example includes a sign-on message and a bank statement request, showcasing the SGML-like tagged format used for data identification and delimitation.

```SGML
<OFX> <!-- Begin request data -->

<SIGNONMSGSRQV1>

<SONRQ> <!-- Begin signon -->

<DTCLIENT>19961029101000 <!-- Oct. 29, 1996, 10:10:00 am -->

<USERID>123-45-6789 <!-- User ID (that is, SSN) -->

<USERPASS>MyPassword <!-- Password (SSL encrypts whole) -->

<LANGUAGE>ENG <!-- Language used for text -->

<FI> <!-- ID of receiving institution -->

<ORG>NCH <!-- Name of ID owner -->

<FID>1001 <!-- Actual ID -->

</FI>

<APPID>MyApp

<APPVER>0500

</SONRQ> <!-- End of signon -->

</SIGNONMSGSRQV1>

  

<BANKMSGSRQV1>

<STMTTRNRQ> <!-- First request in file -->

<TRNUID>1001

<STMTRQ> <!-- Begin statement request -->

<BANKACCTFROM> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999988 <!-- Account number -->

<ACCTTYPE>CHECKING <!-- Account type -->

</BANKACCTFROM> <!-- End of account ID -->

<INCTRAN> <!-- Begin include transaction -->

<INCLUDE>Y <!-- Include transactions -->

</INCTRAN> <!-- End of include transaction -->

</STMTRQ> <!-- End of statement request -->

</STMTTRNRQ> <!-- End of first request -->

</BANKMSGSRQV1>

</OFX> <!-- End of request data -->
```

--------------------------------

### OFX Account Information Response Example (Banking)

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX response message providing detailed account information for a banking account, including status, description, and service details.

```XML
<ACCTINFOTRNRS>
<TRNUID>12345
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<ACCTINFORS>
<DTACCTUP>20050102
<ACCTINFO>
<DESC>Power Checking
<PHONE>8002223333
<BANKACCTINFO>
<BANKACCTFROM>
<BANKID>1234567789
<ACCTID>12345
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<SUPTXDL>Y
<XFERSRC>Y
<XFERDEST>Y
<SVCSTATUS>ACTIVE
</BANKACCTINFO>
</ACCTINFO>
</ACCTINFORS>
</ACCTINFOTRNRQ>
```

--------------------------------

### OFX Account Information Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX request message to retrieve account information, specifying a date for last update.

```XML
<ACCTINFOTRNRQ>
<TRNUID>12345
<ACCTINFORQ>
<DTACCTUP>20050101
</ACCTINFORQ>
</ACCTINFOTRNRQ>
```

--------------------------------

### OFX Enrollment Request XML Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX XML message for an enrollment request. This snippet demonstrates how a client would send personal and contact information, along with a desired user ID and security details, to initiate the enrollment process with a financial institution.

```XML
<ENROLLTRNRQ>
<TRNUID>12345
<ENROLLRQ>
<FIRSTNAME>Joe
<MIDDLENAME>Lee
<LASTNAME>Smith
<ADDR1>21 Main St.
<CITY>Anytown
<STATE>TX
<POSTALCODE>87321
<COUNTRY>USA
<DAYPHONE>123-456-7890
<EVEPHONE>987-654-3210
<EMAIL>jsmith@isp.com
<USERID>jls
<TAXID>123-456-1234
<SECURITYNAME>jbmam
<DATEBIRTH>19530202
</ENROLLRQ>
</ENROLLTRNRQ>
```

--------------------------------

### OFX GETMIMETRNRQ Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Example of an OFX request to retrieve MIME content, including a transaction ID and the URL of the content to be retrieved.

```OFX
<GETMIMETRNRQ>
<TRNUID>54321
<GETMIMERQ>
<URL>http://www.fi.com/apage.html
</GETMIMERQ>
</GETMIMETRNRQ>
```

--------------------------------

### OFX GETMIMETRNRQ Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

Example of an OFX request to retrieve MIME content, including a transaction ID and URL.

```OFX
<GETMIMETRNRQ>

<TRNUID>54321

<GETMIMERQ>

<URL>http://www.fi.com/apage.html

</GETMIMERQ>

</GETMIMETRNRQ>
```

--------------------------------

### OFX Enrollment Reply XML Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX XML message for an enrollment response. This snippet shows a successful reply, including the transaction UID, status information, a temporary password, the assigned user ID, and its expiration date, as returned by the financial institution.

```XML
<ENROLLTRNRS>
<TRNUID>12345
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<ENROLLRS>
<TEMPPASS>changeme
<USERID>jls
<DTEXPIRE>20060105
</ENROLLRS>
</ENROLLTRNRS>
```

--------------------------------

### HTTP Multi-part MIME OFX Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Illustrates a multi-part MIME HTTP response containing an OFX GETMIMETRNRS and an HTML document. This example demonstrates how different content types can be embedded within a single HTTP response using boundaries.

```HTTP
HTTP 1.0 200 OK
Content-Type: multipart/x-mixed-replace; boundary =--boundary—

--boundary--
Content-Type: application/x-ofx
Content-Length: 8732

OFXHEADER:100
DATA:OFXSGML  
VERSION:102  
SECURITY:TYPE1  
ENCODING:USASCII

<OFX>
<!-- signon not shown
message set wrappers not shown -->
<GETMIMETRNRS>
<TRNUID>54321
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<GETMIMERS>
<URL>http://www.fi.com/apage.html
</GETMIMERS>
</GETMIMETRNRS>
</OFX>

--boundary--
Content-Type: text/html
<HTML>
<!-- standard HTML page -->
</HTML>

--boundary--
```

--------------------------------

### OFX Account Information Response XML Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

An example of an OFX message responding to an account information request. It shows details for a single checking account, including bank ID, account ID, type, and service status.

```XML
<ACCTINFOTRNRS>

<TRNUID>12345

<STATUS>

<CODE>0

<SEVERITY>INFO

</STATUS>

<ACCTINFORS>

<DTACCTUP>19960102

<ACCTINFO>

<DESC>Power Checking

<PHONE>8002223333

<BANKACCTINFO>

<BANKACCTFROM>

<BANKID>1234567789

<ACCTID>12345

<ACCTTYPE>CHECKING

</BANKACCTFROM>

<SUPTXDL>Y

<XFERSRC>Y

<XFERDEST>Y

<SVCSTATUS>ACTIVE

</BANKACCTINFO>

</ACCTINFO>

</ACCTINFORS>

</ACCTINFOTRNRS>
```

--------------------------------

### OFX Account Information Request XML Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

An example of an OFX message for requesting account information from a financial institution. It includes a transaction ID and a date for account update.

```XML
<ACCTINFOTRNRQ>

<TRNUID>12345

<ACCTINFORQ>

<DTACCTUP>19960101

</ACCTINFORQ>

</ACCTINFOTRNRQ>
```

--------------------------------

### OFX SGML Status Block Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

Illustrates the case sensitivity requirement for element names and enumerated values in Open Financial Exchange (OFX) SGML structures, using a STATUS block example with CODE, SEVERITY, and MESSAGE elements.

```SGML
<STATUS>
<CODE> 2000
<SEVERITY> ERROR
<MESSAGE> General Error
</STATUS>
```

--------------------------------

### OFX Email Synchronization Request and Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

This example demonstrates an OFX email synchronization flow, showing a client's request (MAILSYNCRQ) and the server's subsequent reply (MAILSYNCRS) containing a missed email response. It includes token management and embedded HTML content.

```XML
<MAILSYNCRQ>

<TOKEN>101

<REJECTIFMISSING>N

<INCIMAGES>N

<USEHTML>Y

</MAILSYNCRQ>

  

<MAILSYNCRS>

<TOKEN>102

<MAILTRNRS>

<TRNUID>0 <!-- server initiated response -->

<STATUS>

<CODE>0

<SEVERITY>INFO

</STATUS>

<MAILRS>

<MAIL>

<USERID>MyUserid

<DTCREATED>20060307

<FROM>Noelani Federal Savings

<TO>James Hackleman

<SUBJECT>Re: What do I need to earn interest?

<MSGBODY><![ CDATA [<HTML><BODY>You need to maintain $1000 in this account to earn interest. Because your balance was only $750 this month, no interest was earned. You could also switch to our new Checking Extra plan that always pays interest. Call us or check our web page http://www.fi.com/check-plans.html for more information.

Sincerely,

Customer Service Department

  

Original message:

I didn’t earn any interest this month. Can you please tell me what I need to do to earn interest on this account?</BODY></HTML>

]]></MSGBODY>

<INCIMAGES>N

<USEHTML>Y

</MAIL>

</MAILRS>

</MAILTRNRS>

</MAILSYNCRS>
```

--------------------------------

### OFX E-mail Transaction Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

An example of an OFX <MAILTRNRQ> (Mail Transaction Request) sent by a consumer to a financial institution. This request inquires about earning interest and demonstrates the use of CDATA sections for embedding HTML content within the message body.

```XML
<MAILTRNRQ>
<TRNUID>54321
<MAILRQ>
<MAIL>
<USERID>123456789
<FROM>James Hackleman
<TO>Noelani Federal Savings
<SUBJECT>What do I need to earn interest?
<DTCREATED>19960305
<MSGBODY><![ CDATA [<HTML><BODY>I didn’t earn any interest this month. Can you please tell me what I need to do to earn interest on this account?</BODY></HTML>
]]></MSGBODY>
<INCIMAGES>N
<USEHTML>Y
</MAIL>
</MAILRQ>
</MAILTRNRQ>
```

--------------------------------

### OFX Recurring Payment Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX request message (<RECPMTRQ>) used to initiate a new recurring payment. It specifies 12 monthly instances for $395.00 from a checking account to a payee, due on November 15, 2006.

```XML
<RECPMTRQ>
<RECURRINST>
<NINSTS>12
<FREQ>MONTHLY
</RECURRINST>
<PMTINFO>
<BANKACCTFROM>
<BANKID>555432180
<ACCTID>763984
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<TRNAMT>395.00
<PAYEEID>77810
<PAYACCT>444-78-97572
<DTDUE>20061115
<MEMO>Auto loan payment
</PMTINFO>
</RECPMTRQ>
```

--------------------------------

### OFX Full Synchronization Example: Initial Client Request and Server Response

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin2.html

Demonstrates an initial full synchronization flow in OFX for bill payment. This snippet shows a client's synchronization request and the subsequent server response, including details on how the server provides missing payment transaction responses to synchronize the client.

```XML
<PMTSYNCRQ>
<TOKEN>123
<REJECTIFMISSING>N
<BANKACCTFROM>
<BANKID>121000248
<ACCTID>123456789
<ACCTTYPE>CHECKING
</BANKACCTFROM>
</PMTSYNCRQ>
```

```XML
<PMTSYNCRS>
<TOKEN>125
<LOSTSYNC>N
<BANKACCTFROM>
<BANKID>121000248
<ACCTID>123456789
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<PMTTRNRS>
<TRNUID>123
<STATUS>
... status details
</STATUS>
<PMTRS>
... details on a payment response
</PMTRS>
</PMTTRNRS>
<PMTTRNRS>
<TRNUID>546
<STATUS>
... status details
</STATUS>
<PMTRS>
... details on another payment response
</PMTRS>
</PMTTRNRS>
</PMTSYNCRS>
```

--------------------------------

### JavaScript Function Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

A simple JavaScript function demonstrating a basic return statement for boolean true.

```javascript
function example() {\n  return true;\n}
```

--------------------------------

### OFX Request to Activate a Payment

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example OFX message (`<ACCTTRNRQ>`) demonstrating how to request the activation of a payment service. It includes a transaction UID, account request details, and the service addition aggregate with bank account information.

```XML
<ACCTTRNRQ>
<TRNUID>12345
<ACCTRQ>
<SVCADD>
<BANKACCTTO>
<BANKID>1234567789
<ACCTID>12345
<ACCTTYPE>CHECKING
</BANKACCTTO>
</SVCADD>
<SVC>BPSVC
</ACCTRQ>
</ACCTTRNRQ>
```

--------------------------------

### OFX 1.0.3: Activation & Account Information Message Set

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

This section details the Open Financial Exchange (OFX) message set for user activation, enrollment, password acquisition, and account information management. It covers the request and response structures for various operations, including examples and status codes for different scenarios.

```APIDOC
8. Activation & Account Information
  8.1 Overview
  8.2 Approaches to User Sign-Up with Open Financial Exchange
  8.3 Users and Accounts
  8.4 Enrollment and Password Acquisition <ENROLLRQ> <ENROLLRS>
    8.4.1 User IDs
    8.4.2 Enrollment Request
    8.4.3 Enrollment Response
    8.4.4 Enrollment Status Codes
    8.4.5 Examples
  8.5 Account Information
    8.5.1 Request <ACCTINFORQ>
    8.5.2 Response <ACCTINFORS>
    8.5.3 Account Information Aggregate <ACCTINFO>
    8.5.4 Status Codes
    8.5.5 Examples
  8.6 Service Activation
    8.6.1 Activation Request and Response
    8.6.2 Service Activation Synchronization
    8.6.3 Examples
  8.7 Name and Address Changes <CHGUSERINFORQ> <CHGUSERINFORS>
    8.7.1 <CHGUSERINFORQ>
    8.7.2 <CHGUSERINFORS>
    8.7.3 Status Codes
  8.8 Signup Message Set Profile Information
```

--------------------------------

### OFX E-mail Transaction Immediate Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

An example of the immediate OFX <MAILTRNRS> (Mail Transaction Response) from the financial institution, echoing the consumer's request. This response confirms successful receipt but does not contain the actual answer, which is expected later via a synchronization request.

```XML
<MAILTRNRS>
<TRNUID>54321
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<MAILRS>
<MAIL>
<USERID>123456789
<FROM>James Hackleman
<TO>Noelani Federal Savings
<SUBJECT>What do I need to earn interest?
<DTCREATED>19960305
<MSGBODY><![ CDATA [<HTML><BODY>I didn’t earn any interest this month. Can you please tell me what I need to do to earn interest on this account?</BODY></HTML>
]]></MSGBODY>
<INCIMAGES>N
<USEHTML>Y
</MAIL>
</MAILRS>
</MAILTRNRS>
```

--------------------------------

### OFX Full Synchronization Example: Client Request with Update and Server Response

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin2.html

Illustrates a continuation of the full synchronization flow where a client makes a new payment request while simultaneously including a synchronization update. This avoids a separate re-synchronization step. The snippet also shows the server's response to this combined request.

```XML
<PMTSYNCRQ>
<TOKEN>125
<REJECTIFMISSING>N
<BANKACCTFROM>
<BANKID>121000248
<ACCTID>123456789
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<PMTTRNRQ>
<TRNUID>12345
<PMTRQ>
... details of a new payment request
</PMTRQ>
</PMTTRNRQ>
</PMTSYNCRQ>
```

```XML
<PMTSYNCRS>
<TOKEN>126
<LOSTSYNC>N
<BANKACCTFROM>
<BANKID>121000248
<ACCTID>123456789
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<PMTTRNRS>
... details on a payment response to the new request
</PMTTRNRS>
</PMTSYNCRS>
```

--------------------------------

### Example OFX Message Set Aggregates Structure

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

Illustrates the hierarchical structure of Open Financial Exchange (OFX) messages within message set aggregates, showing signon and banking message sets containing various requests. This example demonstrates how different message types are encapsulated within their respective versioned message set aggregates.

```XML
<OFX>

<SIGNONMSGSRQV1> <!-- Signon message set -->

<SONRQ> <!-- Signon message -->

...

</SONRQ>

</SIGNONMSGSRQV1>

  

<BANKMSGSRQV1> <!-- Banking message set -->

<STMTTRNRQ> <!-- Statement request -->

...

</STMTTRNRQ>

<STMTTRNRQ> <!-- Another stmt request -->

...

</STMTTRNRQ>

<INTRATRNRQ> <!-- Intrabank transfer request -->

...

</INTRATRNRQ>

</BANKMSGSRQV1>

</OFX>
```

--------------------------------

### OFX Client Synchronization Request (PMTSYNCRQ)

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-2.html

Demonstrates an Open Financial Exchange (OFX) client initiating a full synchronization request for bill payment. The request includes the synchronization token, a flag for rejecting missing items, and the banking account details from which payments originate. This example shows how a client informs the server of its current synchronization state.

```XML
<PMTSYNCRQ>

<TOKEN>123

<REJECTIFMISSING>N

<BANKACCTFROM>

<BANKID>121000248

<ACCTID>123456789

<ACCTTYPE>CHECKING

</BANKACCTFROM>

</PMTSYNCRQ>
```

--------------------------------

### OFX Intrabank Transfer and Cancellation Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin4.html

Illustrates the structure of an OFX 1.0.2 response for intrabank transfers and cancellations. This example shows a successful transfer response with account details, transfer amount, and projected posting date, followed by a successful cancellation response referencing a previously initiated transfer.

```XML
<INTRATRNRS> <!-- Third response -->

<TRNUID>1006 <!-- Client ID sent in request -->

<STATUS>

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<INTRARS> <!-- This is the Jan. 15 add -->

<CURDEF>USD

<SRVRTID>1004 <!-- Server assigned ID -->

<XFERINFO> <!-- Begin transfer aggregate -->

<BANKACCTFROM> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999988 <!-- Account number -->

<ACCTTYPE>CHECKING <!-- Account type -->

</BANKACCTFROM> <!-- End of account ID -->

<BANKACCTTO> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999977 <!-- Account number -->

<ACCTTYPE>SAVINGS <!-- Account type -->

</BANKACCTTO> <!-- End of account ID -->

<TRNAMT>200.00 <!-- Amount of transfer -->

</XFERINFO> <!-- End of transfer aggregate -->

<DTXFERPRJ>19970115 <!-- Date of expected posting -->

<RECSRVRTID>20000 <!-- Model that was canceled -->

</INTRARS> <!-- End of Jan. 15 transfer -->

</INTRATRNRS> <!-- End of third response -->

<INTRATRNRS> <!-- Fourth response -->

<TRNUID>1007 <!-- Client ID sent in this request -->

<STATUS>

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<INTRACANRS> <!-- This is the Jan. 15 cancel -->

<SRVRTID>1004 <!-- Server ID for Jan. 15 xfer -->

</INTRACANRS> <!-- End of Jan. 15 cancel -->

</INTRATRNRS> <!-- End of third xfer response -->

</INTRASYNCRS> <!-- End of second sync response -->

</BANKMSGSRSV1>

</OFX> <!-- End of response -->
```

--------------------------------

### OFX Response for Payment Activation

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example OFX message (`<ACCTTRNRS>`) showing a successful response to a payment activation request. It includes the transaction UID, status code, and details of the activated service, confirming its active status.

```XML
<ACCTTRNRS>
<TRNUID>12345
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<ACCTRS>
<SVCADD>
<BANKACCTTO>
<BANKID>1234567789
<ACCTID>12345
<ACCTTYPE>CHECKING
</BANKACCTTO>
</SVCADD>
<SVC>BPSVC
<SVCSTATUS>ACTIVE
</ACCTRS>
</ACCTTRNRS>
```

--------------------------------

### OFX E-mail Transaction Immediate Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of the immediate OFX <MAILTRNRS> response from the financial institution to an e-mail transaction request. This response echoes the original request and confirms successful receipt, indicated by a status code of 0 and severity INFO. The actual detailed response to the inquiry is expected later via a synchronization request.

```XML
<MAILTRNRS>
<TRNUID>54321
<STATUS>
<CODE>0
<SEVERITY>INFO
</STATUS>
<MAILRS>
<MAIL>
<USERID>MyUserid
<FROM>James Hackleman
<TO>Noelani Federal Savings
<SUBJECT>What do I need to earn interest?
<DTCREATED>20060305
<MSGBODY><![ CDATA [<HTML><BODY>I didn’t earn any interest this month. Can you please tell me what I need to do to earn interest on this account?</BODY></HTML>
]]></MSGBODY>
<INCIMAGES>N
<USEHTML>Y
</MAIL>
</MAILRS>
</MAILTRNRS>
```

--------------------------------

### OFX Server Response for Recurring Transfer Request

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin4.html

This OFX XML snippet demonstrates a server's response to an add recurring transfer request. It includes sign-on status, details of the recurring transfer model (e.g., frequency), and information about the first individual transfer scheduled within the immediate posting window. The response shows how the server confirms both the recurring setup and the initial transfer.

```XML
<OFX> <!-- Begin response data -->

<SIGNONMSGSRSV1>

<SONRS> <!-- Begin signon -->

<STATUS> <!-- Start of status aggregate-->

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<DTSERVER>19961101101003 <!-- Nov. 1, 1996, 10:10:03 am -->

<LANGUAGE>ENG <!-- Language used in response -->

<DTPROFUP>19961029101003 <!-- Last update to profile -->

<DTACCTUP>19961029101003 <!-- Last account update -->

</SONRS> <!-- End of signon -->

</SIGNONMSGSRSV1>

  

<BANKMSGSRSV1>

<RECINTRATRNRS> <!-- First response in file -->

<TRNUID>1001 <!-- Client ID sent in request -->

<STATUS> <!-- Start of status aggregate -->

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<RECINTRARS> <!-- Begin response -->

<RECSRVRTID>20000 <!-- Server assigned ID -->

<RECURRINST> <!-- Begin recurring aggregate -->

<FREQ>MONTHLY <!-- Monthly schedule -->

</RECURRINST> <!-- End of recurring aggregate -->

<INTRARS>

<CURDEF>USD

<SRVRTID>1000

<XFERINFO> <!-- Begin transfer aggregate -->

<BANKACCTFROM> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999988 <!-- Account number -->

<ACCTTYPE>CHECKING <!-- Account type -->

</BANKACCTFROM> <!-- End of account ID -->

<BANKACCTTO> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999977 <!-- Account number -->

<ACCTTYPE>SAVINGS <!-- Account type -->

</BANKACCTTO> <!-- End of account ID -->

<TRNAMT>1000.00 <!-- Amount of transfer -->

<DTDUE>19961115 <!-- First transfer - Nov. 15 -->

</XFERINFO> <!-- End of transfer aggregate -->

</INTRARS>

</RECINTRARS> <!-- End of response -->

</RECINTRATRNRS> <!-- End of first response -->

<INTRATRNRS> <!-- Second response in file -->

<TRNUID>1001 <!-- Client ID sent in request -->

<STATUS> <!-- Success -->

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<INTRARS> <!-- Begin transfer response -->

<CURDEF>USD

<SRVRTID>1001 <!-- Server assigned ID -->

<XFERINFO> <!-- Begin transfer aggregate -->

<BANKACCTFROM> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999988 <!-- Account number -->

<ACCTTYPE>CHECKING <!-- Account type -->

</BANKACCTFROM> <!-- End of account ID -->

<BANKACCTTO> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999977 <!-- Account number -->

<ACCTTYPE>SAVINGS <!-- Account type -->

</BANKACCTTO> <!-- End of account ID -->

<TRNAMT>1000.00 <!-- Amount of transfer -->

</XFERINFO> <!-- End transfer aggregate -->

<DTXFERPRJ>19961115 <!-- Date (interpret with code) -->

<RECSRVRTID>20000 <!-- Model that created this xfer -->

</INTRARS> <!-- End of transfer response -->

</INTRATRNRS> <!-- End of second response -->

</BANKMSGSRSV1>

</OFX> <!-- End of response data -->
```

--------------------------------

### OFX E-Mail Message Set Profile API Documentation

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

Defines the structure and tags for the E-Mail Message Set Profile information within OFX, including support indicators for generic email and GET MIME messages.

```APIDOC
_Tag_
_Description_
**<EMAILMSGSET>**
E-mail-message-set-profile-information aggregate
**<EMAILMSGSETV1>**
Opening tag for V1 of the message set profile information
**<MSGSETCORE>**
Common message set information, defined in the profile chapter
**</MSGSETCORE>**

  

**<MAILSUP>**
Y if server supports generic e-mail message, _Boolean_
**<GETMIMESUP>**
Y if server supports get MIME message, _Boolean_
**</EMAILMSGSETV1>**

  

**</EMAILMSGSET>**
```

--------------------------------

### OFX Tag Conventions and Descriptions

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

Defines the conventions for Open Financial Exchange tags, including requirements (bold), optionality, occurrence rules (once, one or more, zero or more), and value types (alphanumeric, numeric, common types). It also provides examples of tag definitions and their descriptions.

```APIDOC
OFX Tag Conventions:
  - Required Tags:
    - Always included in request/response.
    - Occur once unless noted as "one or more".
    - Indicated in **bold**.
  - Optional Tags:
    - Occur once if present unless noted as "zero or more".
  - Value Types:
    - A-n or N-n: Alphanumeric or Numeric value, n indicates max size.
    - Common value types referenced by name.

Tag Examples:
  - <REQUIREDTAG>: Required tag (1 or more)
  - <REQUIREDTAG2>: Required tag that occurs only once
  - <OPTIONALTAG>: Optional tag; this tag can occur multiple times (0 or more)
  - <SPECIFIC>: Values are A, B, and C
  - <ALPHAVALUE>: Takes an alphanumeric value up to 32 characters, A-32
```

--------------------------------

### OFX Get HTML Page (MIME) Messages

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Specifies the Open Financial Exchange messages for requesting and receiving MIME-encoded HTML pages from a Financial Institution.

```APIDOC
9.3 Get HTML Page
  9.3.1 MIME Get Request and Response
    <GETMIMERQ>: MIME Get Request
    <GETMIMERS>: MIME Get Response
```

--------------------------------

### OFX Email Synchronization Request (MAILSYNCRQ)

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Example of an OFX client request for email synchronization. The client sends its current token and specifies preferences for rejecting missing responses, including images, and using HTML.

```APIDOC
<MAILSYNCRQ>
<TOKEN>101
<REJECTIFMISSING>N
<INCIMAGES>N
<USEHTML>Y
</MAILSYNCRQ>
```

--------------------------------

### OFX Statement Download Response with Account Balance and Transactions

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin4.html

This OFX response provides the requested statement data, including sign-on status, server timestamp, and account details. It lists an updated ledger and available balance, along with two example transactions: a check and an ATM withdrawal.

```OFX
<OFX> <!-- Begin response data -->

<SIGNONMSGSRSV1>

<SONRS> <!-- Begin signon -->

<STATUS> <!-- Begin status aggregate -->

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<DTSERVER>19961029101003 <!-- Oct. 29, 1996, 10:10:03 am -->

<LANGUAGE>ENG <!-- Language used in response -->

<DTPROFUP>19961029101003 <!-- Last update to profile -->

<DTACCTUP>19961029101003 <!-- Last account update -->

</SONRS> <!-- End of signon -->

</SIGNONMSGSRSV1>

  

<BANKMSGSRSV1>

<STMTTRNRS> <!-- First response -->

<TRNUID>1001 <!-- Client ID sent in request -->

<STATUS> <!-- Start status aggregate -->

<CODE>0 <!-- OK -->

<SEVERITY>INFO

</STATUS>

<STMTRS> <!-- Begin statement response -->

<CURDEF>USD

<BANKACCTFROM> <!-- Identify the account -->

<BANKID>121099999 <!-- Routing transit or other FI ID -->

<ACCTID>999988 <!-- Account number -->

<ACCTTYPE>CHECKING <!-- Account type -->

</BANKACCTFROM> <!-- End of account ID -->

<BANKTRANLIST> <!-- Begin list of statement trans. -->

<DTSTART>19961001 <!-- Start date: Oct. 1, 1996 -->

<DTEND>19961028 <!-- End date: Oct. 28, 1996 -->

<STMTTRN> <!-- First statement transaction -->

<TRNTYPE>CHECK <!-- Check -->

<DTPOSTED>19961004 <!-- Posted on Oct. 4, 1996 -->

<TRNAMT>200.00 <!-- $200.00 -->

<FITID>00002 <!-- Unique ID -->

<CHECKNUM>1000 <!-- Check number -->

</STMTTRN> <!-- End statement transaction -->

<STMTTRN> <!-- Second transaction -->

<TRNTYPE>ATM <!-- ATM transaction -->

<DTPOSTED>19961020 <!-- Posted on Oct. 20, 1996 -->

<DTUSER>19961020 <!-- User date of Oct. 20, 1996 -->

<TRNAMT>300.00 <!-- $300.00 -->

<FITID>00003 <!-- Unique ID -->

</STMTTRN> <!-- End statement transaction -->

</BANKTRANLIST> <!-- End list of statement trans. -->

<LEDGERBAL> <!-- Ledger balance aggregate -->

<BALAMT>200.29 <!-- Bal amount: $200.29 -->

<DTASOF>199610291120 <!-- Bal date: 10/29/96, 11:20 am -->

</LEDGERBAL> <!-- End ledger balance -->

<AVAILBAL> <!-- Available balance aggregate -->

<BALAMT>200.29 <!-- Bal amount: $200.29 -->

<DTASOF>199610291120 <!-- Bal date: 10/29/96, 11:20 am -->

</AVAILBAL> <!-- End available balance -->

</STMTRS> <!-- End statement response -->

</STMTTRNRS> <!-- End of transaction -->

</BANKMSGSRSV1>

</OFX> <!-- End of response data -->
```

--------------------------------

### OFX Server Synchronization Response (PMTSYNCRS)

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-2.html

Illustrates an Open Financial Exchange (OFX) server's response to a client's synchronization request. The response includes an updated synchronization token, a LOSTSYNC flag, the originating bank account details, and multiple PMTTRNRS blocks, each detailing a payment transaction response. This example shows how the server provides missing payment information to bring the client up to date.

```XML
<PMTSYNCRS>

<TOKEN>125

<LOSTSYNC>N

<BANKACCTFROM>

<BANKID>121000248

<ACCTID>123456789

<ACCTTYPE>CHECKING

</BANKACCTFROM>

<PMTTRNRS>

<TRNUID>123

<STATUS>

... status details

</STATUS>

<PMTRS>

... details on a payment response

</PMTRS>

</PMTTRNRS>

<PMTTRNRS>

<TRNUID>546

<STATUS>

... status details

</STATUS>

<PMTRS>

... details on another payment response

</PMTRS>

</PMTTRNRS>

</PMTSYNCRS>
```

--------------------------------

### OFX E-Mail Message Set Profile API Reference

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Defines the aggregate tags and their descriptions for the OFX E-Mail Message Set Profile, including support indicators for generic e-mail and GET MIME messages. This information must be included in the profile <MSGSETLIST> response if either e-mail message set is supported.

```APIDOC
<EMAILMSGSET>: E-mail-message-set-profile-information aggregate
  <EMAILMSGSETV1>: Opening tag for V1 of the message set profile information
    <MSGSETCORE>: Common message set information, defined in the profile chapter
    </MSGSETCORE>
    <MAILSUP>: Y if server supports generic e-mail message (Boolean)
    <GETMIMESUP>: Y if server supports get MIME message (Boolean)
  </EMAILMSGSETV1>
</EMAILMSGSET>
```

--------------------------------

### OpenAIModel Class Constructor

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin2.html

Documents the `__init__` method of the `OpenAIModel` class, specifying parameters for the model name and an optional provider.

```APIDOC
OpenAIModel:
  __init__(model_name: str, provider: str = 'openai')
    model_name: The name of the OpenAI model to use
    provider: The provider to use (defaults to 'openai')
```

--------------------------------

### OFX Client Bootstrap Communication Process

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

This section describes the sequential steps a client undertakes to initiate communication within the OFX system. It covers how the client obtains necessary server URLs and the subsequent exchange of OFX requests and responses through the web server.

```APIDOC
Client Bootstrap Process:
  1. Get FI Web Server URL:
     - Initiator: Client
     - Target: FI Profile Server
     - Action: Retrieve URL for the FI Web Server.
     - Purpose: To enable the client to retrieve a particular message set.

  2. Send OFX Request:
     - Initiator: Client
     - Target: FI Web Server URL
     - Forwarding: The request is forwarded from the FI Web Server to the OFX Server.

  3. Receive OFX Response:
     - Initiator: OFX Server
     - Target: Client
     - Delivery: The response is sent back to the client via the Web Server.
```

--------------------------------

### OpenAIModel Class Initialization

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin2.html

Documents the `__init__` method of the `OpenAIModel` class, detailing its parameters (`model_name`, `provider`) with their types and default values. This class is designed to interact with OpenAI models.

```APIDOC
OpenAIModel:
  __init__(model_name: str, provider: str = 'openai')
    model_name: The name of the OpenAI model to use
    provider: The provider to use (defaults to 'openai')
```

--------------------------------

### OpenAIModel Initialization API

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-2.html

Defines the constructor for an OpenAIModel, including parameters for the model name and an optional provider. This API specification outlines how to instantiate the model.

```APIDOC
OpenAIModel:
  __init__(model_name: str, provider: str = 'openai')
    model_name: The name of the OpenAI model to use
    provider: The provider to use (defaults to 'openai')
```

--------------------------------

### OFX MIME Get Response (GETMIMERS) API Definition

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Defines the structure for an OFX response to a MIME Get request. The response echoes the URL, with the actual content sent as a separate multi-part MIME section.

```APIDOC
GETMIMERS:
  Description: Get-MIME-response aggregate
  Tags:
    URL:
      Description: URL
      Type: URL
```

--------------------------------

### OFX Recurring Payment Response Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX response message (<RECPMTRS>) confirming the creation of a recurring payment. It includes the server-assigned recurring transaction ID (<RECSRVRTID>) which is crucial for subsequent modifications or cancellations by the client.

```XML
<RECPMTRS>
<RECSRVRTID>387687138
<RECURRINST>
<NINSTS>12
<FREQ>MONTHLY
</RECURRINST>
<PMTINFO>
<BANKACCTFROM>
<BANKID>555432180
<ACCTID>763984
<ACCTTYPE>CHECKING
</BANKACCTFROM>
<TRNAMT>395.00
<PAYEEID>77810
<PAYACCT>444-78-97572
<DTDUE>20061115
<MEMO>Auto loan payment
</PMTINFO>
</RECPMTRS>
```

--------------------------------

### OFX MIME Get Status Codes

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin3.html

Lists the standard status codes returned for OFX MIME Get operations, indicating success or various error conditions such as general errors, duplicate requests, or invalid/unreachable URLs.

```APIDOC
MIME Get Status Codes:
  0: Success (INFO)
  2000: General error (ERROR)
  2019: Duplicate request (ERROR)
  16502: Invalid URL (ERROR)
  16503: Unable to get URL (ERROR)
```

--------------------------------

### OpenAIModel Class API Definition

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-2.html

This snippet defines the structure and initialization method for the OpenAIModel class. It details the parameters required for instantiation, specifically the model name and an optional provider.

```APIDOC
OpenAIModel:
  __init__(model_name: str, provider: str = 'openai')
    model_name: The name of the OpenAI model to use
    provider: The provider to use (defaults to 'openai')
```

--------------------------------

### OpenAIModel Class Constructor API

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

API documentation for the `__init__` method of the `OpenAIModel` class, detailing its parameters, their types, and descriptions. This snippet illustrates how to define a class constructor in an API specification format.

```APIDOC
OpenAIModel:\n  __init__(model_name: str, provider: str = 'openai')\n    model_name: The name of the OpenAI model to use\n    provider: The provider to use (defaults to 'openai')
```

--------------------------------

### Multi-part HTTP Response with OFX and HTML MIME Content

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

Illustrates a multi-part HTTP response (multipart/x-mixed-replace) containing an OFX GETMIMETRNRS response and an HTML page, demonstrating the use of MIME boundaries.

```HTTP
HTTP 1.0 200 OK

Content-Type: multipart/x-mixed-replace; boundary =--boundary—

  

--boundary--

Content-Type: application/x-ofx

Content-Length: 8732

  

OFXHEADER:100

DATA:OFXSGML  

VERSION:103  

SECURITY:TYPE1  

ENCODING:USASCII



<OFX>

<!-- signon not shown

message set wrappers not shown -->

<GETMIMETRNRS>

<TRNUID>54321

<STATUS>

<CODE>0

<SEVERITY>INFO

</STATUS>

<GETMIMERS>

<URL>http://www.fi.com/apage.html

</GETMIMERS>

</GETMIMETRNRS>

</OFX>

  

--boundary--

Content-Type: text/html



<HTML>

<!-- standard HTML page -->

</HTML>

  

--boundary--
```

--------------------------------

### OFX E-mail Transaction Request Example

Source: https://github.com/ofxutilities/ofxspecs/blob/main/OFX1.0.3/OFX103-3.html

An example of an OFX <MAILTRNRQ> request used by a consumer to inquire about a checking statement. This snippet demonstrates how to structure an e-mail request, including sender, recipient, subject, creation date, and the message body, which is protected within an SGML CDATA section for HTML content.

```XML
<MAILTRNRQ>
<TRNUID>54321
<MAILRQ>
<MAIL>
<USERID>MyUserid
<FROM>James Hackleman
<TO>Noelani Federal Savings
<SUBJECT>What do I need to earn interest?
<DTCREATED>20060305
<MSGBODY><![ CDATA [<HTML><BODY>I didn’t earn any interest this month. Can you please tell me what I need to do to earn interest on this account?</BODY></HTML>
]]></MSGBODY>
<INCIMAGES>N
<USEHTML>Y
</MAIL>
</MAILRQ>
</MAILTRNRQ>
```

--------------------------------

### Building the OFX Request - Cryptographic Steps

Source: https://github.com/ofxutilities/ofxspecs/blob/main/ofx1.0.2spec/Ofexfin1.html

This section details the cryptographic and encoding steps required to prepare user credentials (password and random octets) for inclusion in an OFX request. It outlines the generation of random data, SHA1 hashing, RSA encryption, and RADIX64 encoding to produce the CT2 ciphertext for the <USERPASS> field. It also specifies the minor variations for handling the <PINCHRQ>.

```APIDOC
1. Client generates 16 random octets and places them in NC (see RFC 1750 for recommendations on entropy generation)
2. Client obtains the User’s password (P)
3. Client computes T = SHA1(NS || P || NC)
4. Client generates 57 pseudo-random, non-zero octets and places them in PS (NC may be used to seed the pseudo-random number generator)
5. Client sets D = NC || P || T
6. Client sets EB = 0x00 || BT || PS || 0x00 || D
7. Client RSA-encrypts EB using the Server’s Type 1 public key (obtained from the Server’s Type 1 certificate): CT1 = EKS(EB) (see PKCS #1, §§8.2-8.4)
8. Client encodes the ciphertext for transport: CT2 = RADIX64(CT1). See RFC 1113, §4.3.2.4 and §4.3.2.5. This is a standard encoding method supported by RSA’s Bsafe library and others.
9. Client constructs the body of its OFX request
10. Client copies CT2 to the <USERPASS> field of the OFX <SONRQ>
11. Client sends the complete OFX request to the Server

In <PINCHRQ>, the steps are identical, except that in step 2, P is set to <NEWUSERPASS> and in step 10, CT2 is copied to the <NEWUSERPASS> field of the <PINCHRQ>.
```