Ledgersync

LedgerSync Rest API

Getting Started

Authentication

Authenticate

Accounts

Add Bank Account Widget Integration

Add Lite Bank Account Widget Integration

Fix Bank Account Connection Integration

List Bank Accounts

List Sub-Accounts

Get Account Summary

Refresh Accounts

Update Account

Delete Bank Account

Clients

Add Client

List Clients

Update Client

Delete Client

Institutions

List institutions

Transactions

List Transactions

Transaction Status

Refresh Transactions

Refresh Historic Transactions

Statements

List Statements

Download Statement

Convert Statement

Checks

List Checks

Webhooks

Handling Webhooks

Webhooks Events

Retries

Testing

Ledgersync Rest API

Production

Sandbox

<p class="slate-p " >The Ledgersync Rest API provides developers with access to essential financial data retrieval and synchronization functionalities. Users can integrate this API to seamlessly fetch and update information related to transactions, accounts, and other financial data sources. This API serves as a vital resource for automating and streamlining financial data management processes within applications.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Ledgersync Rest API provides developers with access to essential financial data retrieval and synchronization functionalities. Users can integrate this API to seamlessly fetch and update information related to transactions, accounts, and other financial data sources. This API serves as a vital resource for automating and streamlining financial data management processes within applications.

<p class="slate-p" placeholder="Type / for widgets">Welcome to the Ledgersync documentation! This guide will quickly walk you through the essential steps needed to start using our API, including how to register for a customer account and authenticate your API requests. Additionally, we&apos;ll introduce you to our Sandbox environment, perfect for testing your integrations.</p><h4 class="slate-h4">Quick Start</h4><p class="slate-p" placeholder="Type / for widgets">Before integrating with our API in a live environment, we recommend experimenting with our Sandbox to safely test your implementations. Follow these steps to get started:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Register a Customer Account in the Live Environment</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Visit <a href="https://ledgersyncappv2.com/sign-up" target="_new">https://ledgersyncappv2.com/sign-up</a> to create your customer account for the live environment. You will need to provide your email and password during registration.</div></li></ul></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Register for the Sandbox Environment</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">For testing purposes, access our Sandbox environment at <a href="https://104.196.54.242.sslip.io/staging/sign-up" target="_new">https://104.196.54.242.sslip.io/staging/sign-up</a>. Register here to create a separate account for development and testing.</div></li></ul></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">API Authentication</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Use the email and password from your registration (for both live and Sandbox environments) to authenticate your API requests. Remember, credentials for the live and Sandbox environments are separate and not interchangeable.</div></li></ul></li></ol><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

Welcome to the Ledgersync documentation! This guide will quickly walk you through the essential steps needed to start using our API, including how to register for a customer account and authenticate your API requests. Additionally, we'll introduce you to our Sandbox environment, perfect for testing your integrations.

Before integrating with our API in a live environment, we recommend experimenting with our Sandbox to safely test your implementations. Follow these steps to get started:

<p>Securing access to the LedgerSync is essential for protecting your data and ensuring that only authorized users can perform operations. Our API employs a token-based authentication system to facilitate this security measure.</p><h4>Obtaining Your Authentication Token</h4><ol><li><div><span></span></div></li></ol>

Securing access to the LedgerSync is essential for protecting your data and ensuring that only authorized users can perform operations. Our API employs a token-based authentication system to facilitate this security measure.

<p>The Account API section allows users to retrieve detailed information about accounts within the Ledgersync system. Users can access account details, such as account numbers, types, and statuses, to easily manage and track financial information. This section provides essential data for seamless integration and efficient account management within the Ledgersync platform.</p><p></p>

The Account API section allows users to retrieve detailed information about accounts within the Ledgersync system. Users can access account details, such as account numbers, types, and statuses, to easily manage and track financial information. This section provides essential data for seamless integration and efficient account management within the Ledgersync platform.

<p>The Clients section in Ledgersync allows users to retrieve detailed information about clients, such as their contact details, account status, and transaction history. By accessing this section, users can efficiently manage client data and gain insights into their financial relationships.</p>

The Clients section in Ledgersync allows users to retrieve detailed information about clients, such as their contact details, account status, and transaction history. By accessing this section, users can efficiently manage client data and gain insights into their financial relationships.

<p>The Transaction API section in Ledgersync allows users to retrieve detailed information about financial transactions within their account. With this API, users can access essential data related to each transaction, enabling them to track and manage their financial activity effectively.</p><p></p>

