KintsugiKintsugi
API reference / Get transaction by external id

Get transaction by external id

GET/v1/transactions/external/{external_id}

Retrieves a specific transaction based on its external ID. This allows users to fetch transaction details using an identifier from an external system.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

x-organization-idstringRequired

Identifies the organization this request acts on.

Path parameters

external_idstringRequired

The unique external identifier of the transaction.

Response

requires_exemptionExemptionRequired

Indicates if transaction requires tax exemption.

organization_idstringRequired

Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header.

external_idstringRequired

External identifier of the transaction.

datestringRequired

Transaction date and time

shop_datestring

Transaction date in the shop's local timezone

shop_date_tzstring

Timezone of the shop

descriptionstring

Description of the transaction.

refund_statusTransactionRefundStatus

Status of refund, if applicable

Available options:FULLY_REFUNDEDPARTIALLY_REFUNDED
total_amountstring

Total amount of the transaction.

customer_idstring

Unique identifier of the customer.

marketplaceboolean

Indicates if transaction is marketplace-based.

exemptTransactionExemptStatusEnum

Exemption status (e.g., NOT_EXEMPT)

Available options:NOT_EXEMPTPARTIALLY_EXEMPTFULLY_EXEMPTZERO_RATE_NOT_EXEMPT
exemptionsExemption[]

List of exemptions applied (if any).

related_tostring

Related transaction identifier.

secondary_external_idstring

Secondary External Identifier.

secondary_sourcestring

Secondary source information

external_friendly_idstring

Friendly identifier of the original item.

total_tax_amount_importedstring

Imported tax amount.

tax_rate_importedstring

Imported tax rate.

total_tax_amount_calculatedstring

Calculated tax amount.

tax_rate_calculatedstring

Calculated tax rate.

total_tax_liability_amountstring

Total tax liability amount.

tax_liability_sourceTaxLiabilitySourceEnum

Source of tax liability.

Available options:CALCULATEDCOLLECTED
taxable_amountstring

Taxable amount.

currencyCurrencyEnum

Currency code (ISO 4217, e.g., USD)

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
lockedboolean

Transaction lock status.

sourceSourceEnum

Source platform (e.g., STRIPE)

Available options:BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIRESHOPWAREZOHOSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERP
connection_idstring

Connection Identifier

filing_idstring

Filing identifier.

citystring

City of the transaction address.

countystring

County of the transaction address.

statestring

State of the transaction address.

countryCountryCodeEnum

Country code (ISO Alpha-2).

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU
postal_codestring

Postal code of the transaction.

tax_idstring

Tax ID associated with the transaction. DEPRECATED: This field is only populated for QuickBooks integrations and will be removed in a future version.

statusTransactionStatusEnum

Transaction status (e.g., COMMITTED)

Available options:PENDINGCOMMITTEDCANCELLEDFULLY_REFUNDEDPARTIALLY_REFUNDEDINVALIDARCHIVED
address_statusAddressStatus

Address verification status (e.g., VERIFIED).

Available options:UNVERIFIEDINVALIDPARTIALLY_VERIFIEDVERIFIEDUNVERIFIABLEBLANK
processing_statusProcessingStatusEnum

Status of processing (e.g., ADDRESS_DONE)

Available options:NEWUPDATEDQUEUEDADDRESS_DONEEXEMPT_DONENEXUS_DONEPROCESSEDFILING_STARTEDFILING_DONELOCKEDPENDINGARCHIVEDNEEDS_REFETCHEXCLUDED_IN_CALCULATION
destination_currencyCurrencyEnum

Destination currency code (ISO 4217, e.g., USD)

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
converted_total_amountstring

Converted total amount.

converted_total_tax_amount_importedstring

Converted imported tax amount.

converted_total_tax_amount_calculatedstring

Converted calculated tax amount.

conversion_ratestring

Currency conversion rate.

converted_taxable_amountstring

Converted taxable amount.

converted_total_discountstring

Converted total discount amount.

converted_subtotalstring

Converted subtotal amount.

converted_total_tax_liability_amountstring

Converted total tax liability amount.

idstringRequired

The unique transaction identifier.

addressesTransactionAddressRead-Output[]Required

List of addresses associated.

transaction_itemsTransactionItemRead[]Required

