A Transfer is a simple, universal description of the routing of funds between Accounts.
Transfers abstract the complexity of this routing, and may contain one or more children elements that compose the full path between accounts. Transfers are the result of a triggered and successfully processed Routine.
The Transfer Object
| Parameter | Data Type | Description |
|---|---|---|
id | string | The unique ID of the Transfer |
routine_type | string | The type of parent Routine (one-time, percentage-based, percentage-balance, recurring, refill, round-up, sweep, fifty-two-week) |
routine_name | string | The name given for the parent Routine |
routine_id | string | The unique ID for the parent Routine |
source_id | string | The ID of the Source Account |
destination_id | string | The ID of the Destination Account |
amount | float | The amount of the Transfer |
payment_type | string | The type of payment (ach, debit, ledger) |
initiated | date | The date the Transfer started processing |
updated | date | The date the Transfer status was last updated |
estimated_clearing_date | date | The date the Transfer is estimated to clear to the destination account (at the time it is initiated) |
status | string | The status of the Transfer (pending, cancelled, processed, failed) |
Note that
processedmeans that the transfer has completed and the funds have cleared and settled in the destination account.