SyncPayees Event

Fired for each payee included in the synchronization response.

Syntax

• C#
• VB.NET

public event OnSyncPayeesHandler OnSyncPayees;

public delegate void OnSyncPayeesHandler(object sender, BillpaymentSyncPayeesEventArgs e);

public class BillpaymentSyncPayeesEventArgs : EventArgs {
  public string PayeeAggregate { get; }
  public string PayeeTxType { get; }
  public string PayeeId { get; }
  public string PayeeIdScope { get; }
  public string PayeeListId { get; }
  public string PayeeAccount { get; }
  public string PayeeName { get; }
  public string PayeeAddr1 { get; }
  public string PayeeAddr2 { get; }
  public string PayeeAddr3 { get; }
  public string PayeeCity { get; }
  public string PayeeState { get; }
  public string PayeePostalCode { get; }
  public string PayeeCountry { get; }
  public string PayeePhone { get; }
}

Public Event OnSyncPayees As OnSyncPayeesHandler

Public Delegate Sub OnSyncPayeesHandler(sender As Object, e As BillpaymentSyncPayeesEventArgs)

Public Class BillpaymentSyncPayeesEventArgs Inherits EventArgs
  Public ReadOnly Property PayeeAggregate As String
  Public ReadOnly Property PayeeTxType As String
  Public ReadOnly Property PayeeId As String
  Public ReadOnly Property PayeeIdScope As String
  Public ReadOnly Property PayeeListId As String
  Public ReadOnly Property PayeeAccount As String
  Public ReadOnly Property PayeeName As String
  Public ReadOnly Property PayeeAddr1 As String
  Public ReadOnly Property PayeeAddr2 As String
  Public ReadOnly Property PayeeAddr3 As String
  Public ReadOnly Property PayeeCity As String
  Public ReadOnly Property PayeeState As String
  Public ReadOnly Property PayeePostalCode As String
  Public ReadOnly Property PayeeCountry As String
  Public ReadOnly Property PayeePhone As String
End Class

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.