PATCH
/
connections
/
current

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Body

application/json
status
enum<string>
Available options:
connected,
archived,
disconnected
company
object
externalId
string
syncMode
enum<string>
default: automatic

Enum values:

  • automatic: Terminal will keep this connections data up to date
  • manual: Terminal will only sync data upon request
Available options:
automatic,
manual
tags
string[]

Response

200 - application/json

The connection your application has with your customer's TSP.

id
string
required
company
object
required
status
enum<string>
required

Enum values:

  • connected: active and authenticated connection
  • disconnected: connection is no longer authenticated - please ask your user to link the account again
  • archived: connection has been archived from view - attempts to re-connect will cause us to check the connection status again
Available options:
connected,
disconnected,
archived,
pending_deletion
provider
object
required
syncMode
enum<string>
default: automaticrequired

Enum values:

  • automatic: Terminal will keep this connections data up to date
  • manual: Terminal will only sync data upon request
Available options:
automatic,
manual
token
string
required

This token is used when interacting with a connections' data.

createdAt
string
required
updatedAt
string
required
externalId
string

An optional ID from your system that can be used to reference connections.

sourceId
string

The ID used in the source system to represent the account this connection has access to.

This may be an organizationId or accountId.

Note: not all systems expose this information, in which case it may be undefined.

tags
string[]

An optional list of tags from your system that can be used to reference connections.

The URL to send your user to in order to have them re-authenticate the connection.