General
- Introduction
- Webhooks
- Launch Checklist
- Dashboard
SDK
- Introduction
- iOS
- Android
- React Native
- Flutter
- Web
- Migration Guides
Merchant Account Linking
CardSwitcher
- Quickstart
- Webhook Events
- Testing
- Sending Card Data
- Direct Processor Integrations
- MassSwitcher (Beta)
- Plaid Integration
TransactionLink
Quickstart
Start the flow
Ensure you have access to your Customer Dashboard and retrieve your API keys: client_id
and secret
.
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.
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.
You will be notified via the MERCHANT_STATUS_UPDATE
webhook when/if this list changes.
With your client_id
and secret
for the development
environment, call Create Session to create a session used when invoking 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 with the session_id
retrieved from Create Session and a merchant Id
retrieved from List Merchants in KnotConfiguration
. 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 with 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.
Login to a merchant account
In the development environment, use testing credentials to login to a merchant account and simulate retrieving transactions.
Ingest the AUTHENTICATED
webhook to notify your backend that the merchant account is successfully authenticated. Similarly and as applicable, listen to the client-side onEvent
callback in the SDK to receive the authenticated
event.
Receive new transactions
Handle the NEW_TRANSACTIONS_AVAILABLE
webhook to be notified of new transactions.
Upon receiving the NEW_TRANSACTIONS_AVAILABLE
webhook, make a request to Sync Transactions to sync new transactions for a user’s specific merchant account. In the development environment, you will receive 205 new transactions.
Receive updated transactions
Receiving updated transaction information is entirely optional and may not be relevant for your use case.
Handle the UPDATED_TRANSACTIONS_AVAILABLE
webhook to be notified of updates to existing transactions.
Upon receiving the UPDATED_TRANSACTIONS_AVAILABLE
webhook, make a request to Get Transaction By Id for each transaction ID, passing the ID received in the webhook as a path parameter.
Unlink merchant accounts
To unlink a user’s specific merchant account if they request it, make a request to Unlink Merchant Account.
Was this page helpful?