Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Deposit Switch

depositSwitchAltCreate

POST
/deposit_switch/alt/create

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.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

DepositSwitchAltCreateRequest defines the request schema for /deposit_switch/alt/create

client_id?string

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.

secret?string

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_account*
target_user*
options?

Options to configure the /deposit_switch/create request. If provided, cannot be null.

country_code?CountryCode1

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

Value in

  • "US"
  • "CA"

Response Body

application/json

curl -X POST "https://example.com/deposit_switch/alt/create" \  -H "Content-Type: application/json" \  -d '{    "target_account": {      "account_number": "string",      "routing_number": "string",      "account_name": "string",      "account_subtype": "checking"    },    "target_user": {      "given_name": "string",      "family_name": "string",      "phone": "string",      "email": "string"    }  }'
{  "deposit_switch_id": "c7jMwPPManIwy9rwMewWP7lpb4pKRbtrbMomp",  "request_id": "lMjeOeu9X1VUh1F"}

depositSwitchGet POST

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.

depositSwitchCreate POST

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