Create a recurring transfer

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

The Plaid access_token for the account that will be debited or credited.

A random key provided by the client, per unique recurring transfer. Maximum of 50 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a recurring transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single recurring transfer is created.

The Plaid account_id corresponding to the end-user account that will be debited or credited.

Specify the account used to fund the transfer. Customers can find a list of funding_account_ids in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank, it will default to the default funding_account_id specified during onboarding.

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

Networks eligible for recurring transfers.

Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.

Codes supported for credits: ccd, ppd Codes supported for debits: ccd, ppd, tel, web

"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts

"ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits.

"web" - Internet-Initiated Entry. The transfer debits a consumer's bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.

"tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent. If the authorization's guarantee_details.outcome is PARTIAL_INSTANT_ONLY, this field is required when calling /transfer/create.

If the end user is initiating the specific transfer themselves via an interactive UI, this should be true; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false.

The currency of the transfer amount. The default value is "USD".

The description of the recurring transfer.

Plaid's unique identifier for a test clock. This field may only be used when using the sandbox environment. If provided, the created recurring_transfer is associated with the test_clock. New originations are automatically generated when the associated test_clock advances. For more details, see Simulating recurring transfers.

A decision regarding the proposed transfer.

approved - The proposed transfer has received the end user's consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended. Refer to the code field in the decision_rationale object for details.

declined - Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.

user_action_required - An action is required before Plaid can assess the transfer risk and make a decision. The most common scenario is to update authentication for an Item. To complete the required action, initialize Link by setting transfer.authorization_id in the request of /link/token/create. After Link flow is completed, you may re-attempt the authorization request.

For guarantee requests, approved indicates the transfer is eligible for Plaid's guarantee, and declined indicates Plaid will not provide guarantee coverage for the transfer. user_action_required indicates you should follow the above guidance before re-attempting.

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.