Sandbox endpoints

1const publicTokenRequest: SandboxPublicTokenCreateRequest = {
2  institution_id: institutionID,
3  initial_products: initialProducts,
4};
5try {
6  const publicTokenResponse = await client.sandboxPublicTokenCreate(
7    publicTokenRequest,
8  );
9  const publicToken = publicTokenResponse.data.public_token;
10  // The generated public_token can now be exchanged
11  // for an access_token
12  const exchangeRequest: ItemPublicTokenExchangeRequest = {
13    public_token: publicToken,
14  };
15  const exchangeTokenResponse = await client.itemPublicTokenExchange(
16    exchangeRequest,
17  );
18  const accessToken = exchangeTokenResponse.data.access_token;
19} catch (error) {
20  // handle error
21}

1const request: SandboxItemResetLoginRequest = {
2  access_token: accessToken,
3};
4try {
5  const response = await plaidClient.sandboxItemResetLogin(request);
6  // create a public_token for the Item and use it to
7  // initialize Link in update mode.
8  const pt_request: itemPublicTokenCreateRequest = {
9    access_token: accessToken,
10  };
11  const pt_response = await plaidClient.itemCreatePublicToken(pt_request);
12  const publicToken = pt_response.public_token;
13} catch (error) {
14  // handle error
15}

1const request: SandboxItemSetVerificationStatusRequest = {
2  access_token: accessToken,
3  account_id: accountID,
4  verification_status: 'automatically_verified',
5};
6try {
7  const response = await plaidClient.sandboxItemSetVerificationStatus(request);
8} catch (error) {
9  // handle error
10}

1// Fire a DEFAULT_UPDATE webhook for an Item
2const request: SandboxItemFireWebhookRequest = {
3  access_token: accessToken
4  webhook_code: 'DEFAULT_UPDATE'
5};
6try {
7  const response = await plaidClient.sandboxItemFireWebhook(request);
8} catch (error) {
9  // handle error
10}

1const request: SandboxBankTransferSimulateRequest = {
2  bank_transfer_id,
3  event_type: 'posted',
4  failure_reason: failureReason,
5};
6try {
7  const response = await plaidClient.sandboxBankTransferSimulate(request);
8  // empty response upon success
9} catch (error) {
10  // handle error
11}

1const request: SandboxBankTransferFireWebhookRequest = {
2    webhook: 'https://www.example.com'
3  };
4try {
5  const response = await plaidClient.sandboxBankTransferFireWebhook(request);
6  // empty response upon success
7} cathch(error) {
8    // handle error
9}

1const request: SandboxIncomeFireWebhookRequest = {
2    income_verification_id: '4b58120d-159b-42d2-9967-d87e93c2a005',
3    item_id: 'Rn3637v1adCNj5Dl1LG6idQBzqBLwRcRZLbgM',
4    webhook: 'https://webhook.com/',
5    verification_status: 'VERIFICATION_STATUS_PROCESSING_COMPLETE'
6  };
7try {
8  const response = await plaidClient.sandboxIncomeFireWebhook(request);
9  // empty response upon success
10} cathch(error) {
11    // handle error
12}

1const request: SandboxProcessorTokenCreateRequest = {
2  institution_id: institutionID,
3};
4try {
5  const response = await plaidClient.sandboxProcessorTokenCreate(request);
6  const processorToken = response.data.processor_token;
7} catch (error) {
8  // handle error
9}