Sandbox

sandboxProcessorTokenCreate

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.

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

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*string

The ID of the institution the Item will be associated with

options?

An optional set of options to be used when configuring the Item. If specified, must not be null.

Response Body

application/json

application/json

curl -X POST "https://example.com/sandbox/processor_token/create" \  -H "Content-Type: application/json" \  -d '{    "institution_id": "string"  }'
{  "processor_token": "processor-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d",  "request_id": "Aim3b"}