This endpoint is used to retrieve a single transaction based on it's ID. Call this endpoint for each transaction ID received in the UPDATED_TRANSACTIONS_AVAILABLE
webhook to retrieve updated data for the transaction(s) you have already received.
Name Format Description id
number The ID of the merchant. name
string The name of the merchant.
Name Format Description id
string Knot's ID for the transaction. external_id
nullable, string The merchant's ID for the transaction. datetime
string The timestamp of the transaction in UTC. ISO 8601 format. url
nullable, string The URL of the transaction on the merchant's website. order_status
string The status of the order associated with the transaction.
Possible values: ORDERED
, BILLED
, SHIPPED
, DELIVERED
, REFUNDED
, CANCELLED
, FAILED
, COMPLETED
, PICKED_UP
, UNRECOGNIZED
payment_methods
object An array of payment methods used in the transaction. price
object The price details of the transaction. products
object An array of specific products purchased in the transaction.
Name Format Description external_id
nullable, string The merchant's ID for the payment method. type
string The 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
brand
nullable, string The merchant's brand for the payment method. last_four
nullable, string The last 4 digits of payment method, if a payment card. name
nullable, string The name of the payment method provided by the user. transaction_amount
nullable, string The amount of the transaction placed on the payment method ($).
Name Format Description sub_total
nullable, string The subtotal of the transaction ($). total
string The total of the transaction ($). currency
nullable, string The currency used in the transaction. ISO 4217 format. adjustments
nullable, object An array of adjustments associated with the transaction that resulted in a difference between the sub_total
and total
.
Name Format Description type
string The type of adjustment.
Possible values: DISCOUNT
, TAX
, TIP
, SHIPPING_FEE
, CANCELLATION_FEE
, REFUND
, UNRECOGNIZED
label
nullable, string The merchant's label for the adjustment. amount
string The amount of the adjustment ($).
Name Format Description external_id
nullable, string The merchant's ID for the product/SKU. Incredibly rare that this field is null
. name
string The name of the product. url
nullable, string The URL of the product on the merchant's website. quantity
nullable, number The number of units of the product purchased in the transaction. price
nullable, object The price of the product. eligibility
nullable, list The eligibility of the product.
Possible values: "FSA/HSA"
Name Format Description sub_total
nullable, string The subtotal price of the product in the transaction. total
nullable, string The total price of the product in the transaction. unit_price
nullable, string The price of the product per unit.
Field Enum error_type
INVALID_INPUT
, INVALID_REQUEST
, USER_ERROR
, LINKEDMERCHANT_ERROR
error_code
INVALID_API_KEYS
, INVALID_FIELD
, INVALID_CURSOR_FORMAT
, USER_NOT_FOUND
, LINKEDMERCHANT_NOT_FOUND