IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

GetProfile Method

Download the message set profile for a given Financial Institution.

Syntax

fiprofile.getProfile([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This function generates the Signon and FIProfile request page, submits it to the financial institution via HTTP, receives the response, and parses it. Individual transactions are downloaded with the statement.

Read-only properties that are populated as a result of response parsing include:

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Node.js Edition - Version 20.0 [Build 7941]