depositSwitchGet
This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
DepositSwitchGetRequest defines the request schema for /deposit_switch/get
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 ID of the deposit switch
Response Body
application/json
curl -X POST "https://example.com/deposit_switch/get" \ -H "Content-Type: application/json" \ -d '{ "deposit_switch_id": "string" }'{ "target_item_id": "MdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7bX5hE", "target_account_id": "bX5hEMdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7", "deposit_switch_id": "LjDyMfMkVpqLmEm1VR7bQikR3BX5hEMdRAkq1", "state": "completed", "switch_method": "instant", "date_created": "2019-11-01", "date_completed": "2019-11-01", "account_has_multiple_allocations": true, "is_allocated_remainder": false, "percent_allocated": 50, "amount_allocated": null, "employer_name": "COMPANY INC", "employer_id": "pqLmEm1VR7bQi11231", "institution_name": "Bank of America", "institution_id": "ins_1", "request_id": "lMjeOeu9X1VUh1F"}webhookVerificationKeyGet POST
Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
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.