cancel_transfer Method
Cancels a scheduled transfer.
Syntax
def cancel_transfer(transfer_id: str) -> None: ...
Remarks
This function generates the Signon and Transfer Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.
The TransferId parameter identifies the transfer to be canceled. This is the id assigned and returned by the server at the time the transfer was scheduled (that was stored in transfer_id).
The following properties should be set when this method is called:
fi_url | (required) |
fi_id | (required) |
fi_organization | (required) |
ofx_app_id | (required) |
ofx_app_version | (required) |
ofx_version | (required if 2.x OFX version is the one supported by your FI) |
ofx_user | (required) |
ofx_password | (required) |
Upon successful response, the server will return the transfer_id which echoes the TransferId.