IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

SyncPayeeIdScope Property

Scope of the payee Id .

Syntax

 billpayment.getSyncPayeeIdScope(index, [callback])

Default Value

""

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 the getSyncPayeeIdScope([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setSyncPayeeIdScope([callback]) 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

Scope of the payee SyncPayeeId.

Possible values are:

ValueMeaning
GLOBALPayee Id is valid across the entire payee system
USERPayee Id is valid across all FI accounts for this user

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

This property is read-only and not available at design time.

Data Type

String

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