IPWorks OFX 2020 Python Edition

Questions / Feedback?

on_sync_transfers Event

Fired for each intrabank transfer transaction included in the synchronization response.

Syntax

class BankTransferSyncTransfersEventParams(object):
  @property
  def transfer_aggregate() -> str: ...
  @property
  def transfer_tx_type() -> str: ...
  @property
  def transfer_id() -> str: ...
  @property
  def transfer_amount() -> str: ...
  @property
  def from_account_id() -> str: ...
  @property
  def to_account_id() -> str: ...
  @property
  def transfer_status() -> str: ...
  @property
  def transfer_date_posted() -> str: ...

# In class BankTransfer:
@property
def on_sync_transfers() -> Callable[[BankTransferSyncTransfersEventParams], None]: ...
@on_sync_transfers.setter
def on_sync_transfers(event_hook: Callable[[BankTransferSyncTransfersEventParams], None]) -> None: ...

Remarks

When this event is fired for each intrabank transfer transaction included in the response (if any), the following are returned for each transfer transaction identified by TransferId:

  • TransferAggregate contains the aggregate for a transfer transaction.
  • TransferTx indicates the transfer transaction type, if this is a new, modified or canceled one (possible values: ADD, MOD, CAN).
  • TransferId contains the server id of a transaction in the list of transfers (if any) returned in the synchronization response.
  • TransferAmount contains the amount of a transfer transaction.
  • FromAccountId contains the account number a transfer has been sent from.
  • ToAccountId contains the account number a transfer has been sent to.
  • TransferStatus contains the status of a transfer transaction.
  • TransferDatePosted contains the actual date of a transfer transaction.

If what you need is not returned through this event, you can always parse each TransferAggregate using our OFXAggregate component.

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