SyncPayments Event

Fired for each payment transaction included in the synchronization response.

Syntax

class BillPaymentSyncPaymentsEventParams {
public:
  const QString &PaymentAggregate();
  const QString &PaymentTxType();
  const QString &PaymentId();
  const QString &PayeeId();
  const QString &PayeeListId();
  const QString &PayeeAccount();
  const QString &PayeeAggregate();
  const QString &PaymentAmount();
  const QString &FromAccountId();
  const QString &PaymentStatus();
  const QString &PaymentDate();
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SyncPayments(BillPaymentSyncPaymentsEventParams *e);

// Or, subclass BillPayment and override this emitter function.
virtual int FireSyncPayments(BillPaymentSyncPaymentsEventParams *e) {...}

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.