SyncPayees Event

Fired for each payee included in the synchronization response.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireSyncPayees(BillPaymentSyncPayeesEventParams *e);

typedef struct {
  const char *PayeeAggregate;
  const char *PayeeTxType;
  const char *PayeeId;
  const char *PayeeIdScope;
  const char *PayeeListId;
  const char *PayeeAccount;
  const char *PayeeName;
  const char *PayeeAddr1;
  const char *PayeeAddr2;
  const char *PayeeAddr3;
  const char *PayeeCity;
  const char *PayeeState;
  const char *PayeePostalCode;
  const char *PayeeCountry;
  const char *PayeePhone;
  int reserved;
} BillPaymentSyncPayeesEventParams;

Unicode (Windows)
virtual INT FireSyncPayees(BillPaymentSyncPayeesEventParams *e);

typedef struct {
  LPCWSTR PayeeAggregate;
  LPCWSTR PayeeTxType;
  LPCWSTR PayeeId;
  LPCWSTR PayeeIdScope;
  LPCWSTR PayeeListId;
  LPCWSTR PayeeAccount;
  LPCWSTR PayeeName;
  LPCWSTR PayeeAddr1;
  LPCWSTR PayeeAddr2;
  LPCWSTR PayeeAddr3;
  LPCWSTR PayeeCity;
  LPCWSTR PayeeState;
  LPCWSTR PayeePostalCode;
  LPCWSTR PayeeCountry;
  LPCWSTR PayeePhone;
  INT reserved;
} BillPaymentSyncPayeesEventParams;

- (void)onSyncPayees:(NSString*)payeeAggregate :(NSString*)payeeTxType :(NSString*)payeeId :(NSString*)payeeIdScope :(NSString*)payeeListId :(NSString*)payeeAccount :(NSString*)payeeName :(NSString*)payeeAddr1 :(NSString*)payeeAddr2 :(NSString*)payeeAddr3 :(NSString*)payeeCity :(NSString*)payeeState :(NSString*)payeePostalCode :(NSString*)payeeCountry :(NSString*)payeePhone;

#define EID_BILLPAYMENT_SYNCPAYEES 5

virtual INT IPWORKSOFX_CALL FireSyncPayees(LPSTR &lpszPayeeAggregate, LPSTR &lpszPayeeTxType, LPSTR &lpszPayeeId, LPSTR &lpszPayeeIdScope, LPSTR &lpszPayeeListId, LPSTR &lpszPayeeAccount, LPSTR &lpszPayeeName, LPSTR &lpszPayeeAddr1, LPSTR &lpszPayeeAddr2, LPSTR &lpszPayeeAddr3, LPSTR &lpszPayeeCity, LPSTR &lpszPayeeState, LPSTR &lpszPayeePostalCode, LPSTR &lpszPayeeCountry, LPSTR &lpszPayeePhone);

Remarks

When this event is fired for each payee included in the response (if any), the following are returned for each payee identified by PayeeListId:

• PayeeAggregate contains the complete aggregate for a payee.
• PayeeTxType indicates the payee transaction type, if this is added, modified or deleted (possible values: ADDED, MODIFIED, DELETED).
• PayeeId contains the server-assigned id of a payee.
• PayeeIdScope contains Scope of a payee ID in the payee list (GLOBAL, USER), where GLOBAL = payee ID valid across the entire payment system USER = payee ID valid with all FI accounts set up for the user's payments account.
• PayeeListId contains the list record id of a payee in the payee list.
• PayeeAccount contains the account the user has with a payee in the payee list.
• PayeeName contains the name of a payee in the payee list.
• PayeeAddr1 contains the street address (line 1) of a payee in the payee list.
• PayeeAddr2 contains the address line 2 of a payee in the payee list.
• PayeeAddr3 contains the address line 3 of a payee in the payee list.
• PayeeCity contains the city name of a payee in the payee list.
• PayeeState contains the state name of a payee in the payee list.
• PayeePostalCode contains the postal code of a payee in the payee list.
• PayeeCountry contains the country name of a payee in the payee list.
• PayeePhone contains the phone number of a payee in the payee list.

If what you need is not returned through this event parameters, you can always parse each PayeeAggregate using our OFXAggregate component.