View as Markdown
Plaid icon

Plaid ACTION

Create Sandbox Public Token

Creates a valid public_token for an arbitrary institution ID, initial products, and test credentials. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Plaid account once, then configure and run Create Sandbox Public Token from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "plaid-create-sandbox-public-token",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plaid: { authProvisionId: "apn_xxxxxxx" },
    institutionId: "Institution ID",
    initialProducts: ["Initial Products"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Sandbox Public Token inputs
Property Type Description
institutionId Institution ID string
The ID of the institution the Item will be associated with
Required
initialProducts Initial Products string[]
The products to initially pull for the Item. May be any products that the specified institution supports.
Required
webhookUrl Webhook URL string
The URL to which Plaid should send webhook notifications. You must configure at least one webhook to enable webhooks.
Optional
userToken User Token string
The user token associated with the User data is being requested for.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
plaid-create-sandbox-public-token
Version
0.0.2
App
Plaid
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes