Quickstart
Getting started
Start the flow
Access your customer dashboad
Access your customer dashboad
Ensure you have access to your Customer Dashboard and retrieve your API keys: client_id and secret.
Subscribe to webhooks
Subscribe to webhooks
Subscribe to webhooks in your Customer Dashboard so your backend can be notified about user-generated events, as well as asynchronous processes. You will need to receive these events later on in the flow.
Retrieve available merchants
Retrieve available merchants
Call List Merchants to retrieve a list of merchants that are available for the TransactionLink product by passing type = transaction_link. These are merchants you can display in your app and allow users to link. To get started quickly, you can use merchant_id: 19 for DoorDash to later pass when initializing the SDK
You will be notified via the MERCHANT_STATUS_UPDATE webhook when/if this list changes.
Create a session
Create a session
With your client_id and secret for the development environment, call Create Session to create a session used when invoking the SDK.
Install the SDK
Install the SDK
Install an SDK of your choosing, for example on iOS here. If you are using the Web SDK, make sure to allowlist your application’s domains for the development and production environments in your Customer Dashboard.
Initialize the SDK
Initialize the SDK
Initialize the SDK with the session_id retrieved from Create Session and a merchant Id retrieved from List Merchants in KnotConfiguration or you can use merchant_id: 19 for DoorDash to get started quickly. The SDK is where users will interact with the Knot UI to authenticate to various merchants. All login flows, including step-up authentication, are handled within the SDK. Users will see real-time feedback as they progress through authenticating with a merchant.
Specifying an exact merchant by passing a merchant Id in KnotConfiguration when initializing the SDK is required for the TransactionLink product.
Link a merchant account
Login
Login
In the development environment, use testing credentials to login to a merchant account and simulate retrieving transactions.
Handle authenticated event
Handle authenticated event
Ingest the AUTHENTICATED webhook to notify your backend that the merchant account is successfully linked to Knot and that the connection status is connected. Similarly and as applicable, listen to the client-side onEvent callback in the SDK to receive the authenticated event.
You can also use Get Merchant Accounts to retrieve this and other merchant accounts, as well as their connection status. This can be useful to know that you should display the merchant account to the user in their list of linked merchant accounts with the appropriate connection status (i.e. connected or disconnected). See more about handling disconnected merchant accounts here.
Receive transactions
New transactions
To be notified about new transactions in a merchant account, listen to the NEW_TRANSACTIONS_AVAILABLE webhook. You will receive this event shortly after a user authenticates to a merchant account for the first time and on any subsequent instance where new transactions are created in the merchant account.
Upon receiving the NEW_TRANSACTIONS_AVAILABLE webhook, make a request (or multiple) to Sync Transactions to sync new transactions for a user’s specific merchant account. In the development environment, you will receive 205 new transactions.
Updated transactions
Receiving updated transaction information is entirely optional and may not be relevant for your use case.
To be notified about updates to existing transactions, listen to the UPDATED_TRANSACTIONS_AVAILABLE webhook. You will receive this event for a merchant account each time there are existing transactions for which data has changed (e.g. orderStatus: SHIPPED -> orderStatus: DELIVERED).
Upon receiving the UPDATED_TRANSACTIONS_AVAILABLE webhook with an array of transaction IDs, make a request to Get Transaction By Id for each transaction ID, passing the ID received in the webhook as a path parameter.
Handle disconnected merchant accounts
If for example a user changes their password to a merchant account, the connection.status in Get Merchant Accounts will be returned as disconnected and you will not receive transaction data for the user’s merchant account until it is reconnected. In this case, you’ll want to display a UX in your app to allow users to reconnect their account. For example, you may choose to display a button that says “Reconnect” or similar.
Unlink merchant accounts
To unlink a user’s specific merchant account if they request it, make a request to Unlink Merchant Account.