action plaid_deposit_switch_create {
  label: "Create a deposit switch"
  description: "This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch."
  provider: plaid
  method: POST
  path: "/deposit_switch/create"
  encoding: json
  input: {
    type: "object"
    description: "DepositSwitchCreateRequest defines the request schema for `/deposit_switch/create`"
    required: ["target_access_token", "target_account_id"]
    properties: {
      client_id: {
        type: "string"
        description: "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."
      }
      country_code: {
        type: "string"
        description: "ISO-3166-1 alpha-2 country code standard."
        enum: ["US", "CA"]
      }
      options: {
        type: "object"
        description: "Options to configure the `/deposit_switch/create` request. If provided, cannot be `null`."
        properties: {
          transaction_item_access_tokens: {
            type: "array"
            description: "An array of access tokens corresponding to transaction items to use when attempting to match the user to their Payroll Provider. These tokens must be created by the same client id as the one creating the switch, and have access to the transactions product."
            items: {
              type: "string"
              description: "The access token associated with the Item data is being requested for."
            }
          }
          webhook: {
            type: "string"
            description: "The URL registered to receive webhooks when the status of a deposit switch request has changed.\n"
          }
        }
      }
      secret: {
        type: "string"
        description: "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_token: {
        type: "string"
        description: "Access token for the target Item, typically provided in the Import Item response. "
      }
      target_account_id: {
        type: "string"
        description: "Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit."
      }
    }
  }
  output: {
    type: "object"
    description: "DepositSwitchCreateResponse defines the response schema for `/deposit_switch/create`"
    required: ["deposit_switch_id", "request_id"]
    properties: {
      deposit_switch_id: {
        type: "string"
        description: "ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch."
      }
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
    }
  }
}