SyncPayments Event

Fired for each payment transaction included in the synchronization response.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireSyncPayments(BillPaymentSyncPaymentsEventParams *e);

typedef struct {
  const char *PaymentAggregate;
  const char *PaymentTxType;
  const char *PaymentId;
  const char *PayeeId;
  const char *PayeeListId;
  const char *PayeeAccount;
  const char *PayeeAggregate;
  const char *PaymentAmount;
  const char *FromAccountId;
  const char *PaymentStatus;
  const char *PaymentDate;
  int reserved;
} BillPaymentSyncPaymentsEventParams;

Unicode (Windows)
virtual INT FireSyncPayments(BillPaymentSyncPaymentsEventParams *e);

typedef struct {
  LPCWSTR PaymentAggregate;
  LPCWSTR PaymentTxType;
  LPCWSTR PaymentId;
  LPCWSTR PayeeId;
  LPCWSTR PayeeListId;
  LPCWSTR PayeeAccount;
  LPCWSTR PayeeAggregate;
  LPCWSTR PaymentAmount;
  LPCWSTR FromAccountId;
  LPCWSTR PaymentStatus;
  LPCWSTR PaymentDate;
  INT reserved;
} BillPaymentSyncPaymentsEventParams;

- (void)onSyncPayments:(NSString*)paymentAggregate :(NSString*)paymentTxType :(NSString*)paymentId :(NSString*)payeeId :(NSString*)payeeListId :(NSString*)payeeAccount :(NSString*)payeeAggregate :(NSString*)paymentAmount :(NSString*)fromAccountId :(NSString*)paymentStatus :(NSString*)paymentDate;

#define EID_BILLPAYMENT_SYNCPAYMENTS 6

virtual INT IPWORKSOFX_CALL FireSyncPayments(LPSTR &lpszPaymentAggregate, LPSTR &lpszPaymentTxType, LPSTR &lpszPaymentId, LPSTR &lpszPayeeId, LPSTR &lpszPayeeListId, LPSTR &lpszPayeeAccount, LPSTR &lpszPayeeAggregate, LPSTR &lpszPaymentAmount, LPSTR &lpszFromAccountId, LPSTR &lpszPaymentStatus, LPSTR &lpszPaymentDate);

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.