TransactionLink
Sync Transactions
TransactionLink
Merchants
TransactionLink
Sync Transactions
Sync a user’s transactions for a merchant account using cursor-based pagination.
POST
/
transactions
/
sync
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": "Homer's credit card",
"transaction_amount": "16.23"
}
],
"price": {
"sub_total": "12.56",
"adjustments": [
{
"type": "TAX",
"label": "NYC local sales tax",
"amount": "3.67"
}
],
"total": "16.23",
"currency": "USD"
},
"products": [
{
"external_id": "10315643",
"name": "Great Value Turkey Flavored Stuffing Mix",
"url": "https://www.example.com/ip/10315643",
"quantity": 1,
"price": {
"sub_total": "12.56",
"total": "12.56",
"unit_price": "12.56"
},
"eligibility": [
"FSA/HSA"
]
}
]
}
],
"next_cursor": "<string>",
"limit": 5
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
The input parameters required for syncing transactions.
The body is of type object
.
Response
200
application/json
Successful request.
The response is of type object
.
Was this page helpful?
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": "Homer's credit card",
"transaction_amount": "16.23"
}
],
"price": {
"sub_total": "12.56",
"adjustments": [
{
"type": "TAX",
"label": "NYC local sales tax",
"amount": "3.67"
}
],
"total": "16.23",
"currency": "USD"
},
"products": [
{
"external_id": "10315643",
"name": "Great Value Turkey Flavored Stuffing Mix",
"url": "https://www.example.com/ip/10315643",
"quantity": 1,
"price": {
"sub_total": "12.56",
"total": "12.56",
"unit_price": "12.56"
},
"eligibility": [
"FSA/HSA"
]
}
]
}
],
"next_cursor": "<string>",
"limit": 5
}