Example requests for additional banking data

Example proxy requests to the Plaid and TrueLayer APIs

Use the following examples to help you make requests to Plaid or TrueLayer endpoints through the proxy.

Example request to Plaid

All requests to the Plaid APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. use POST; the actual method is defined as a path parameter. This example shows a proxy request to the /item/get endpoint in the Plaid APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms..

POST /companies/{companyId}/connections/{connectionId}/data/proxy?endpoint=item/get

• companyId: The ID of a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. for which you are authorized to access banking data through the Plaid integration.

• connectionId: ConnectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. ID of a linked data connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. for the specified companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources..

If successful, a list of Plaid items associated with the connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is returned.

Example request to TrueLayer

This example shows a proxy request to the /direct-debits endpoint in the TrueLayer Data APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms..

1. Get an account ID from the Bank accounts endpoint in the Codat APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.:

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

• companyId: The ID of a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. for which you are authorized to access banking data through the TrueLayer integration.

• connectionId: ConnectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. ID of a linked data connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. for the specified companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources..

2. Make a GET request to the /direct_debits endpoint in the TrueLayer APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.:

GET /companies/{companyId}/connections/{connectionId}/data/proxy?endpoint=accounts/{account_id}/direct_debits

• account_id: The ID of the account in TrueLayer to retrieve direct debits for.

If successful, a list of direct debits associated with the account is returned.

Errors

Errors returned through the proxy from the Plaid or TrueLayer APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. always contain a canBeRetried: “Unknown” parameter in the response. This parameter can be ignored.