depositSwitchCreate
This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
DepositSwitchCreateRequest defines the request schema for /deposit_switch/create
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.
Access token for the target Item, typically provided in the Import Item response.
Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit.
ISO-3166-1 alpha-2 country code standard.
Value in
- "US"
- "CA"
Options to configure the /deposit_switch/create request. If provided, cannot be null.
Response Body
application/json
curl -X POST "https://example.com/deposit_switch/create" \ -H "Content-Type: application/json" \ -d '{ "target_access_token": "string", "target_account_id": "string" }'{ "deposit_switch_id": "c7jMwPPManIwy9rwMewWP7lpb4pKRbtrbMomp", "request_id": "lMjeOeu9X1VUh1F"}depositSwitchAltCreate POST
This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
depositSwitchTokenCreate POST
In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.