Skip to main content

Synchronize Statement

POST 
/v2/financial/accounts/:financial_account_uid/statement_transactions/sync

Synchronizes the bank statement of a financial account. Fetches transactions directly from the financial institution through API. Requires active connection.

Asynchronous Processing: This endpoint is processed asynchronously and creates a statement synchronization command for the Financial Account.

Statement synchronization of a Financial Account is done asynchronously, that is, when receiving the request, our API stores the request parameters and creates a Command. This command is processed in the background and then confirmed and the transactions will be imported into the Financial Account. You receive in the response of this request the ID of the created command and can query it anytime.

See more in List Financial Account Commands and View a Command.

In order to execute the Statement Synchronization, there must be an active Connection (i.e., validated and enabled) associated with the Financial Account.

Synchronization Period​

The fields start_at and end_at are optional and delimit the window to synchronize. When omitted, the default window goes from the first day of the current month until today.

  • informing only start_at, the end date assumed is today;
  • informing only end_at, the start date assumed is the first day of the month of end_at;
  • the end date cannot be in the future;
  • the maximum period is 2 years back from today.

Windows that span more than one calendar month are sliced into one command per month. This keeps each request to the financial institution within a volume that the bank can respond to, and allows reprocessing only the month that eventually fails. A window within the same month continues to create a single command.

Tracking the Import​

In addition to the command in data, the response brings in sync the record of the requested import, with its own uid. Use this uid to track the entire set — especially in multi-month windows, where several commands are created — in Query Statement Synchronization.

Webhook Events​

When the request is made, a financial.account.statement_sync.requested event is triggered. Our server then begins communication with the financial institution's API to fetch transactions. Only after it is confirmed at the financial institution, then the statement is updated. At this moment the financial.account.statement_sync.confirmed event is triggered.

Request​

Responses​

Command created per month for multi-month window