Public Token Exchange
Exchange the publicToken returned by our hosted authentication flow for a long lived connection token that will be used when requesting data from a customer’s TSP.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Token returned by the authentication flow. Public tokens are one time use and expire after they are exchanged for a long-lived connection token.
Response
The connection your application has with your customer's TSP.
Enum values:
connected: active and authenticated connectiondisconnected: connection is no longer authenticated - please ask your user to link the account againarchived: connection has been archived from view - attempts to re-connect will cause us to check the connection status again
connected, disconnected, archived, pending_deletion Enum values:
automatic: Terminal will keep this connections data up to datemanual: Terminal will only sync data upon request
automatic, manual This token is used when interacting with a connections' data.
An optional ID from your system that can be used to reference connections.
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.
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.