Quiltt Logo

Statements

Welcome to the Quiltt API tutorial for the new Statements feature. This guide will walk you through setting up, using, and understanding the Statements functionality. Follow the steps below to get started.

Link to this section#Pre-requisites

  1. Ensure you have access to the Quiltt Dashboard. (You can sign up here)
  2. Ensure you have an existing Connector set up (if not, you'll create one during this tutorial).

Link to this section#Step 1: Prepare Connector

  1. Navigate to the "Connectors" page in your Dashboard.
  2. Create a new Connector if you don’t already have one set up.
  3. Scroll down to the "Settings" section.
  4. Ensure the Email OTP Authenticate method is enabled to be able to preview the Connector. This can be disabled in after you've validated the integration.
  5. Ensure that the "Statements" feature is enabled, along with a Connect provider like MX.

Link to this section#Step 2: Complete Connector Flow

  1. Click the "Preview Connector" button to launch the Connector.
  2. Log in or create a new Profile.
  3. Select your Sandbox Connector provider.
  4. Use the Institution Search screen to select the provider of your choice.
  5. Once the flow is completed, we will start syncing and processing statements in the background.

Note that some providers will bring their own sandbox experience with fake PDFs that you can use. If a provider doesn't have a native development preview, Quiltt will create a a "Mock" statement preview. In Sandbox, you can always use the Mock provider to make sure you receive a Statement.

Link to this section#Step 3: Query Statements with GraphQL

To help you develop your GraphQL Queries you can use the GraphQL Explorer, available from the Profiles page in the Dashboard.

Link to this section#Get all Statements

The below GraphQL query fetches the id and url fields, along with the account associated with each statement. You can also fetch the startOn and endOn dates for each statement.

Link to this section#Filter for the Most Recent Statements

This query will return all accounts with the most recently available statement.

Link to this section#Handle Variable Statement Periods

Different banks may have different statement start and end dates. To account for this, you can query specific date ranges if necessary (e.g., from 6/01 to 6/30).

The below query lets you return statements covering a specific date range.

Link to this section#Look up a Statement on a Specific Date

The below query queries for a statement on May 15th. This is useful for bookkeeping/accounting use-cases, if you need to verify a particular transaction on a given day.

Link to this section#Step 4: Set Up Webhooks

Webhooks are the best way to be notified when new statements are available. Follow the steps below to set them up:

  1. Access the Environment's "Webhooks" page in the Dashboard.
  2. Set up Webhook Subscription
    • Create a new webhook subscription or edit an existing one.
    • Subscribe to the statement.created event if you don't need the statement period metadata and want to get the documents as quickly as possible
    • Subscribe to the statement.ready event if you need the statement to be enriched with its date period metadata.
  3. Listen for Webhook Events
    • Webhook events will notify you when a statement is created and when it is ready.
    • The Statement events provides the statement ID, account ID, and a URL to download the statement.

Link to this section#Sample Payload

Link to this section#Wrapping it up

You have now successfully set up and used the Statements feature in Quiltt. If you have any questions or need further assistance, please contact our support team.

Connector →