Create a deposit switch without using Plaid Exchange

v1.0.0

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.

Input

{
  "type": "object",
  "description": "DepositSwitchAltCreateRequest defines the request schema for `/deposit_switch/alt/create`",
  "required": [
    "target_account",
    "target_user"
  ],
  "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_account": {
      "type": "object",
      "description": "The deposit switch destination account",
      "required": [
        "account_name",
        "account_number",
        "account_subtype",
        "routing_number"
      ],
      "properties": {
        "account_name": {
          "type": "string",
          "description": "The name of the deposit switch destination account, as it will be displayed to the end user in the Deposit Switch interface. It is not required to match the name used in online banking."
        },
        "account_number": {
          "type": "string",
          "description": "Account number for deposit switch destination"
        },
        "account_subtype": {
          "type": "string",
          "description": "The account subtype of the account, either `checking` or `savings`.",
          "enum": [
            "checking",
            "savings"
          ]
        },
        "routing_number": {
          "type": "string",
          "description": "Routing number for deposit switch destination"
        }
      }
    },
    "target_user": {
      "type": "object",
      "description": "The deposit switch target user",
      "required": [
        "email",
        "family_name",
        "given_name",
        "phone"
      ],
      "properties": {
        "address": {
          "type": "object",
          "description": "The user's address.",
          "required": [
            "city",
            "country",
            "postal_code",
            "region",
            "street"
          ],
          "properties": {
            "city": {
              "type": "string",
              "description": "The full city name"
            },
            "country": {
              "type": "string",
              "description": "The ISO 3166-1 alpha-2 country code"
            },
            "postal_code": {
              "type": "string",
              "description": "The postal code"
            },
            "region": {
              "type": "string",
              "description": "The region or state\nExample: `\"NC\"`"
            },
            "street": {
              "type": "string",
              "description": "The full street address\nExample: `\"564 Main Street, APT 15\"`"
            }
          }
        },
        "email": {
          "type": "string",
          "description": "The email address of the user."
        },
        "family_name": {
          "type": "string",
          "description": "The family name (last name) of the user."
        },
        "given_name": {
          "type": "string",
          "description": "The given name (first name) of the user."
        },
        "phone": {
          "type": "string",
          "description": "The phone number of the user. The endpoint can accept a variety of phone number formats, including E.164."
        },
        "tax_payer_id": {
          "type": "string",
          "description": "The taxpayer ID of the user, generally their SSN, EIN, or TIN."
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "description": "DepositSwitchAltCreateResponse defines the response schema for `/deposit_switch/alt/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."
    }
  }
}