The Scheduled Transfer object

ScheduledTransfer is a payment on a date or a recurrence.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

api_key_idstringOptional

approval_idstringOptional

consecutive_failuresintegerRequired

counterparty_idstringOptional

created_atstring · date-timeRequired

created_bystringRequired

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

descriptionstringRequired

end_datestring · date or nullOptional

A business date, YYYY-MM-DD

frequencystringRequired

idstringRequired

last_run_idstringOptional

last_transfer_idstringOptional

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_runsintegerOptional

next_occurrenceintegerRequired

next_run_datestring · date or nullOptional

A business date, YYYY-MM-DD

non_banking_daystringRequired

railstringRequired

runs_completedintegerRequired

start_datestring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Pending_approval, active, paused, completed, cancelled or rejected

status_reasonstringOptional

to_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm