Test Plaid

When you've set up and enabled Plaid in UAT, you can test your integration with Plaid's sandbox. You'll need to:

  • Set up a test company in UAT.
  • Generate a Link URL to connect your test company to Plaid's sandbox.
  • Connect a test account.

Set up a test company

  1. Go to the Codat portal in UAT and log in.
  2. Go to Companies.
  3. On the right side of the page, select Add new company.
  4. Enter a name for your test company and select Add.
  5. Keep the Companies page open in a separate browser tab. You'll need it for the next stage of the process.

Generate a Link URL

To connect your test company to Plaid's sandbox, you can either generate a Link URL from the Codat portal or via the API.

Generate a Link URL from the Codat portal

  1. On the Companies page of the Codat portal, scroll down until you find the test company that you created earlier.
  2. Next to the company name, select View Link URL.
    The Links URL... dialog box is displayed.
  3. At the bottom of the dialog box, select Create.
  4. Copy the generated URL and go straight to Connect to Plaid's sandbox.

Generate a Link URL via the API

  1. Open the POST /companies/{companyId}/connections endpoint.
  2. Replace {companyId} with the ID of the test company you've just set up.
  3. Also, in the body of the request, enter the platform key:
"plaid"
  1. Send your request.
    Codat generates a unique link to Plaid's sandbox. For example:
{
  "id": "33f13646-e3f0-458a-b6ee-f5c1f38c1fdb",
  "integrationId": "580146ed-7556-4f92-8bf9-7344667763ec",
  "sourceId": "46ee0089-dc88-405a-9667-9fb3d9976f19",
  "platformName": "Plaid",
  "linkUrl": "https://link-uat.codat.io/link/start/b8673b25-4444-0000-9906-0fecbfe4d2e3/33f13646-e3f0-458a-b6ee-f5c1f38c1fdb",
  "status": "PendingAuth"
}

📘

Linking customers in Plaid

When you move to a production environment, you'll supply a link URL to each customer. The link URL is the start of the authorisation process that allows you to retrieve data from your customer's bank account.

On request, Codat can enable an additional step in the authorisation journey to allow customers to use the same link URL to connect multiple bank accounts. Contact the support team for more information.

Connect to Plaid's sandbox

For testing only, you'll follow the process that your customers normally use to authorise a connection to their bank account.

  1. Copy the linkUrl value into your browser, which takes you to Plaid's sandbox.

A message at the bottom of the screen confirms that you're in sandbox mode.

  1. Select Continue.
    A dialog box shows a list of available bank accounts that have sample data for testing. This is Plaid's secure link site.
  2. Select the bank account type you're interested in, or if it's not listed, search for it first.
  3. Select Continue to Bank Name.
    As this is the sandbox, you're taken to a Plaid authentication page. For live bank accounts, a login page is displayed.
  4. Select Grant Access.
  5. Wait until a confirmation page is displayed.

You're now ready to start testing.

Check your banking data

You can check the data from the account you've linked to Plaid's sandbox in two ways.

To do a quick check from the Codat portal.

  1. Open the Codat portal in UAT and log in.
  2. In the left pane, select Companies, and search for the test company that you created.
  3. Select View Data next to the company name.
  4. On the company's Data page, select Bank Statements to see accounts and related transaction data, or generate and download an Excel spreadsheet. Sample bank accounts and transactions are shown on the final tabs.
  5. To retrieve account details from the API, use either of the following endpoints:

GET/companies/{companyId}/connections/{connectionId}/data/bankAccounts

GET/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions


Did this page help you?