IPWorks OFX 2020 Delphi Edition

Questions / Feedback?

SyncPayees Event

Fired for each payee included in the synchronization response.

Syntax

type TSyncPayeesEvent = procedure (
  Sender: TObject;
  const PayeeAggregate: String;
  const PayeeTxType: String;
  const PayeeId: String;
  const PayeeIdScope: String;
  const PayeeListId: String;
  const PayeeAccount: String;
  const PayeeName: String;
  const PayeeAddr1: String;
  const PayeeAddr2: String;
  const PayeeAddr3: String;
  const PayeeCity: String;
  const PayeeState: String;
  const PayeePostalCode: String;
  const PayeeCountry: String;
  const PayeePhone: String
) of Object;

property OnSyncPayees: TSyncPayeesEvent read FOnSyncPayees write FOnSyncPayees;

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.

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