Skip to main content
GET
/
transactions
/
{id}
cURL
curl --request GET \
  --url https://development.knotapi.com/transactions/{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": "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": []
    }
  ]
}

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.

Path Parameters

​
id
string
required

UUID for a transaction provided in the UPDATED_TRANSACTIONS_AVAILABLE webhook.

Example:

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

Response

Successful request.

​
id
string

UUID 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<date-time>

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,
RETURNED,
REFUNDED,
CANCELLED,
FAILED,
COMPLETED,
PICKED_UP,
UNRECOGNIZED
Example:

"COMPLETED"

​
payment_methods
object[]

List of payment methods.

​
price
object
​
products
object[]