Skip to main content
POST
/
development
/
accounts
/
link
cURL
curl --request POST \
  --url https://development.knotapi.com/development/accounts/link \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_user_id": "abc123",
  "merchant_id": 19,
  "transactions": {
    "new": true,
    "updated": false
  }
}'
{
  "message": "Success"
}
Before using this endpoint, it is recommended to setup a webhook for the development environment in the Knot Dashboard if you have not done so already.

​
Overview

This endpoint is used to manually link a user’s merchant account in the development environment for testing purposes without the need to install or invoke the client-side SDK. Calling this endpoint will generate a linked merchant account on the Knot platform for a specific user & merchant and optionally generate new or updated transactions (using the transactions object in the request).

​
Usage

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Body

application/json

The input parameters required for linking a merchant account in development.

​
external_user_id
string
required

Your unique identifier for the user.

Example:

"abc123"

​
merchant_id
integer
required

Unique identifier for the merchant.

Example:

19

​
transactions
object

Configuration for whether to receive transactions when linking the account.

Response

Successful request.

​
message
string

Success message.

Example:

"Success"