IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

AddPayee Method

Add a payee to server's payee list.

Syntax

billpayment.addPayee([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 Add Payee request, submits it to the financial institution via HTTP, receives the response, and parses it.

The following properties can be set when this method is called:

FIUrl (required)
FIId (required)
FIOrganization (required)
OFXAppId (required)
OFXAppVersion (required)
OFXUser (required)
OFXPassword (required)
Payee (required)
PaymentToBankId (optional)
PaymentToAccountId (optional)
PaymentToAccountType(optional)

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:

PayeeId (optional)
PayeeListId (always returned)
PayeeDaysToPay (always returned)
PayeeIdScope (optional)
all input values for payee (name, address, phone, account) and destination bank account are echoed in the response

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