Sign in
plaid

Create a deposit switch

This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

post/deposit_switch/create

Request body

client_idstring

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.

secretstring

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.

target_access_tokenstring required

Access token for the target Item, typically provided in the Import Item response.

target_account_idstring required

Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit.

country_code'US' | 'CA' nullable

ISO-3166-1 alpha-2 country code standard.

Response

OK

deposit_switch_idstring required

ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch.

request_idstring required

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

Changes