Skip to main content
Follow the steps in Get started with connectors before proceeding. Plaid access: An active Plaid Enrich contract and the credentials required for API authentication. Sync Hub: Sync Hub deployed and configured for your Banking OS runtime. For more information, see Sync Hub overview. Network connectivity: Network connectivity between Banking OS and Plaid. For supported options, see Network connectivity.

Prepare the connector

Backbase deploys this connector. To share connectivity details and provide the environment details, follow these steps:
  1. Share connectivity details. Share connectivity details between Banking OS and Plaid as described in Network connectivity.
  2. Send environment details to Backbase. Send the Plaid Enrich API base URL, client ID, and secret to your Backbase support team. Banking OS sends the client ID and secret to Plaid as the PLAID-CLIENT-ID and PLAID-SECRET request headers.
For property names and defaults, see Reference.

Set up the sandbox

Use the Plaid Enrich sandbox to explore enrichment requests before you integrate through Banking OS.
  1. Obtain sandbox credentials and the Postman collection your Banking OS program team provides.
  2. Import the Postman collection and environment into Postman.
  3. Run sample enrichment requests against the Plaid sandbox to confirm credentials, request shape, and response fields.
  4. Compare Plaid field names with the Banking OS mapping in the Plaid field mapping sheet.
For sandbox coordination and environment updates, contact your Banking OS program team.

Test your integration

  1. Call POST {baseURL}/internal/transactions/enrichment with a test batch that includes a UUID enrichmentRequestId, a partyInformation array, and at least one account with at least one transaction.
  2. Confirm Banking OS returns 202 with an empty body.
  3. Confirm the connector publishes transactionsEnriched to Sync Hub after the synchronous Plaid Enrich call completes.
  4. Verify downstream consumers receive the expected enrichment payload, including category, merchant, and location fields.
For operation and event details, see Reference. For the full contract, see API playground.

Troubleshooting

If the connector does not respond as expected, check these common scenarios.
Cause: Plaid client credentials are missing or incorrect.Solution: Verify credentials with Plaid, then ask your Backbase support team to update the connection.
Cause: Banking OS cannot reach the Plaid Enrich endpoint within the configured timeout.Solution: Confirm network routing and the operational status of the Plaid environment.
Cause: Azure Service Bus (ASB) producer properties point to the wrong topic, or the connector failed before publishing to Sync Hub.Solution: Ask your Backbase support team to check Sync Hub publishing and the connector logs for mapping or vendor errors after the Plaid Enrich call.