Get Transaction By ID

GET

transactions

get

{id}

curl --request GET \
  --url https://development.knotapi.com/transactions/get/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "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"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

Unique ID for a transaction provided in the UPDATED_TRANSACTIONS_AVAILABLE webhook.

Response

200

application/json

Successful request.

string

Unique identifier for the transaction.

Example:

"13da3c28-a068-4642-9ce2-b730cfda5f5f"

external_id

string | null

External identifier for the transaction provided by the merchant.

Example:

"a9x7bq2lmw5p"

datetime

string

Timestamp of the transaction in UTC. ISO 8601 format. Note that Knot does not guarantee a specific order in which transactions are returned.

Example:

"2024-11-10T00:00:00+00:00"

url

string | null

URL associated with the transaction.

Example:

"https://www.example.com/orders/123123123"

order_status

enum<string>

Status of the order associated with the transaction.

Available options:

ORDERED,

BILLED,

SHIPPED,

DELIVERED,

REFUNDED,

CANCELLED,

FAILED,

COMPLETED,

PICKED_UP,

UNRECOGNIZED

Example:

"COMPLETED"

payment_methods

object[]

List of payment methods.

price

object

products

object[]

products.external_id

string | null

External identifier for the product.

Example:

"10315643"

products.name

string

Name of the product.

Example:

"Great Value Turkey Flavored Stuffing Mix"

products.url

string | null

URL of the product.

Example:

"https://www.example.com/ip/10315643"

products.quantity

integer | null

Number of units of the product purchased in the transaction.

Example:

1

products.price

object

products.eligibility

string[]

The eligibility of the product.

Example:

["FSA/HSA"]

Was this page helpful?

Sync Transactions Unlink Merchant Account

curl --request GET \
  --url https://development.knotapi.com/transactions/get/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "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"
      ]
    }
  ]
}

Overview

Sessions

CardSwitcher

TransactionLink

Merchants

Users

Get Transaction By ID

Authorizations

Path Parameters

Response