Create a test Item and processor token

POST /sandbox/processor_token/create

Use the /sandbox/processor_token/create endpoint to create a valid processor_token for an arbitrary institution ID and test credentials. The created processor_token corresponds to a new Sandbox Item. You can then use this processor_token with the /processor/ API endpoints in Sandbox. You can also use /sandbox/processor_token/create with the user_custom test username to generate a test account with custom data.

Request Body

Required

SandboxProcessorTokenCreateRequest defines the request schema for /sandbox/processor_token/create

Parameters

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.
institution_id
required, string
The ID of the institution the Item will be associated with
options
object
An optional set of options to be used when configuring the Item. If specified, must not be null.
override_username
string
Test username to use for the creation of the Sandbox Item. Default value is user_good.
override_password
string
Test password to use for the creation of the Sandbox Item. Default value is pass_good.

Response

SandboxProcessorTokenCreateResponse defines the response schema for /sandbox/processor_token/create

Response Properties

processor_token
required, string
A processor token that can be used to call the /processor/ endpoints.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.