Skip to main content
POST
/
transactions
/
sync
cURL
curl --request POST \
  --url https://development.knotapi.com/transactions/sync \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": 46,
  "external_user_id": "abc",
  "cursor": "eyJpZCI6MjI3ODEsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
  "limit": 5
}
'
{
  "merchant": {
    "id": 4,
    "name": "Walmart"
  },
  "transactions": [
    {
      "id": "13da3c28-a068-4642-9ce2-b730cfda5f5f",
      "external_id": "a9x7bq2lmw5p",
      "datetime": "2024-11-10T00:00:00+00:00",
      "url": "https://www.example.com/orders/123123123",
      "order_status": "COMPLETED",
      "payment_methods": [
        {
          "external_id": "x7q9m2lbw5pazc",
          "type": "CARD",
          "brand": "VISA",
          "last_four": "5690",
          "name": "Ada's credit card",
          "transaction_amount": "23.20"
        },
        {
          "external_id": "x7q9m2lbw5pazc",
          "type": "GIFT_CARD",
          "brand": "VISA",
          "last_four": "1802",
          "name": "",
          "transaction_amount": "20.00"
        }
      ],
      "price": {
        "sub_total": "43.69",
        "adjustments": [
          {
            "type": "TAX",
            "label": "NYC local sales tax",
            "amount": "3.88"
          },
          {
            "type": "DISCOUNT",
            "label": "Summer promo",
            "amount": "-4.37"
          }
        ],
        "total": "43.20",
        "currency": "USD"
      },
      "products": [
        {
          "external_id": "10315643",
          "name": "Band-Aid Adhesive Bandages Variety Pack",
          "url": "https://www.example.com/ip/10315643",
          "quantity": 1,
          "price": {
            "sub_total": "12.56",
            "total": "12.56",
            "unit_price": "12.56"
          },
          "eligibility": [
            "FSA/HSA"
          ]
        },
        {
          "external_id": "1031891",
          "name": "Dixie Ultra 8-12 Paper Plate, 240-count",
          "url": "https://www.example.com/ip/1031891",
          "quantity": 1,
          "price": {
            "sub_total": "8.14",
            "total": "8.14",
            "unit_price": "8.14"
          },
          "eligibility": []
        },
        {
          "external_id": "1038973",
          "name": "4Pairs Men's Elite Sports Socks Athletic Crew Socks Mid-calf Boys for Football, Basketball, Running Soccer",
          "url": "https://www.example.com/ip/1038973",
          "quantity": 1,
          "price": {
            "sub_total": "22.99",
            "total": "22.99",
            "unit_price": "22.99"
          },
          "eligibility": []
        }
      ]
    }
  ],
  "next_cursor": "<string>",
  "limit": 5
}

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 syncing transactions.

​
merchant_id
integer
required

Unique identifier for the merchant.

Example:

46

​
external_user_id
string
required

Your unique identifier for the user.

Example:

"abc"

​
cursor
string

Cursor token pointing to the last transaction retrieved. The /transactions/sync endpoint uses cursor-based pagination to track which transactions have already been seen, minimizing data redundancy.

On the first call, the endpoint returns all transactions paginated. In subsequent calls, only new transactions are provided using the next cursor.

Example:

"eyJpZCI6MjI3ODEsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"

​
limit
integer
default:5

Maximum number of transactions to retrieve (min: 1, max: 100).

Example:

5

Response

Successful request.

​
merchant
object
​
transactions
object[]
​
next_cursor
string | null

Cursor token for the next page of transactions.

​
limit
integer

Number of transactions returned based on the limit provided.

Example:

5