SyncPayments Event
Fired for each payment transaction included in the synchronization response.
Syntax
public event OnSyncPaymentsHandler OnSyncPayments; public delegate void OnSyncPaymentsHandler(object sender, BillpaymentSyncPaymentsEventArgs e); public class BillpaymentSyncPaymentsEventArgs : EventArgs { public string PaymentAggregate { get; } public string PaymentTxType { get; } public string PaymentId { get; } public string PayeeId { get; } public string PayeeListId { get; } public string PayeeAccount { get; } public string PayeeAggregate { get; } public string PaymentAmount { get; } public string FromAccountId { get; } public string PaymentStatus { get; } public string PaymentDate { get; } }
Public Event OnSyncPayments As OnSyncPaymentsHandler Public Delegate Sub OnSyncPaymentsHandler(sender As Object, e As BillpaymentSyncPaymentsEventArgs) Public Class BillpaymentSyncPaymentsEventArgs Inherits EventArgs Public ReadOnly Property PaymentAggregate As String Public ReadOnly Property PaymentTxType As String Public ReadOnly Property PaymentId As String Public ReadOnly Property PayeeId As String Public ReadOnly Property PayeeListId As String Public ReadOnly Property PayeeAccount As String Public ReadOnly Property PayeeAggregate As String Public ReadOnly Property PaymentAmount As String Public ReadOnly Property FromAccountId As String Public ReadOnly Property PaymentStatus As String Public ReadOnly Property PaymentDate As String End Class
Remarks
When this event is fired for each payment transaction included in the response (if any), the following are returned for each payment transaction identified by PaymentId:
- PaymentAggregate contains the aggregate for a payment transaction.
- PaymentTxType indicates the payment transaction type, if this is added, modified or canceled (possible values: ADDED, MODIFIED, CANCELLED).
- PaymentId contains the server id of a transaction in the list of payment transactions (if any) returned in the synchronization response.
- PayeeId contains the id of the payee the payment has been sent to.
- PayeeListId contains the list id of the payee the payment has been sent to.
- PayeeAccount contains the account the user has with the payee the payment has been sent to.
- PayeeAggregate contains the info aggregate (name and address details) of the payee the payment has been sent to.
- PaymentAmount contains the amount of a payment transaction.
- FromAccountId contains the account number a payment has been sent from.
- PaymentStatus contains the status of a payment transaction.
- PaymentDate contains the date of a payment transaction.
If what you need is not returned through this event, you can always parse each PaymentAggregate using our OFXAggregate component.