API Reference

Sync Transactions

post https://development.knotapi.com/transactions/sync

Cursor-Based Pagination

Each response will return a next_cursor field, which holds a random ID value. If the next_cursor != null, then there are additional, paginated results and you can make another request to retrieve them by passing the next_cursor value into the cursor field of the request body.

Response Schema

merchant object

NameFormatDescription
idnumberThe ID of the merchant.
namestringThe name of the merchant.

transactions object

NameFormatDescription
idstringKnot's ID for the transaction.
external_idnullable, stringThe merchant's ID for the transaction.
datetimestringThe timestamp of the transaction in UTC. ISO 8601 format.
urlnullable, stringThe URL of the transaction on the merchant's website.
order_statusstringThe status of the order associated with the transaction.

Possible values: ORDERED, BILLED, SHIPPED, DELIVERED, REFUNDED, CANCELLED, FAILED, COMPLETED, PICKED_UP, UNRECOGNIZED
payment_methodsobjectAn array of payment methods used in the transaction.
priceobjectThe price details of the transaction.
productsobjectAn array of specific products purchased in the transaction.

payment_methods object

NameFormatDescription
external_idnullable, stringThe merchant's ID for the payment method.
typestringThe type of payment method.

Possible values: CARD, APPLE_PAY, GOOGLE_PAY, AMAZON_PAY, PAYPAL, CASH_APP, VENMO, AFFIRM, KLARNA, GIFT_CARD, CASH, LOYALTY_POINTS, UNRECOGNIZED
brandnullable, stringThe merchant's brand for the payment method.
last_fournullable, stringThe last 4 digits of payment method, if a payment card.
namenullable, stringThe name of the payment method provided by the user.
transaction_amountnullable, stringThe amount of the transaction placed on the payment method ($).

price object

NameFormatDescription
sub_totalnullable, stringThe subtotal of the transaction ($).
totalstringThe total of the transaction ($).
currencynullable, stringThe currency used in the transaction. ISO 4217 format.
adjustmentsnullable, objectAn array of adjustments associated with the transaction that resulted in a difference between the sub_total and total.

adjustments object

NameFormatDescription
typestringThe type of adjustment.

Possible values: DISCOUNT, TAX, TIP, SHIPPING_FEE, CANCELLATION_FEE, REFUND, UNRECOGNIZED
labelnullable, stringThe merchant's label for the adjustment.
amountstringThe amount of the adjustment ($).

products object

NameFormatDescription
external_idnullable, stringThe merchant's ID for the product/SKU. Incredibly rare that this field is null.
namestringThe name of the product.
urlnullable, stringThe URL of the product on the merchant's website.
quantitynullable, numberThe number of units of the product purchased in the transaction.
pricenullable, objectThe price of the product.
eligibilitynullable, listThe eligibility of the product.

Possible values: "FSA/HSA"

price object

NameFormatDescription
sub_totalnullable, stringThe subtotal price of the product in the transaction.
totalnullable, stringThe total price of the product in the transaction.
unit_pricenullable, stringThe price of the product per unit.

Errors

FieldEnum
error_typeINVALID_INPUT, INVALID_REQUEST, USER_ERROR, LINKEDMERCHANT_ERROR
error_codeINVALID_API_KEYS, INVALID_FIELD, INVALID_CURSOR_FORMAT, USER_NOT_FOUND, LINKEDMERCHANT_NOT_FOUND
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!