Create a scheduled transfer

POST/scheduled-transfers

Schedule a payment to a counterparty or a transfer between the customer's accounts: today, on a date, or on a recurrence; under the account's approval policy it waits for its approvers

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

Minor units of the currency (cents for USD)

counterparty_idstringOptional

created_bystringRequired

currency_codestringRequired

ISO 4217 code

descriptionstringRequired

end_datestring · date or nullOptional

A business date, YYYY-MM-DD

frequencystringOptional

Once (default), weekly, biweekly, semimonthly, monthly, quarterly or annually

max_runsintegerOptional

non_banking_daystringOptional

Previous (default) or next

railstringOptional

Defaults to the counterparty's pay_by

start_datestring · date or nullOptional

Today by default

to_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Returns

201 Created

The Scheduled Transfer object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503