Skip to main content

Connections


AnchorOverview

A Connection in Quiltt serves as the primary way to ingest and sync financial data about a user. Connections are typically created from a data source like Plaid, and allow you to retrieve account information, transactions and other data, depending on the data source and connection configuration.

Quiltt provides source-specific GraphQL mutations to support the lifecycle management of your user’s connections. Once a connection is set up, Quiltt will automatically ingest permissioned data, keep it in sync, and make it available via GraphQL.


AnchorSchemas

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


AnchorQueries

Anchorconnection

Look up a Connection by its ID

query($id: ID!) {
connection(id: $id) {
id
metadata
sourceType
status
institution {
name
logo {
url
}
}
accounts {
id
name
}
}
}
AnchorVariables
{
"id": "CONNECTION_ID"
}

Anchorconnections

Get a list of Connections

query {
connections {
id
metadata
sourceType
status
institution {
name
logo {
url
}
}
accounts {
id
name
}
}
}

AnchorShared Mutations

AnchorconnectionDelete

Delete a connection

mutation ConnectionDelete($input: ConnectionDeleteInput) {
connectionDelete(input: $input) {
success
record {
id
}
errors {
message
path
}
}
}
AnchorConnectionDeleteInput

Autogenerated input type of connectionDelete

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idID!ID of Connection
AnchorConnectionDeletePayload

Autogenerated return type of ConnectionDelete

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[Error!]List of errors from mutation
recordConnectionTypeConnection
successBoolean!Status of the mutation

AnchorconnectionUpdate

mutation ConnectionUpdate($input: ConnectionUpdateInput!) {
connectionUpdate(input: $input) {
errors {
message
}
record {
id
metadata
}
success
}
}
AnchorConnectionUpdateInput

Autogenerated input type of ConnectionUpdate

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idID!ID of the connection
metadataJSONCustomizable metadata
AnchorConnectionUpdatePayload

Autogenerated return type of ConnectionUpdate

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[Error!]List of errors from mutation
recordConnectionTypeUpdated Connection Information
successBoolean!Status of the mutation

AnchorPlaid-specific Mutations

AnchorconnectorPlaidInitialize

Create a Plaid Link Token to configure an instance of Link

mutation ConnectorPlaidInitialize(
$input: ConnectorPlaidInitializeInput
) {
connectorPlaidInitialize(input: $input) {
success
record {
connectorStatus
connectorToken
expiration
linkToken
requestId
}
errors {
code
message
}
}
}
AnchorConnectorPlaidInitializeInput

Autogenerated input type of ConnectorPlaidInitialize

FieldTypeDescription
accountFiltersPlaidLinkTokenAccountFiltersBy default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the products parameter of /link/token/create, and, if auth is specified in the products array, will also filter out accounts other than checking and savings accounts on the Account Select pane. You can further limit the accounts shown in Link by using account_filters to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value “all”. If the account_filters filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the Account schema.
androidPackageNameStringThe name of your app’s Android package. Required if using the link_token to initialize Link on Android. When creating a link_token for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the developer dashboard.
authPlaidLinkTokenCreateRequestAuthSpecifies options for initializing Link for use with the Auth product. This field is currently only required if using the Flexible Auth product (currently in closed beta).
clientMutationIdStringA unique identifier for the client performing the mutation.
clientNameStringThe name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display “This Application” instead. Defaults to your Quiltt deployment’s branding.
connectionIdIDUsed when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow.
countryCodes[String!]An array of Plaid-supported country codes using ISO-3166-1 alpha-2 country code standard
euConfigPlaidLinkTokenEUConfigConfiguration parameters for EU flows
featuresConnectionFeature!The features for initializing a connector
languageStringThe language that Link should be displayed in. Supported languages are: English (“en”) French (“fr”) Spanish (“es”) Dutch (“nl”) German(“de”). When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.
linkCustomizationNameStringThe name of the Link customization from the Plaid Dashboard to be applied to Link
products[String!]List of products to use with Link
updatePlaidLinkTokenCreateRequestUpdateSpecifies options for initializing Link for update mode.
AnchorConnectorPlaidInitializePayload

Autogenerated return type of ConnectorPlaidInitialize

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[PlaidAPIError!]Plaid API Error
recordPlaidConnector
successBoolean!Status of the mutation

AnchorconnectorPlaidClose

Create or Update a Plaid Connection from a successful Link submission

mutation ConnectorPlaidClose(
$input: ConnectorPlaidCloseInput
) {
connectorPlaidClose(input: $input) {
success
record {
id
accounts {
id
name
}
institution {
name
logo
}
}
errors {
code
message
}
}
}
AnchorConnectorPlaidCloseInput

Autogenerated input type of connectorPlaidClose

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
connectorTokenString!The connector_token string from Connector Initialization
metadataJSON!The metadata object from Plaid Link’s onSuccess callback
publicTokenString!The public_token string from Plaid Link’s onSuccess callback
AnchorConnectorPlaidClosePayload

Autogenerated return type of connectorPlaidClose

FieldTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[PlaidAPIError!]Plaid API Error
recordConnectionTypeConnection
successBoolean!Status of the mutation