sync_transfer_id Property

Server-assigned id of the bank transfer being initiated, modified or synchronized.

Syntax

def get_sync_transfer_id(sync_transfer_index: int) -> str: ...

Default Value

""

Remarks

Server-assigned id of the bank transfer being initiated, modified or synchronized.

The sync_transfer_id uniquely identifies a transfer. This is assigned by the server when the transfer is initiated (when the on_transfer_funds method is called.

As a unique transfer identifier, the sync_transfer_id is required to be provided (as parameter) when a transfer modification or cancellation requests are submitted (i.e., when on_modify_transfer or on_cancel_transfer methods are called) for a scheduled transfer.

This is also required to be provided when submitting the same request types via the OFXBatch class (for each transfer that is going to be part of the batch).

It is also returned for each payment being synchronized when the on_synchronize_transfers method is called.

The sync_transfer_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_transfer_count property.

This property is read-only.