Loyalty membership information for the merchant account, not necessarily related to the specific transaction. When null, the merchant account does not have the loyalty membership.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Knot","colors":{"primary":"#0F0E0E","light":"#D8D8D8","dark":"#0F0E0E"},"logo":{"light":"https://mintcdn.com/knot/VBuG2prLV3p6xOTo/logo/light.svg?fit=max\u0026auto=format\u0026n=VBuG2prLV3p6xOTo\u0026q=85\u0026s=fd06fd47577a90c8e224072b4be0e5dd","dark":"https://mintcdn.com/knot/VBuG2prLV3p6xOTo/logo/dark.svg?fit=max\u0026auto=format\u0026n=VBuG2prLV3p6xOTo\u0026q=85\u0026s=3ec182904f4fcae0296bd34329d1ffa0","href":"https://www.knotapi.com"},"favicon":"https://mintcdn.com/knot/VBuG2prLV3p6xOTo/favicon.svg?fit=max\u0026auto=format\u0026n=VBuG2prLV3p6xOTo\u0026q=85\u0026s=47782d8aa08991b4c5e03be1fb07dcd0","api":{"openapi":"api-reference/openapi.json"},"navbar":{"links":[{"href":"https://knotapi.com/careers","label":"We're hiring"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.knotapi.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/knotapi","x":"https://x.com/KnotAPIs"},"links":[{"header":"Products","items":[{"label":"CardSwitcher™","href":"https://www.knotapi.com/cardswitcher"},{"label":"TransactionLink™","href":"https://www.knotapi.com/txn-link"},{"label":"AgenticShopping™","href":"https://www.knotapi.com/agentic-shopping"},{"label":"AccountUpdater™","href":"https://www.knotapi.com/accountupdater"}]},{"header":"Use Cases","items":[{"label":"Personal Banking","href":"https://www.knotapi.com/personal-banking"},{"label":"Business Banking","href":"https://www.knotapi.com/business-banking"},{"label":"Merchants","href":"https://www.knotapi.com/merchants"},{"label":"BaaS","href":"https://www.knotapi.com/baas"}]},{"header":"Company","items":[{"label":"About Us","href":"https://www.knotapi.com/about-us"},{"label":"Trust Center","href":"https://trust.knotapi.com/"},{"label":"Contact","href":"https://www.knotapi.com/contact"},{"label":"Careers","href":"https://knotapi.com/careers"}]},{"header":"Legal","items":[{"label":"Terms \u0026 Conditions","href":"https://www.knotapi.com/terms"},{"label":"Privacy Policy","href":"https://www.knotapi.com/privacy"}]}]},"search":{"prompt":"Search or ask AI..."},"seo":{"organization":{"name":"Knot","url":"https://www.knotapi.com","sameAs":["https://www.linkedin.com/company/knotapi","https://x.com/KnotAPIs"]}},"fonts":{"heading":{"family":"Geist","weight":500},"body":{"family":"Geist","weight":400}},"styling":{"codeblocks":"system","latex":false},"integrations":{"segment":{"key":"2VQVWDiEQctuTfDIREdqA3l0KGlREyN5"}},"banner":{"content":"Build with AI in your IDE: install the [Knot skills](/ai/skills) and [MCP server](/ai/mcp-server).","dismissible":true},"errors":{"404":{"redirect":false,"title":"Hello there...","description":"This page doesn’t exist, but your next opportunity might 👀. Check out [open roles at Knot](https://knotapi.com/careers). Looking for documentation? Start at the [introduction](/), browse the [documentation index (llms.txt)](/llms.txt) or [sitemap](/sitemap.xml), or [contact Knot](https://www.knotapi.com/contact/)."}},"contextual":{"options":["assistant","copy","add-mcp","chatgpt","claude","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"knot","hasAudioNarration":true,"actualSubdomain":"knot","customDomains":["docs.knotapi.com"],"gitSource":{"type":"github","owner":"millionscard","repo":"knot-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada2060f7b413b0bdc36c87","collectionId":"135a213d-7d45-4579-be18-027fbafb0e08","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada2060f7b413b0bdc36c87"},"feedback":{"edits":false,"thumbs":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbb6653f7cf1d32f8da8b7","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Docs","count":74},{"language":"default","tag":"API Reference","count":47},{"language":"default","tag":"Webhook Events","count":28},{"language":"default","tag":"CardSwitcher","count":17},{"language":"default","tag":"TransactionLink","count":16},{"language":"default","tag":"Merchant Account Linking","count":13},{"language":"default","tag":"SubscriptionManager","count":12},{"language":"default","tag":"SDK","count":11},{"language":"default","tag":"Shopping","count":9},{"language":"default","tag":"General","count":8}],"searchSettings":{"showContentSnippets":true,"isFiltersEnabled":false}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"deflection":{"enabled":true,"email":"product@knotapi.com"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6900107fa0d9fd2c40a2a17e","deploymentId":"67259f59f39b3bc1a898c425","questionText":"How do I get a list of available merchants?","status":"active","generatedBy":"manual","createdAt":"2025-10-28T00:38:23.158Z","updatedAt":"2025-10-28T00:38:23.158Z","__v":0},{"_id":"69001016a0d9fd2c40a27dce","deploymentId":"67259f59f39b3bc1a898c425","questionText":"How do I send card data to Knot?","status":"active","generatedBy":"manual","createdAt":"2025-10-28T00:36:38.949Z","updatedAt":"2025-10-28T00:36:38.949Z","__v":0},{"_id":"69000fe3a0d9fd2c40a26975","deploymentId":"67259f59f39b3bc1a898c425","questionText":"How do I create a session?","status":"active","generatedBy":"manual","createdAt":"2025-10-28T00:35:47.577Z","updatedAt":"2025-10-28T00:35:47.577Z","__v":0}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"html[data-current-path=\"/api-reference/work-at-knot/apply\"] #sidebar{display:none}html[data-current-path=\"/api-reference/work-at-knot/apply\"] #content-area{margin-left:0;padding-left:0;max-width:100%}"}],"page":{"pagePath":"api-reference/products/transaction-link/transaction-object","slug":"/api-reference/products/transaction-link/transaction-object","pageMetadata":{"title":"The Transaction Object","openapi-schema":"Transaction","description":null,"href":"/api-reference/products/transaction-link/transaction-object"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"The Transaction Object","openapi-schema":"Transaction","description":null,"href":"/api-reference/products/transaction-link/transaction-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"id":{"type":"string","description":"UUID for the transaction. It is best practice to deduplicate on this value.","example":"13da3c28-a068-4642-9ce2-b730cfda5f5f","uniqueKey":"id","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","description":"External identifier for the transaction provided by the merchant.","example":"a9x7bq2lmw5p","uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the transaction provided by the merchant.","example":"a9x7bq2lmw5p","uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"},"datetime":{"type":"string","format":"date-time","description":"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","uniqueKey":"datetime","typeLabel":"string\u003cdate-time>"},"url":{"oneOf":[{"type":"string","description":"URL associated with the transaction.","example":"https://www.example.com/orders/123123123","uniqueKey":"url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL associated with the transaction.","example":"https://www.example.com/orders/123123123","uniqueKey":"url.oneOf.1","typeLabel":"null"}],"uniqueKey":"url","typeLabel":"string | null"},"order_status":{"type":"string","enum":["ORDERED","BILLED","SHIPPED","DELIVERED","RETURNED","REFUNDED","CANCELLED","FAILED","COMPLETED","PICKED_UP","UNRECOGNIZED"],"description":"Status of the order associated with the transaction.","example":"COMPLETED","uniqueKey":"order_status","typeLabel":"enum\u003cstring>"},"shipping":{"oneOf":[{"type":"object","description":"Shipping information for the transaction, including the recipient's name and delivery address. `null` when no shipping data is available.","properties":{"location":{"oneOf":[{"type":"object","description":"Location information including recipient name and address.","properties":{"address":{"oneOf":[{"type":"object","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"First line of the address.","example":"123 Main St","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of the address.","example":"Floor 4","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City portion of the address.","example":"Los Angeles","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.region.oneOf.0","typeLabel":"string"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.region","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code of the address.","example":"94105","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US","uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0.country","typeLabel":"string"}},"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}},"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.address","typeLabel":"object | null"},"first_name":{"oneOf":[{"type":"string","description":"First name of the recipient.","maxLength":255,"example":"Ada","uniqueKey":"shipping.oneOf.0.location.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the recipient.","maxLength":255,"example":"Ada","uniqueKey":"shipping.oneOf.0.location.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace","uniqueKey":"shipping.oneOf.0.location.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace","uniqueKey":"shipping.oneOf.0.location.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location.oneOf.0.last_name","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0.location.oneOf.0","typeLabel":"object"},{"type":"null","description":"Location information including recipient name and address.","properties":{"address":{"oneOf":[{"type":"object","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}},{"type":"null","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}}]},"first_name":{"oneOf":[{"type":"string","description":"First name of the recipient.","maxLength":255,"example":"Ada"},{"type":"null","description":"First name of the recipient.","maxLength":255,"example":"Ada"}]},"last_name":{"oneOf":[{"type":"string","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"},{"type":"null","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"}]}},"uniqueKey":"shipping.oneOf.0.location.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.location","typeLabel":"object | null"}},"uniqueKey":"shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"Shipping information for the transaction, including the recipient's name and delivery address. `null` when no shipping data is available.","properties":{"location":{"oneOf":[{"type":"object","description":"Location information including recipient name and address.","properties":{"address":{"oneOf":[{"type":"object","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}},{"type":"null","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}}]},"first_name":{"oneOf":[{"type":"string","description":"First name of the recipient.","maxLength":255,"example":"Ada"},{"type":"null","description":"First name of the recipient.","maxLength":255,"example":"Ada"}]},"last_name":{"oneOf":[{"type":"string","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"},{"type":"null","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"}]}}},{"type":"null","description":"Location information including recipient name and address.","properties":{"address":{"oneOf":[{"type":"object","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}},{"type":"null","description":"Address information.","properties":{"line1":{"oneOf":[{"type":"string","description":"First line of the address.","example":"123 Main St"},{"type":"null","description":"First line of the address.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Second line of the address.","example":"Floor 4"},{"type":"null","description":"Second line of the address.","example":"Floor 4"}]},"city":{"oneOf":[{"type":"string","description":"City portion of the address.","example":"Los Angeles"},{"type":"null","description":"City portion of the address.","example":"Los Angeles"}]},"region":{"oneOf":[{"type":"string","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"},{"type":"null","description":"Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"Postal code of the address.","example":"94105"},{"type":"null","description":"Postal code of the address.","example":"94105"}]},"country":{"type":"string","description":"Country portion of the address. Must be an ISO 3166-1 alpha-2 code.","example":"US"}}}]},"first_name":{"oneOf":[{"type":"string","description":"First name of the recipient.","maxLength":255,"example":"Ada"},{"type":"null","description":"First name of the recipient.","maxLength":255,"example":"Ada"}]},"last_name":{"oneOf":[{"type":"string","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"},{"type":"null","description":"Last name of the recipient.","maxLength":255,"example":"Lovelace"}]}}}]}},"uniqueKey":"shipping.oneOf.1","typeLabel":"null"},{"type":"null","description":"Shipping information for the transaction, including the recipient's name and delivery address. `null` when no shipping data is available.","uniqueKey":"shipping.oneOf.2","typeLabel":"null"}],"uniqueKey":"shipping","typeLabel":"object · null · null"},"payment_methods":{"type":"array","items":{"type":"object","properties":{"external_id":{"oneOf":[{"type":"string","description":"External identifier for the payment method provided by the merchant.","example":"x7q9m2lbw5pazc","uniqueKey":"payment_methods.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the payment method provided by the merchant.","example":"x7q9m2lbw5pazc","uniqueKey":"payment_methods.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.items.[INDEX].external_id","typeLabel":"string | null"},"type":{"type":"string","enum":["CARD","APPLE_PAY","GOOGLE_PAY","AMAZON_PAY","PAYPAL","CASH_APP","VENMO","AFFIRM","KLARNA","ONEPAY","GIFT_CARD","CASH","BANK_ACCOUNT","LOYALTY_POINTS","CRYPTO","UNRECOGNIZED"],"description":"Type of the payment method.","example":"CARD","uniqueKey":"payment_methods.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"brand":{"oneOf":[{"type":"string","description":"Brand of the payment method. Includes `EBTSNAP`.","example":"VISA","uniqueKey":"payment_methods.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand of the payment method. Includes `EBTSNAP`.","example":"VISA","uniqueKey":"payment_methods.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.items.[INDEX].brand","typeLabel":"string | null"},"last_four":{"oneOf":[{"type":"string","description":"Last 4 digits of the payment method, if a payment card.","example":"5690","uniqueKey":"payment_methods.items.[INDEX].last_four.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last 4 digits of the payment method, if a payment card.","example":"5690","uniqueKey":"payment_methods.items.[INDEX].last_four.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.items.[INDEX].last_four","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Name of the payment method provided by the user.","example":"Homer's credit card","uniqueKey":"payment_methods.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the payment method provided by the user.","example":"Homer's credit card","uniqueKey":"payment_methods.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.items.[INDEX].name","typeLabel":"string | null"},"transaction_amount":{"oneOf":[{"type":"string","description":"Transaction amount associated with the payment method.","example":"16.23","uniqueKey":"payment_methods.items.[INDEX].transaction_amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction amount associated with the payment method.","example":"16.23","uniqueKey":"payment_methods.items.[INDEX].transaction_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.items.[INDEX].transaction_amount","typeLabel":"string | null"}},"uniqueKey":"payment_methods.items.[INDEX]","typeLabel":"object"},"description":"List of payment methods.","uniqueKey":"payment_methods","typeLabel":"object[]"},"price":{"type":"object","properties":{"sub_total":{"oneOf":[{"type":"string","description":"Subtotal price of the transaction.","example":"12.56","uniqueKey":"price.sub_total.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subtotal price of the transaction.","example":"12.56","uniqueKey":"price.sub_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.sub_total","typeLabel":"string | null"},"adjustments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["DISCOUNT","TAX","TIP","FEE","REFUND","UNRECOGNIZED"],"description":"Type of adjustment.","example":"TAX","uniqueKey":"price.adjustments.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"label":{"oneOf":[{"type":"string","description":"Label of the adjustment from the merchant.","example":"NYC local sales tax","uniqueKey":"price.adjustments.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label of the adjustment from the merchant.","example":"NYC local sales tax","uniqueKey":"price.adjustments.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.adjustments.items.[INDEX].label","typeLabel":"string | null"},"amount":{"type":"string","description":"Amount of the adjustment.","example":"3.67","uniqueKey":"price.adjustments.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"price.adjustments.items.[INDEX]","typeLabel":"object"},"description":"List of price adjustments.","uniqueKey":"price.adjustments","typeLabel":"object[]"},"total":{"type":"string","description":"Total price of the transaction.","example":"16.23","uniqueKey":"price.total","typeLabel":"string"},"currency":{"oneOf":[{"type":"string","description":"Currency of the price. ISO 4217 format.","example":"USD","uniqueKey":"price.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency of the price. ISO 4217 format.","example":"USD","uniqueKey":"price.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.currency","typeLabel":"string | null"}},"uniqueKey":"price","typeLabel":"object"},"products":{"type":"array","items":{"type":"object","properties":{"external_id":{"oneOf":[{"type":"string","description":"External identifier for the product.","example":"10315643","uniqueKey":"products.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the product.","example":"10315643","uniqueKey":"products.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].external_id","typeLabel":"string | null"},"gtin":{"oneOf":[{"type":"string","description":"Global Trade Item Number (GTIN-14) for the product. Always stored as a 14-digit zero-padded string, normalized from UPC, EAN, GTIN-12, or GTIN-13 formats.","x-mint":{"post":["coming soon"]},"example":"00012345678901","uniqueKey":"products.items.[INDEX].gtin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Global Trade Item Number (GTIN-14) for the product. Always stored as a 14-digit zero-padded string, normalized from UPC, EAN, GTIN-12, or GTIN-13 formats.","x-mint":{"post":["coming soon"]},"example":"00012345678901","uniqueKey":"products.items.[INDEX].gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].gtin","typeLabel":"string | null"},"name":{"type":"string","description":"Name of the product.","example":"Great Value Turkey Flavored Stuffing Mix","uniqueKey":"products.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Description of the product.","example":"Savory and comforting stuffing mix seasoned with classic turkey flavor and a blend of aromatic herbs and spices. Made with soft, seasoned bread cubes that bake up moist on the inside with a lightly crisp top.","uniqueKey":"products.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the product.","example":"Savory and comforting stuffing mix seasoned with classic turkey flavor and a blend of aromatic herbs and spices. Made with soft, seasoned bread cubes that bake up moist on the inside with a lightly crisp top.","uniqueKey":"products.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].description","typeLabel":"string | null"},"category":{"type":"string","enum":["CATEGORY1","CATEGORY2","CATEGORY3","UNRECOGNIZED"],"description":"The category of the product.","example":"CATEGORY1","x-mint":{"post":["coming soon"]},"uniqueKey":"products.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","description":"URL of the product.","example":"https://www.example.com/ip/10315643","uniqueKey":"products.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the product.","example":"https://www.example.com/ip/10315643","uniqueKey":"products.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].url","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","description":"URL of the product image.","example":"https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg","uniqueKey":"products.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the product image.","example":"https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg","uniqueKey":"products.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].image_url","typeLabel":"string | null"},"quantity":{"oneOf":[{"type":"number","description":"Number of units of the product purchased in the transaction.","format":"double","example":1,"uniqueKey":"products.items.[INDEX].quantity.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Number of units of the product purchased in the transaction.","format":"double","example":1,"uniqueKey":"products.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].quantity","typeLabel":"number\u003cdouble> | null"},"price":{"oneOf":[{"type":"object","properties":{"sub_total":{"oneOf":[{"type":"string","description":"Subtotal price of the product in the transaction.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.sub_total.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subtotal price of the product in the transaction.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.sub_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].price.oneOf.0.sub_total","typeLabel":"string | null"},"total":{"oneOf":[{"type":"string","description":"Total price of the product in the transaction.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.total.oneOf.0","typeLabel":"string"},{"type":"null","description":"Total price of the product in the transaction.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.total.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].price.oneOf.0.total","typeLabel":"string | null"},"unit_price":{"oneOf":[{"type":"string","description":"Price of the product per unit.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.unit_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Price of the product per unit.","example":"12.56","uniqueKey":"products.items.[INDEX].price.oneOf.0.unit_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].price.oneOf.0.unit_price","typeLabel":"string | null"}},"uniqueKey":"products.items.[INDEX].price.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"products.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].price","typeLabel":"object | null"},"seller":{"oneOf":[{"type":"object","description":"Seller information for the specific product, often different than the merchant if a marketplace. Nullable, but never an empty object/dictionary (`{}`).","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the seller offering the product.","example":"KingCamp Outdoor Products Co., Ltd.","uniqueKey":"products.items.[INDEX].seller.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the seller offering the product.","example":"KingCamp Outdoor Products Co., Ltd.","uniqueKey":"products.items.[INDEX].seller.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].seller.oneOf.0.name","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"URL of the seller's page within the merchant's marketplace.","example":"https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie","uniqueKey":"products.items.[INDEX].seller.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the seller's page within the merchant's marketplace.","example":"https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie","uniqueKey":"products.items.[INDEX].seller.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].seller.oneOf.0.url","typeLabel":"string | null"}},"uniqueKey":"products.items.[INDEX].seller.oneOf.0","typeLabel":"object"},{"type":"null","description":"Seller information for the specific product, often different than the merchant if a marketplace. Nullable, but never an empty object/dictionary (`{}`).","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the seller offering the product.","example":"KingCamp Outdoor Products Co., Ltd."},{"type":"null","description":"Name of the seller offering the product.","example":"KingCamp Outdoor Products Co., Ltd."}]},"url":{"oneOf":[{"type":"string","description":"URL of the seller's page within the merchant's marketplace.","example":"https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie"},{"type":"null","description":"URL of the seller's page within the merchant's marketplace.","example":"https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie"}]}},"uniqueKey":"products.items.[INDEX].seller.oneOf.1","typeLabel":"null"},{"type":"null","description":"Seller information for the specific product, often different than the merchant if a marketplace. Nullable, but never an empty object/dictionary (`{}`).","uniqueKey":"products.items.[INDEX].seller.oneOf.2","typeLabel":"null"}],"uniqueKey":"products.items.[INDEX].seller","typeLabel":"object · null · null"},"eligibility":{"type":"array","items":{"type":"string","enum":["FSA/HSA"],"uniqueKey":"products.items.[INDEX].eligibility.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The eligibility of the product. `EBT`, `EBTSNAP`, `EBTCASH`, and `WIC` values are coming soon.","example":["FSA/HSA"],"uniqueKey":"products.items.[INDEX].eligibility","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"loyalty_membership":{"oneOf":[{"type":"object","description":"Loyalty membership information for the merchant account, not necessarily related to the specific transaction. When `null`, the merchant account does not have the loyalty membership.","properties":{"tier":{"oneOf":[{"type":"string","description":"Tier of the loyalty membership.","example":"Walmart+ Assist","uniqueKey":"loyalty_membership.oneOf.0.tier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier of the loyalty membership.","example":"Walmart+ Assist","uniqueKey":"loyalty_membership.oneOf.0.tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"loyalty_membership.oneOf.0.tier","typeLabel":"string | null"}},"uniqueKey":"loyalty_membership.oneOf.0","typeLabel":"object"},{"type":"null","description":"Loyalty membership information for the merchant account, not necessarily related to the specific transaction. When `null`, the merchant account does not have the loyalty membership.","properties":{"tier":{"oneOf":[{"type":"string","description":"Tier of the loyalty membership.","example":"Walmart+ Assist"},{"type":"null","description":"Tier of the loyalty membership.","example":"Walmart+ Assist"}]}},"uniqueKey":"loyalty_membership.oneOf.1","typeLabel":"null"},{"type":"null","description":"Loyalty membership information for the merchant account, not necessarily related to the specific transaction. When `null`, the merchant account does not have the loyalty membership.","uniqueKey":"loyalty_membership.oneOf.2","typeLabel":"null"}],"uniqueKey":"loyalty_membership","typeLabel":"object · null · null"}},"example":{"title":"Example","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","shipping":{"location":{"address":{"line1":"123 Main St","line2":"Floor 4","city":"Los Angeles","region":"CA","postal_code":"94105","country":"US"},"first_name":"Ada","last_name":"Lovelace"}},"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","gtin":"00381370044536","name":"Band-Aid Adhesive Bandages Variety Pack","description":"A convenient assortment of durable adhesive bandages designed to protect minor cuts and scrapes. Featuring a range of sizes for everyday first-aid needs, each bandage cushions the wound while helping keep out dirt and germs. Made to stay securely in place with a gentle adhesive, this variety pack is ideal for home, travel, school, or on-the-go care.","category":"CATEGORY1","url":"https://www.example.com/ip/10315643","image_url":"https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg","quantity":1,"price":{"sub_total":"12.56","total":"12.56","unit_price":"12.56"},"seller":null,"eligibility":["FSA/HSA"]},{"external_id":"1031891","gtin":"00078731878120","name":"Dixie Ultra 8-12 Paper Plate, 240-count","description":"","category":"CATEGORY2","url":"https://www.example.com/ip/1031891","image_url":"https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg","quantity":1,"price":{"sub_total":"8.14","total":"8.14","unit_price":"8.14"},"seller":null,"eligibility":[]},{"external_id":"1038973","gtin":"00651277430015","name":"4Pairs Men's Elite Sports Socks Athletic Crew Socks Mid-calf Boys for Football, Basketball, Running Soccer","description":"High-performance athletic crew socks designed for comfort, support, and durability during intense activity. Made with breathable, moisture-wicking fabric to help keep feet dry, with reinforced heels and toes for added strength.","category":"CATEGORY3","url":"https://www.example.com/ip/1038973","image_url":"https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg","quantity":1,"price":{"sub_total":"22.99","total":"22.99","unit_price":"22.99"},"seller":{"name":"KingCamp Outdoor Products Co., Ltd.","url":"https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie"},"eligibility":[]}],"loyalty_membership":{"tier":"Walmart+ Assist"}}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"knot","siteName":"Knot","title":"The Transaction Object - Knot","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T19:33:04.927Z","originalFileLocation":"api-reference/products/transaction-link/transaction-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Knot\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The Transaction Object - Knot\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Knot\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://knot.mintlify.app/_mintlify/api/og/v2?division=TransactionLink\u0026amp;title=The+Transaction+Object\u0026amp;theme=c2017d1867bb9f3af1e4a591\u0026amp;signature=deeeb0c50b80ba3f8725f821549cda44c8f751464fa4ec7cff8a99bc37a1839c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"The Transaction Object - Knot\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://knot.mintlify.app/_mintlify/api/og/v2?division=TransactionLink\u0026amp;title=The+Transaction+Object\u0026amp;theme=c2017d1867bb9f3af1e4a591\u0026amp;signature=deeeb0c50b80ba3f8725f821549cda44c8f751464fa4ec7cff8a99bc37a1839c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/knot/X2cfOEMCNQ4RTMjp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Knot\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F0E0E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/products/transaction-link/transaction-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.knotapi.com/#organization\",\"name\":\"Knot\",\"url\":\"https://www.knotapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/knot/VBuG2prLV3p6xOTo/logo/light.svg?fit=max\u0026auto=format\u0026n=VBuG2prLV3p6xOTo\u0026q=85\u0026s=fd06fd47577a90c8e224072b4be0e5dd\"},\"sameAs\":[\"https://www.linkedin.com/company/knotapi\",\"https://x.com/KnotAPIs\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.knotapi.com#website\",\"name\":\"Knot\",\"url\":\"https://docs.knotapi.com\",\"publisher\":{\"@id\":\"https://www.knotapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object#webpage\",\"url\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object\",\"name\":\"The Transaction Object\",\"dateModified\":\"2026-10-23T19:33:04.927Z\",\"isPartOf\":{\"@id\":\"https://docs.knotapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knot\",\"item\":\"https://docs.knotapi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The Transaction Object\",\"item\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object#apireference\",\"headline\":\"The Transaction Object\",\"name\":\"The Transaction Object\",\"url\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object\",\"mainEntityOfPage\":{\"@id\":\"https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object#webpage\"},\"dateModified\":\"2026-10-23T19:33:04.927Z\",\"publisher\":{\"@id\":\"https://www.knotapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.knotapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Knot\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Knot","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Authenticate Knot API requests with HTTP basic auth","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"mTLS","href":"/api-reference/mTLS"}]},{"group":"Development","pages":[{"title":"Link Account","openapi":"POST /development/accounts/link","href":"/api-reference/development/link-account"}]},{"group":"Sessions","pages":[{"title":"Create Session","openapi":"POST /session/create","href":"/api-reference/sessions/create-session"},{"title":"Extend Session","openapi":"POST /session/extend","href":"/api-reference/sessions/extend-session"}]},{"group":"CardSwitcher","pages":[{"title":"Retrieve JWK","openapi":"GET /jwe/key","href":"/api-reference/products/card-switcher/retrieve-jwk"},{"title":"Switch Card JWE","openapi":"api-reference/openapi.json POST /card","href":"/api-reference/products/card-switcher/switch-card-jwe"},{"title":"Switch Card","openapi":"api-reference/openapi_secure.json POST /card","href":"/api-reference/products/card-switcher/switch-card"},{"title":"Create Knot Zero Link","openapi":"POST /zero-link/create","href":"/api-reference/products/card-switcher/create-knot-zero-link"},{"title":"Create Knot Zero Links (Batch)","openapi":"POST /zero-link/batch/create","href":"/api-reference/products/card-switcher/create-knot-zero-links-batch"},{"title":"Revoke Knot Zero Links","openapi":"POST /zero-link/revoke","description":"Revoke a user's Knot Zero links.","href":"/api-reference/products/card-switcher/revoke-knot-zero-links"}]},{"group":"TransactionLink","pages":[{"title":"The Transaction Object","href":"/api-reference/products/transaction-link/transaction-object"},{"title":"Sync Transactions","openapi":"POST /transactions/sync","description":"Sync a user's transactions for a merchant account using cursor-based pagination.","href":"/api-reference/products/transaction-link/sync"},{"title":"Get Transaction By ID","openapi":"GET /transactions/{id}","href":"/api-reference/products/transaction-link/get-by-id"},{"title":"Refresh Transactions","openapi":"POST /transactions/refresh","href":"/api-reference/products/transaction-link/refresh"}]},{"group":"SubscriptionManager","pages":[{"title":"The Subscription Object","href":"/api-reference/products/subscriptions/subscription-object"},{"title":"Get Subscription By ID","openapi":"GET /subscriptions/{id}","href":"/api-reference/products/subscriptions/get-by-id"},{"title":"List Subscriptions","openapi":"POST /subscriptions/list","href":"/api-reference/products/subscriptions/list"},{"title":"Refresh Subscriptions","openapi":"POST /subscriptions/refresh","href":"/api-reference/products/subscriptions/refresh"},{"title":"Cancel Subscription By ID","openapi":"POST /subscriptions/{id}/cancel","href":"/api-reference/products/subscriptions/cancel"},{"title":"Cancel Subscription By Account","openapi":"POST /subscriptions/cancel","href":"/api-reference/products/subscriptions/cancel-by-account"}]},{"group":"Shopping","pages":[{"title":"Sync Cart","openapi":"POST /cart","href":"/api-reference/products/shopping/sync-cart"},{"title":"Checkout","openapi":"POST /cart/checkout","href":"/api-reference/products/shopping/checkout"}]},{"group":"Merchants","pages":[{"title":"List Merchants","openapi":"POST /merchant/list","href":"/api-reference/merchants/list-merchants"}]},{"group":"Merchant Accounts","pages":[{"title":"Get Merchant Accounts","openapi":"GET /accounts/get","href":"/api-reference/accounts/get-accounts"},{"title":"Unlink Merchant Account","openapi":"POST /accounts/unlink","href":"/api-reference/accounts/unlink-account"}]},{"group":"Detected Accounts","pages":[{"title":"Detect Accounts","openapi":"POST /detect","href":"/api-reference/products/detect/detect-accounts"},{"title":"List Detected Accounts","openapi":"POST /detected-accounts/list","href":"/api-reference/products/detect/list-detected-accounts"},{"title":"Search Detected Accounts","openapi":"POST /detected-accounts/search","href":"/api-reference/products/detect/search-detected-accounts"},{"title":"Sync Detected Accounts","openapi":"POST /detected-accounts/sync","href":"/api-reference/products/detect/sync-detected-accounts"}]},{"group":"Users","pages":[{"title":"Delete User \u0026 Data","openapi":"POST /user/delete","href":"/api-reference/users/delete-user-and-data"}]},{"group":"Audit Logs","pages":[{"title":"Get Audit Logs","openapi":"GET /audit_logs","href":"/api-reference/audit-logs/get-audit-logs"}]},{"group":"Agent Authorization","pages":[{"title":"Agent authorization","sidebarTitle":"Overview","href":"/api-reference/agent-authorization/overview"},{"title":"Request Device Code","openapi":"POST /oauth/device/code","href":"/api-reference/agent-authorization/request-device-code"},{"title":"Request Access Token","openapi":"POST /oauth/token","href":"/api-reference/agent-authorization/request-access-token"}]},{"group":"Webhook Endpoints","pages":[{"title":"Webhook Endpoint Object","href":"/api-reference/webhook-endpoints/webhook-endpoint-object"},{"title":"Create Webhook Endpoint","openapi":"POST /webhook-endpoints/create","href":"/api-reference/webhook-endpoints/create"},{"title":"Get Webhook Endpoint By ID","openapi":"GET /webhook-endpoints/{id}","href":"/api-reference/webhook-endpoints/get-by-id"},{"title":"List Webhook Endpoints","openapi":"POST /webhook-endpoints/list","href":"/api-reference/webhook-endpoints/list"},{"title":"Update Webhook Endpoint","openapi":"POST /webhook-endpoints/{id}/update","href":"/api-reference/webhook-endpoints/update"},{"title":"Delete Webhook Endpoint","openapi":"POST /webhook-endpoints/{id}/delete","href":"/api-reference/webhook-endpoints/delete"}]},{"group":"Request Logs","pages":[{"title":"Request Log Object","href":"/api-reference/request-logs/request-log-object"},{"title":"List Request Logs","openapi":"GET /request-logs","href":"/api-reference/request-logs/list"},{"title":"Get Request Log By ID","openapi":"GET /request-logs/{id}","href":"/api-reference/request-logs/get-by-id"}]},{"group":"Supernova MCP","pages":[{"title":"Create MCP Token","openapi":"POST /mcp/tokens/create","href":"/api-reference/mcp-tokens/create-mcp-token"},{"title":"Revoke MCP Tokens","openapi":"POST /mcp/tokens/revoke","href":"/api-reference/mcp-tokens/revoke-mcp-tokens"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product-updates"}]}]},"title":"The Transaction Object - Knot","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["10e4515597","c2aa737661","2b790eda92","2bfc744e19","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DblVYOPe.js","dist-BnkC_6oA.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-CCOYKgaU.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","NarrationPlayer-C1PbUXWf.js","types-CiTgMxws.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","AssistantPageLink-BM4S31-f.js"]}