Transfers

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	Optional	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
`destination_user_id`	`string`	`True`	The User ID of the Destination User
`amount`	`float`		The amount of the Transfer
`client_correlation_id`	`string`	`True`	An optional correlation id that will be added to ACH or Debit Addenda. This will also be included in the Transfer response.
`payment_type`	`string`	`True`	The type of payment (`ach`, `debit`, `ledger`). If the payment route contains a mix of payment types, then this field will not be returned.
`processor`	`string`		The processor of the payment
`initiated`	`date`		The date the Transfer started processing
`updated`	`date`	`True`	The date the Transfer status was last updated
`estimated_clearing_date`	`date`	`True`	The date the Transfer is estimated to clear to the destination account (at the time it is initiated).
`failure_reason`	`string`		The reason that transfer was not successful
`status`	`string`		The status of the Transfer (`pending`, `cancelled`, `processed`, `failed`)

📘
Note that processed means that the transfer has completed and the funds have cleared and settled in the destination account.

📘
Note that a parameter that does not have a value set will not be returned. For example, client_correlation_id and estimated_clearing_date (but not limited to these two examples) may not have values set depending on the payment route, and will not be returned in the Transfer object in this case.