SyncPayeeListId Property

Server-assigned payee list record ID for this payee.

Object Oriented Interface

public function getSyncPayeeListId($syncpayeeindex);

Procedural Interface

ipworksofx_billpayment_get($res, 73 , $syncpayeeindex);

Default Value



Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a SyncPayeeId, the SyncPayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a SyncPayeeId to this payee.

It is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

The value of SyncPayeeListId is used as parameter when the ModifyPayee or DeletePayee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

The $syncpayeeindex 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


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