SyncPayeeId Property

Server-assigned payee identifier.

Object Oriented Interface

public function getSyncPayeeId($syncpayeeindex);

Procedural Interface

ipworksofx_billpayment_get($res, 71 , $syncpayeeindex);

Default Value



Server-assigned payee identifier.

The SyncPayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either SyncPayeeId or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the SyncPayeeAggregate or payee details represented by required properties: SyncPayeeName, SyncPayeeAddr1, SyncPayeeCity, SyncPayeeState, SyncPayeePostalCode, SyncPayeePhone, and optional properties: SyncPayeeAddr2, SyncPayeeAddr3, SyncPayeeCountry, SyncPayeeAccount.

The SyncPayeeId might be populated when: either a payment request (PayBill method is called) or an add payee request (AddPayee method is called) has been sent to the payment server, or when the SyncPayeeAggregate has been set.

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]