transfer_funds Method
Transfers money from one account to another within the same or different Financial Institution(s).
Syntax
def transfer_funds() -> None: ...
Remarks
This function generates the Signon and Intrabank or Interbank Transfer request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.
The following properties can 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) |
| transfer | (required) |
Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:
| transfer_id | |
| transfer_currency_code | |
| transfer_date_posted or transfer_date_projected | (not both) |
| transfer_status | |
| transfer_date_processed |
If the request is for an immediate transfer and the server can perform the transfer in real time, the server should indicate whether the transfer succeeded and should return the date of the transfer in transfer_date_posted. In this case, synchronization is not required.
In all cases, a server cannot provide complete confirmation for the transfer. The server can only confirm that it received the transfer instruction; and possibly whether it validated the accounts, amount, and date specified in the transfer. For any transfer where the client does not know the status at the time of the response, a server should confirm that it accepted the instruction by assigning a transfer_id and indicate the transfer_date_projected if the transfer_date_posted is not available. A client can pick up the confirmation at a later date through a synchronization request by calling the synchronize_transfers method.
The interbank funds transfers differ from intrabank funds transfers in the following respects:
- The routing and transit number of the destination account differs from the source account. That means that the transfer_from_bank_id and transfer_to_bank_id should both be set (if the account type is different than CreditCard).
- At the discretion of an FI, the destination account (identified by transfer_to_account_id) can be subject to pre-notification.
- Source and destination accounts must be enabled for the Automated Clearing House (ACH).
The Interbank Funds Transfer is subject to the rules and regulations governing the ACH network. In all other respects, interbank funds transfers function like intrabank funds transfers.