Quiltt Logo

Accounts

An Account in Quiltt represents the accounting of a banking relationship. Accounts are typically associated with a Connection from a data provider like Plaid or MX, and provide access to balances, transactions and other data.

Metadata

Like many other resources, accounts support persisting arbitrary information via a `metadata` object. This can be used to store nicknames, custom timestamps, status indicators and other data that may be useful to retrieve later. See the API Reference or the Custom Metadata guide for more information.

Link to this section#Schemas & Types

Profile GraphQL API Reference

To access the full documentation and typings, explore the schema in the GraphQL API Reference. or use the GraphQL Explorer in the Quiltt Dashboard

Link to this section#Queries

Account queries allow you to fetch data about a specific Account or a list of Accounts associated with the Profile, or a Connection.

Link to this section#The account Query

Looks up a Account by its ID:

query {
  account(id: "acct_12tgD1YP33AwEvbdmSrcRY") {
    id
    name
    type
    verified
    metadata
    institution {
      name
    }
    connection {
      id
      provider
    }
  }
}

Link to this section#Response

{
  "data": {
    "account": {
      "id": "acct_12tgD1YP33AwEvbdmSrcRY",
      "name": "Credit Card",
      "type": "CREDIT",
      "verified": false,
      "metadata": null,
      "institution": {
        "name": "MX Bank"
      },
      "connection": {
        "id": "conn_12tgD1WgzFgsy9fqKpW9b3",
        "provider": "MX"
      }
    }
  }
}

Link to this section#The accounts Query

Lists and filters the Accounts associated with the Profile:

query GetAccounts {
  accounts {
    id
    name
    type
    verified
    metadata
    institution {
      name
    }
  }
}

Link to this section#Response

{
  "data": {
    "accounts": [
      {
        "id": "acct_12tgD1YSYYFtFGYQDz21fk",
        "name": "Savings",
        "type": "SAVINGS",
        "verified": false,
        "metadata": null,
        "institution": {
          "name": "MX Bank"
        }
      },
      {
        "id": "acct_12tErBqz5oPva4qlsZ9Po8",
        "name": "Plaid Bronze Standard 0.2% Interest CD",
        "type": "SAVINGS",
        "verified": false,
        "metadata": null,
        "institution": {
          "name": "Tartan Bank"
        }
      },
      ...
    ]
  }
}

Link to this section#Mutations

Account mutations allow you to update an individual Account.

Link to this section#The accountUpdate Mutation

Updates an Account with new metadata. This is useful for storing additional information about the Account, such as a user-friendly name:

mutation AccountUpdate {
  accountUpdate(
    input: { id: "acct_12v1nh5epXlyU8vr7QB8PJ", metadata: { nickname: "My Checking Account" } }
  ) {
    success
    record {
      id
      metadata
    }
  }
}

Link to this section#Response

{
  "data": {
    "accountUpdate": {
      "success": true,
      "record": {
        "id": "acct_12v1nh5epXlyU8vr7QB8PJ",
        "metadata": {
          "nickname": "My Checking Account"
        }
      }
    }
  }
}
GraphQL →