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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
client_id |
String | No |
Your Plaid API |
options |
Object | No |
An optional set of options to be used when configuring the Item. If specified, must not be |
options.override_username |
String | No |
Test username to use for the creation of the Sandbox Item. Default value is Default value: "user_good" |
options.override_password |
String | No |
Test password to use for the creation of the Sandbox Item. Default value is Default value: "pass_good" |
institution_id |
String | Yes |
The ID of the institution the Item will be associated with |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.