KintsugiKintsugi
API reference / Get transactions

Get transactions

GET/v1/transactions

The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/v1/transactions?state_code=<state_code>&country=<country>&status=<status>
state_codestring

Filter transactions by state code.

transaction_typestring

Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).

transaction_sourcestring

Filter transactions based on the source.

search_querystring

Search for transactions using a general query (e.g., order ID, customer name).

countryCountryCodeEnum | string[]

Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU
statestring

Filter by full state name (e.g., California).

address_status__instring

Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).

statusTransactionStatusEnum

Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, ARCHIVED). For refund filtering use the refund_status parameter.

Available options:PENDINGCOMMITTEDCANCELLEDFULLY_REFUNDEDPARTIALLY_REFUNDEDINVALIDARCHIVED
refund_statusTransactionRefundStatus

Filter by refund status (e.g., FULLY_REFUNDED, PARTIALLY_REFUNDED).

Available options:FULLY_REFUNDEDPARTIALLY_REFUNDED
filing_idstring

Retrieve transactions linked to a specific filing ID.

order_bystring

Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).

date__gtestring

Retrieve transactions with a date greater than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC). Defaults to 12 months ago when neither date__gte nor date__lte is provided.

date__ltestring

Retrieve transactions with a date less than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC).

processing_status__instring

Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.

marketplaceboolean

Filter transactions by marketplace (e.g., AMAZON, EBAY).

exempt__instring

Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).

connection_id__instring

Filter transactions by connection ID (comma-separated)

Available options:conn_abc123conn_def456
directionTransactionDirectionEnum

Filter by transaction direction (SALE or PURCHASE). When unset, the list includes both directions.

Available options:SALEPURCHASE
count_limitinteger

Optional upper bound for the pagination COUNT query. When set, the returned total is capped at this value and pages is derived from the capped total, making large result sets faster to paginate at the cost of approximate totals. When unset, total and pages reflect the exact count (existing behavior).

pageinteger

Page number

sizeinteger

Page size

Response

itemsTransactionRead[]Required
totalintegerRequired
pageintegerRequired
sizeintegerRequired
pagesintegerRequired
200

Successfully retrieved transactions

401

Unauthenticated request.

404

Resource not found

422

Validation error

500

Internal server error

cURL
GET /v1/transactions?state_code={state_code}&country={country}&status={status}
-H "x-api-key: ***"
Example request
https://api.trykintsugi.com/v1/transactions?state_code={state_code}&country={country}&status={status}
Response
{
"items": [
{
"organization_id": "orgn_123456789",
"external_id": "TXN-001",
"date": "2025-03-01T10:30:00",
"status": "COMMITTED",
"description": "Order #001 from Example Store",
"processing_status": "ADDRESS_DONE",
"total_amount": "250.00",
"customer_id": "cust_987654321",
"marketplace": false,
"exempt": "NOT_EXEMPT",
"exemptions": [],
"secondary_external_id": "Example Store",
"secondary_source": "SHOPIFY",
"total_tax_amount_imported": "15.00",
"tax_rate_imported": "0.06",
"total_tax_amount_calculated": "15.00",
"tax_rate_calculated": "0.06",
"taxable_amount": "250.00",
"currency": "USD",
"locked": false,
"source": "OTHER",
"connection_id": "conn_ABC123XYZ",
"filing_id": "file_1234567",
"destination_currency": "USD",
"converted_total_amount": 1000,
"converted_total_tax_amount_imported": 1200,
"converted_total_tax_amount_calculated": 1200,
"conversion_rate": 1,
"city": "Los Angeles",
"county": "Los Angeles County",
"state": "CA",
"country": "US",
"postal_code": "90001",
"address_status": "VERIFIED",
"id": "tran_001ABCDEF",
"type": "SALE",
"total_discount": "0.00",
"subtotal": "250.00",
"addresses": [
{
"phone": "1234567890",
"street_1": "123 Main St",
"street_2": "Apt 4B",
"city": "Los Angeles",
"county": "Los Angeles County",
"state": "CA",
"postal_code": "90001",
"country": "US",
"full_address": "123 Main St, Apt 4B, Los Angeles, CA, 90001, US",
"type": "BILL_TO",
"status": "VERIFIED",
"id": "addr_123XYZ",
"transaction_id": "tran_001ABCDEF"
},
{
"phone": "9876543210",
"street_1": "456 Elm St",
"street_2": "",
"city": "San Francisco",
"county": "San Francisco County",
"state": "CA",
"postal_code": "94102",
"country": "US",
"full_address": "456 Elm St, San Francisco, CA, 94102, US",
"type": "SHIP_TO",
"status": "VERIFIED",
"id": "addr_456XYZ",
"transaction_id": "tran_001ABCDEF"
}
],
"transaction_items": [
{
"external_id": "ITEM-001",
"organization_id": "orgn_123456789",
"date": "2025-03-01T10:30:00",
"description": "Blue T-Shirt",
"external_product_id": "P001",
"product": "Blue T-Shirt",
"product_id": "prod_ABC123",
"product_name": "Blue T-Shirt - Large",
"product_description": "A stylish blue t-shirt, size Large",
"quantity": "2",
"amount": "50.00",
"tax_amount_imported": "3.00",
"tax_rate_imported": "0.06",
"tax_amount_calculated": "3.00",
"tax_rate_calculated": "0.06",
"taxable_amount": "50.00",
"exempt": false,
"id": "txim_ABCDEF123",
"tax_items": [
{
"rule_id": "0000",
"rate": "0.00",
"amount": "0.00",
"converted_amount": "0.00",
"currency": "USD",
"destination_currency": "USD",
"external_id": "ext_1234",
"name": "product",
"type": "IMPORTED",
"jurisdiction_type": "COUNTRY",
"jurisdiction_name": "CA"
}
],
"total_discount": "0.00",
"subtotal": "100.00"
},
{
"external_id": "ITEM-002",
"organization_id": "orgn_123456789",
"date": "2025-03-01T10:30:00",
"description": "Wireless Headphones",
"external_product_id": "P002",
"product": "Wireless Headphones",
"product_id": "prod_DEF456",
"product_name": "Noise-Cancelling Wireless Headphones",
"product_description": "High-quality wireless headphones with noise cancellation",
"quantity": "1",
"amount": "150.00",
"tax_amount_imported": "9.00",
"tax_rate_imported": "0.06",
"tax_amount_calculated": "9.00",
"tax_rate_calculated": "0.06",
"taxable_amount": "150.00",
"exempt": false,
"id": "txim_DEF456",
"tax_items": [],
"total_discount": "0.00",
"subtotal": "150.00"
}
],
"customer": {
"phone": "1234567890",
"street_1": "123 Main St",
"street_2": "Apt 4B",
"city": "Los Angeles",
"county": "Los Angeles County",
"state": "CA",
"postal_code": "90001",
"country": "US",
"full_address": "123 Main St, Apt 4B, Los Angeles, CA, 90001, US",
"name": "John Doe",
"external_id": "CUST-001",
"status": "ACTIVE",
"email": "johndoe@example.com",
"source": "SHOPIFY",
"connection_id": "conn_ABC123XYZ",
"address_status": "VERIFIED",
"id": "cust_987654321",
"organization_id": "orgn_123456789"
}
}
],
"total": 1,
"page": 1,
"size": 1,
"pages": 1
}