Get started

Complete the following prerequisites and configuration to start using the Plaid Connector.

​

Prerequisites

Before you begin, make sure you meet the following requirements:

• You have completed the steps in Get started with connectors.
• You have deployed and configured Sync Hub for your Grand Central runtime.
• You have an active Plaid Enrich contract and the credentials required for API authentication.
• You have network connectivity between Grand Central and Plaid. For supported options, see Network connectivity.

​

Configuration

To configure the Plaid Connector, follow these steps:

1. When you call the unified API, set the api-key request header to YOUR_SUBSCRIPTION_KEY.
2. Obtain the Enrich API base URL, client ID, and secret for your Plaid sandbox or production environment. Grand Central sends the client ID and secret to Plaid as the PLAID-CLIENT-ID and PLAID-SECRET request headers. The connector maps the PLAID_CLIENT_ID and PLAID_SECRET environment variables to the api.plaid.clientId and api.plaid.secret properties.
3. Configure the Plaid Enrich URL and credentials in the transaction-enrichment-v0.values.yaml file in the gc-applications-live repository:
   # Plaid Enrich API URL
   api.plaid.url=PLAID_ENRICH_URL
   # Plaid client ID (resolves from PLAID_CLIENT_ID)
   api.plaid.clientId=${PLAID_CLIENT_ID}
   # Plaid secret (resolves from PLAID_SECRET)
   api.plaid.secret=${PLAID_SECRET}
   
4. Confirm that the transaction-enrichment-v0.values.yaml file is in the following path. Replace RUNTIME with your runtime name, such as dev or test:
   ├── iPaaS
   └── azure/runtimes
       └── RUNTIME
           └── values
               └── gc-plaid
                   └── transaction-enrichment-v0.values.yaml
   
5. Configure the following Sync Hub Azure Service Bus (ASB) producer properties in transaction-enrichment-v0.values.yaml so the transactionsEnriched event reaches the correct topic and schema version:
   asb.event.version=1.1.0
   asb.event.type=transactionsEnriched
   asb.event.source=gc-plaid-transaction-enrichment-connector
   asb.event.topic=transactions-enriched
   asb.producer.apiUri=http://asb-producer-v0.synchub-producer.svc.cluster.local
   
6. Store the client ID and secret as the PLAID_CLIENT_ID and PLAID_SECRET environment variables in a SOPS secret. For more information, see How to create SOPS.

​

Set up the sandbox

Use the Plaid Enrich sandbox to explore enrichment requests before you integrate through Grand Central.

1. Obtain sandbox credentials and the Postman collection your Grand Central 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 Grand Central mapping in the Plaid field mapping sheet.

For sandbox coordination and environment updates, contact your Grand Central 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 Grand Central 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.