The Transaction API section in Ledgersync allows users to retrieve detailed information about financial transactions within their account. With this API, users can access essential data related to each transaction, enabling them to track and manage their financial activity effectively.

<p>The Statement API section in Ledgersync allows users to retrieve detailed financial statements and transaction data. Users can access comprehensive information about their accounts and transactions, enabling them to efficiently manage their financial records and analyze their financial performance. This API section empowers users with valuable insights into their financial health and facilitates seamless integration with other financial tools.&lt;</p>

The Statement API section in Ledgersync allows users to retrieve detailed financial statements and transaction data. Users can access comprehensive information about their accounts and transactions, enabling them to efficiently manage their financial records and analyze their financial performance. This API section empowers users with valuable insights into their financial health and facilitates seamless integration with other financial tools.

<p>The Checks API allows users to retrieve detailed information about checks, including their status, amount, and payment details. With this API, users can easily access and manage check data for efficient tracking and reconciliation processes.</p>

The Checks API allows users to retrieve detailed information about checks, including their status, amount, and payment details. With this API, users can easily access and manage check data for efficient tracking and reconciliation processes.

<p class="slate-p" placeholder="Type / for widgets">Webhooks allow your application to receive real-time notifications about specific events that occur within our platform. By setting up webhooks, your system can automatically respond to these events, enabling seamless integration and efficient workflows.</p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

Webhooks allow your application to receive real-time notifications about specific events that occur within our platform. By setting up webhooks, your system can automatically respond to these events, enabling seamless integration and efficient workflows.

<p class="slate-p" placeholder="Type / for widgets">When an event you are subscribed to occurs, our system will send an HTTP POST request to your specified callback URL. The payload will be in JSON format and include detailed information about the event.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Example Payload:</strong></p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-6-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;eventType&quot;: &quot;accountAdded&quot;,</div><div class="slate-code_line">  &quot;eventId&quot;: &quot;b52e0e1c-611f-43fb-89c4-401a34eb91ba &quot;,</div><div class="slate-code_line">  &quot;timestamp&quot;: &quot;2024-07-15 13:07:07.727&quot;,</div><div class="slate-code_line">  &quot;payload&quot;: {</div><div class="slate-code_line">    &quot;accounts&quot;: &quot;[1542, 1367, 1257]&quot;,</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

When an event you are subscribed to occurs, our system will send an HTTP POST request to your specified callback URL. The payload will be in JSON format and include detailed information about the event.

<ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-code">accountAdded</code></span></span></div></li><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-code">mfaUpdated</code></span></span></div></li><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-code">transactionsRefreshed</code></span></span></div></li><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(42, 0, 255);font-size:10pt" class="slate-code">bankAccountDeleted</code></span></span></div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

To ensure the reliability and delivery of webhook events, our system employs an automatic retry mechanism. If an initial webhook delivery attempt fails, the system will attempt to resend the event according to a predefined retry schedule. This approach helps to account for temporary issues such as network disruptions or server downtimes on the receiving end.

The retry mechanism follows an exponential backoff strategy with an initial delay of 30 seconds. The system will attempt retries up to a maximum duration of 3 days. The retry intervals increase exponentially as follows:

A retry is triggered if the initial delivery attempt fails due to receiving any HTTP response code other than a 2xx status code (e.g., 200 OK, 201 Created). This includes, but is not limited to:

The system will continue to retry delivery for a maximum of 3 days. If the event has not been successfully delivered after this period, the delivery attempts will cease, and the event will be marked as failed.

The exponential backoff strategy helps to reduce the load on both the sender and the receiver by gradually increasing the time between retries. This ensures that temporary issues on the receiving server have time to resolve before the next attempt is made.

Upon successful delivery of the webhook event (i.e., when a 2xx response code is received), no further retries will be attempted. The system will mark the event as successfully delivered, and you will no longer see retry attempts for that specific event.

To ensure the best experience and reliability in receiving webhooks:

This section designed to assist developers in thoroughly testing their integration with our API using simulated financial institution data. This ensures that your application can gracefully handle various scenarios, from successful connections to handling errors and multi-factor authentication (MFA) challenges.

To facilitate effective testing, we recommend using "Finbank" within the widget to simulate bank connections. Finbank is a fictional financial institution available in the testing environment that mimics real bank behavior, allowing you to test different user scenarios without connecting to actual banks.

Below is a table of usernames, passwords, and the expected outcomes when using these credentials in the testing environment. These accounts cover a range of scenarios, including successful connections, handling of various MFA types, and error simulations.