List of items in the transaction.

customerCustomerRead

Customer information associated with the transaction.

typeTransactionTypeEnumRequired

The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE).

Available options:SALEFULL_CREDIT_NOTEPARTIAL_CREDIT_NOTETAX_REFUNDARCHIVE
total_discountstring

Total amount of all discounts applied to the transaction.

subtotalstring

Subtotal amount before any discounts are applied.

final_total_amountstring

Final total amount including tax liability.

converted_final_total_amountstring

Converted final total amount including tax liability.

200

Successfully retrieved transaction by external id

401

Unauthenticated request.

404

Resource not found

422

Validation error

500

Internal server error

cURL
GET /v1/transactions/external/{external_id}
-H "x-api-key: ***"
-H "x-organization-id: ***"
Example request
https://api.trykintsugi.com/v1/transactions/external/{external_id}
Response
{
"organization_id": "orgn_dummyOrg123",
"external_id": "ext_trans_001",
"date": "2025-03-10T14:00:00",
"status": "COMMITTED",
"description": "Example Transaction Description",
"processing_status": "ADDRESS_DONE",
"total_amount": "200.00",
"customer_id": "cust_dummyCust001",
"marketplace": false,
"exempt": "NOT_EXEMPT",
"exemptions": [],
"total_tax_amount_imported": "0.00",
"tax_rate_imported": "0E-9",
"total_tax_amount_calculated": "15.00",
"tax_rate_calculated": "0.075",
"taxable_amount": "200.00",
"currency": "USD",
"locked": false,
"source": "SHOPIFY",
"connection_id": "conn_dummy123",
"destination_currency": "USD",
"converted_total_amount": "200.00",
"converted_total_tax_amount_imported": "0.00",
"converted_total_tax_amount_calculated": "15.00",
"conversion_rate": "1.00",
"city": "Dummy City",
"county": "Dummy County",
"state": "CA",
"country": "US",
"postal_code": "90001",
"address_status": "VERIFIED",
"id": "tran_dummyId001",
"addresses": [
{
"phone": "+15551234567",
"street_1": "123 Example St",
"street_2": "Apt 456",
"city": "Dummy City",
"county": "Dummy County",
"state": "CA",
"postal_code": "90001",
"country": "US",
"full_address": "123 Example St Apt 456, Dummy City, CA 90001, US",
"type": "BILL_TO",
"status": "VERIFIED",
"id": "addr_dummy001",
"transaction_id": "tran_dummyId001"
}
],
"transaction_items": [
{
"external_id": "item_ext_001",
"organization_id": "orgn_dummyOrg123",
"date": "2025-03-10T14:00:00",
"description": "Dummy Product Description",
"external_product_id": "prod_ext_001",
"product": "Dummy Product",
"product_id": "prod_dummyId001",
"product_name": "Dummy Product Name",
"product_description": "Detailed dummy product description",
"quantity": "2",
"amount": "100.00",
"tax_amount_imported": "0.00",
"tax_rate_imported": "0E-9",
"tax_amount_calculated": "7.50",
"tax_rate_calculated": "0.075",
"original_currency": "USD",
"destination_currency": "USD",
"converted_amount": "100.00",
"converted_taxable_amount": "100.00",
"converted_tax_amount_imported": "0.00",
"converted_tax_amount_calculated": "7.50",
"taxable_amount": "100.00",
"exempt": false,
"id": "txim_dummy001",
"tax_items": [],
"total_discount": "0.00",
"subtotal": "200.00"
}
],
"customer": {
"phone": "+15557654321",
"street_1": "789 Customer Rd",
"street_2": "",
"city": "Customer City",
"county": "Customer County",
"state": "CA",
"postal_code": "90002",
"country": "US",
"full_address": "789 Customer Rd, Customer City, CA 90002, US",
"name": "John Doe",
"external_id": "cust_ext_001",
"status": "ACTIVE",
"email": "johndoe@example.com",
"source": "SHOPIFY",
"connection_id": "conn_dummy123",
"address_status": "VERIFIED",
"id": "cust_dummyCust001",
"organization_id": "orgn_dummyOrg123"
},
"type": "SALE",
"total_discount": "0.00",
"subtotal": "200.00"
}