Extra data (booking info, insurance, flight reservations, ...) as serialized JSON
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tabby","colors":{"primary":"#41A854","light":"#6CFF93","dark":"#41A854"},"logo":{"light":"https://mintcdn.com/tabby-26277sa/VGR1VunycMFYW0gO/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=VGR1VunycMFYW0gO\u0026q=85\u0026s=0fd2a3090f99185f666929e20a7504a4","dark":"https://mintcdn.com/tabby-26277sa/VGR1VunycMFYW0gO/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=VGR1VunycMFYW0gO\u0026q=85\u0026s=0fd2a3090f99185f666929e20a7504a4"},"favicon":"https://mintcdn.com/tabby-26277sa/t5b0diXp4aP0BKke/favicon-new.png?fit=max\u0026auto=format\u0026n=t5b0diXp4aP0BKke\u0026q=85\u0026s=35c48485cefd869270047b5cef780d80","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript","php","go","java","ruby"],"prefill":true}},"appearance":{"default":"light","strict":false},"navbar":{"primary":{"type":"button","label":"Register","href":"https://merchant.tabby.ai"}},"footer":{"socials":{"facebook":"https://www.facebook.com/tabbypay-100185885064531","instagram":"https://instagram.com/tabbypay","linkedin":"https://www.linkedin.com/company/tabbypay","x":"https://twitter.com/paywithtabby?lang=en"}},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction/what-is-tabby"},{"language":"ar","href":"ar/marketing/toolkit"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tabby-26277sa","hasAudioNarration":false,"actualSubdomain":"tabby-26277sa","customDomains":["docs.tabby.sa"],"gitSource":{"type":"github","owner":"dmitriifrolovtabby","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"e7db906b-a6f9-40ac-b65d-c29741bf1c7d","liveDeploymentHistoryId":"6adb523e00bf4036f5c4a6eb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb523e00bf4036f5c4a6eb"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb523e00bf4036f5c4a6eb","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"Documentation","count":36},{"language":"en","tag":"API Playground","count":28},{"language":"en","tag":"E-commerce Platforms","count":15},{"language":"en","tag":"Online Custom Integration","count":12},{"language":"en","tag":"Webhooks","count":7},{"language":"en","tag":"Disputes","count":6},{"language":"en","tag":"Payments","count":6},{"language":"en","tag":"Dispute Webhooks","count":5},{"language":"en","tag":"Introduction","count":5},{"language":"en","tag":"Shopify","count":3},{"language":"ar","tag":"مجموعة أدوات التسويق","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Tabby Sans Display';src:url(/fonts/TabbySansDisplay-Bold.woff2) format('woff2');font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Regular.woff2) format('woff2');font-weight:100 400;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Medium.woff2) format('woff2');font-weight:500 600;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Bold.woff2) format('woff2');font-weight:700 900;font-style:normal;font-display:swap}.font-sans,body{font-family:'Tabby Sans Text',ui-sans-serif,system-ui,-apple-system,sans-serif!important}h1,h2,h3,h4{font-family:'Tabby Sans Display','Tabby Sans Text',sans-serif;letter-spacing:normal!important}img.product-shot,video.product-shot{display:block;margin:1.5rem auto;border-radius:1rem;border:1px solid rgb(10 10 10/.1);box-shadow:0 10px 25px -5px rgb(0 0 0/.12),0 4px 10px -6px rgb(0 0 0/.1)}.dark img.product-shot,.dark video.product-shot{border-color:rgb(255 255 255/.15);box-shadow:0 10px 25px -5px rgb(0 0 0/.45)}img.framed-shot,img.snippet-shot{display:block;margin:1.5rem auto}img.framed-shot{width:min(520px,100%);border-radius:12px}li img.framed-shot{width:min(520px,calc(100% - 38px))}div.product-shot-figure{margin:1.5rem auto;text-align:center}div.product-shot-figure img.product-shot{margin:1.5rem auto 0}p.product-shot-caption{margin-top:.75rem;font-size:.875rem;color:rgb(107 114 128)}html[lang=ar] #content,html[lang=ar] .mdx-content{direction:rtl}html[lang=ar] #header{direction:rtl;text-align:right}html[lang=ar] #content :is(ul, ol)>li{padding-left:6px;padding-right:32px}html[lang=ar] #content :is(ul, ol)>li::before{left:auto;right:8px}html[lang=ar] #content a svg.rotate-0.overflow-visible,html[lang=ar] #content svg.lucide-arrow-right,html[lang=ar] #content svg.lucide-arrow-up-right,html[lang=ar] #content svg.lucide-chevron-right{transform:scaleX(-1)}html[lang=ar] #content .absolute:has(>svg.lucide-arrow-up-right){right:auto;left:1.25rem}html[lang=ar] #content blockquote{border-left-width:0}#content-area .mdx-content,#content-container .mdx-content{max-width:80ch}@media (min-width:1280px){.max-w-8xl,div:has(>#content-container){max-width:100rem!important}}button[data-component-part=code-block-footer-button]{color:#6cff93!important;font-weight:600}button[data-component-part=code-block-footer-button]:hover{text-decoration:underline}.messaging-table table td:first-child,.messaging-table table th:first-child{width:1%;min-width:0;white-space:nowrap}:root:not(.dark) span[data-badge=true][data-color=gray]{background-color:#f5f4f2!important;color:#1a1919!important}:root:not(.dark) span[data-badge=true][data-color=blue]{background-color:#dfecf7!important;color:#3380c0!important}:root:not(.dark) span[data-badge=true][data-color=green]{background-color:#daf0df!important;color:#238e3b!important}:root:not(.dark) span[data-badge=true][data-color=yellow]{background-color:#fcedb8!important;color:#d66a1e!important}:root:not(.dark) span[data-badge=true][data-color=orange]{background-color:#ffe6cc!important;color:#d66a1e!important}:root:not(.dark) span[data-badge=true][data-color=red]{background-color:#ffe1de!important;color:#d44c3b!important}:root:not(.dark) span[data-badge=true][data-color=purple]{background-color:#f5defa!important;color:#a55ab8!important}:root:not(.dark) .callout[data-callout-type=info],:root:not(.dark) .callout[data-callout-type=note]{background-color:#dfecf7!important;border-color:#c4dcef!important}:root:not(.dark) .callout[data-callout-type=info] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=info] [data-component-part=callout-icon],:root:not(.dark) .callout[data-callout-type=note] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=note] [data-component-part=callout-icon]{color:#3380c0!important}:root:not(.dark) .callout[data-callout-type=check],:root:not(.dark) .callout[data-callout-type=tip]{background-color:#daf0df!important;border-color:#bfe4c9!important}:root:not(.dark) .callout[data-callout-type=check] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=check] [data-component-part=callout-icon],:root:not(.dark) .callout[data-callout-type=tip] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=tip] [data-component-part=callout-icon]{color:#238e3b!important}:root:not(.dark) .callout[data-callout-type=danger]{background-color:#ffe1de!important;border-color:#ffc7c1!important}:root:not(.dark) .callout[data-callout-type=danger] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=danger] [data-component-part=callout-icon]{color:#d44c3b!important}:root:not(.dark) .callout[data-callout-type=warning]{background-color:#fcedb8!important;border-color:#f5de8e!important}:root:not(.dark) .callout[data-callout-type=warning] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=warning] [data-component-part=callout-icon]{color:#d66a1e!important}.dark span[data-badge=true][data-color=gray]{background-color:rgb(245 244 242/.12)!important;color:#e8e6e3!important}.dark span[data-badge=true][data-color=blue]{background-color:rgb(51 128 192/.22)!important;color:#dfecf7!important}.dark span[data-badge=true][data-color=green]{background-color:rgb(35 142 59/.22)!important;color:#daf0df!important}.dark span[data-badge=true][data-color=yellow]{background-color:rgb(214 106 30/.22)!important;color:#fcedb8!important}.dark span[data-badge=true][data-color=orange]{background-color:rgb(214 106 30/.22)!important;color:#ffe6cc!important}.dark span[data-badge=true][data-color=red]{background-color:rgb(212 76 59/.22)!important;color:#ffe1de!important}.dark span[data-badge=true][data-color=purple]{background-color:rgb(165 90 184/.22)!important;color:#f5defa!important}.dark .callout[data-callout-type=info],.dark .callout[data-callout-type=note]{background-color:rgb(51 128 192/.18)!important;border-color:rgb(51 128 192/.45)!important}.dark .callout[data-callout-type=info] [data-component-part=callout-content],.dark .callout[data-callout-type=info] [data-component-part=callout-icon],.dark .callout[data-callout-type=note] [data-component-part=callout-content],.dark .callout[data-callout-type=note] [data-component-part=callout-icon]{color:#dfecf7!important}.dark .callout[data-callout-type=check],.dark .callout[data-callout-type=tip]{background-color:rgb(35 142 59/.18)!important;border-color:rgb(35 142 59/.45)!important}.dark .callout[data-callout-type=check] [data-component-part=callout-content],.dark .callout[data-callout-type=check] [data-component-part=callout-icon],.dark .callout[data-callout-type=tip] [data-component-part=callout-content],.dark .callout[data-callout-type=tip] [data-component-part=callout-icon]{color:#daf0df!important}.dark .callout[data-callout-type=danger]{background-color:rgb(212 76 59/.18)!important;border-color:rgb(212 76 59/.45)!important}.dark .callout[data-callout-type=danger] [data-component-part=callout-content],.dark .callout[data-callout-type=danger] [data-component-part=callout-icon]{color:#ffe1de!important}.dark .callout[data-callout-type=warning]{background-color:rgb(214 106 30/.18)!important;border-color:rgb(214 106 30/.45)!important}.dark .callout[data-callout-type=warning] [data-component-part=callout-content],.dark .callout[data-callout-type=warning] [data-component-part=callout-icon]{color:#fcedb8!important}.callout [data-component-part=callout-icon] svg{color:inherit!important}#content a.cta-button{display:inline-flex;align-items:center;gap:.5rem;padding:.75rem 1.5rem;border-radius:9999px;background-color:#41a854;color:#fff!important;font-weight:600;font-size:1rem;line-height:1.25;text-decoration:none!important;transition:background-color .15s ease,transform .15s ease}#content a.cta-button::after{content:\"↗\";font-size:1.05em;line-height:1}#content a.cta-button:hover{background-color:#2f8b41;transform:translateY(-1px)}.dark #content a.cta-button{background-color:#6cff93;color:#0a0a0a!important}.dark #content a.cta-button:hover{background-color:#8cffab}html[lang=ar] #content a.cta-button::after{content:\"↖\"}[id^=body-] [data-component-part=field-meta-post]{background-color:#fcedb8!important;color:#d66a1e!important}.dark [id^=body-] [data-component-part=field-meta-post]{background-color:rgba(252,237,184,.12)!important;color:#fcedb8!important}"},{"filePath":"swagger/swagger-ui.css","href":"/_mintlify/custom/tabby-26277sa/7e77e8f2d6246341/swagger/swagger-ui.css"}],"page":{"pagePath":"api-reference/payments/retrieve-a-payment","slug":"/api-reference/payments/retrieve-a-payment","pageMetadata":{"openapi":"get /api/v2/payments/{id}","title":"Retrieve a payment","description":"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.","href":"/api-reference/payments/retrieve-a-payment"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"dark","config":{},"pageMetadata":{"openapi":"get /api/v2/payments/{id}","title":"Retrieve a payment","description":"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.","href":"/api-reference/payments/retrieve-a-payment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/tabby-26277sa/9f2b5ecdf0f199ba/eslint.config.js","/_mintlify/custom/tabby-26277sa/b26a86079cee90e6/next.config.js","/_mintlify/custom/tabby-26277sa/b8a8460aa1a4fa11/swagger/swagger-ui-bundle.js","/_mintlify/custom/tabby-26277sa/19a31c3b1620a182/swagger/swagger-ui-standalone-preset.js","/_mintlify/custom/tabby-26277sa/316fd6bc989c58f1/swagger/swagger-ui.js"],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Retrieve a payment","description":"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.","operationId":"getPayment","security":["17c4d33f-ce9e-4276-b33f-6371b39fd4c2"],"parameters":["52a817fc-3bda-4c25-9b22-85d28bf5659a"],"responses":{"200":"4b675c3d-e001-412d-9ccb-75988dde2e35","400":"b3218252-a7fb-4f18-872a-8ebd13fda306","401":"b3e9afe9-894f-4c25-a13e-c81df79e2d74","404":"c063a3ba-c5c9-4032-8335-7e2a4a9eab23","500":"158d6a03-4571-4868-a616-d5c9ab59645a"},"method":"get","type":"path","servers":["7d7c4395-25e2-4a21-baba-1d9524afd8d7","f6a4d9f7-9247-43bd-896a-c4e6012edea7"],"path":"/api/v2/payments/{id}","baseUrlOptions":["https://api.tabby.ai/","https://api.tabby.sa/"],"title":"Retrieve a payment","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","php","go","java","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"52a817fc-3bda-4c25-9b22-85d28bf5659a":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","example":"payment id, uuid format","isRequired":true,"description":"ID of the payment.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"ID of the payment."}},"responses":{"4b675c3d-e001-412d-9ccb-75988dde2e35":{"description":"Success. Payment object is returned.","content":{"application/json":{"schema":{"description":"Payment object.","type":"object","properties":{"amount":{"type":"string","example":"100","description":"Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","enum":["AED","SAR"],"example":"AED","description":"ISO 4217 currency code for the payment amount. Currently there are 2 possible currency options - depending on the country where the store is located:\n - `AED` - United Arab Emirates Dirham\n - `SAR` - Saudi Riyal\n","isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"buyer":{"oneOf":[{"description":"Customer information","type":"object","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name.","isRequired":true,"uniqueKey":"buyer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","example":"John Doe","description":"Customer’s full name.","isRequired":true,"uniqueKey":"buyer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address.","isRequired":true,"uniqueKey":"buyer.oneOf.0.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Customer’s email address.","isRequired":true,"uniqueKey":"buyer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer.oneOf.0.email","typeLabel":"string\u003cemail> | null"},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`.","isRequired":true,"uniqueKey":"buyer.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`.","isRequired":true,"uniqueKey":"buyer.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer.oneOf.0.phone","typeLabel":"string | null"},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD.","uniqueKey":"buyer.oneOf.0.dob.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD.","uniqueKey":"buyer.oneOf.0.dob.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.dob","typeLabel":"string\u003cdate> | null"}},"required":["phone","email","name"],"isRequired":true,"uniqueKey":"buyer.oneOf.0","typeLabel":"object"},{"description":"Customer information","type":"null","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name."},{"type":"null","example":"John Doe","description":"Customer’s full name."}]},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address."},{"type":"null","format":"email","description":"Customer’s email address."}]},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."}]},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."}]}},"required":["phone","email","name"],"isRequired":true,"uniqueKey":"buyer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer","typeLabel":"object | null"},"shipping_address":{"oneOf":[{"type":"object","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shipping_address.oneOf.0.city","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.address.oneOf.0","typeLabel":"string"},{"type":"null","example":"Dubai","description":"Building name, apartment number.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shipping_address.oneOf.0.address","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","example":"1111","description":"Postal code.","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shipping_address.oneOf.0.zip","typeLabel":"string | null"}},"required":["city","address","zip"],"isRequired":true,"uniqueKey":"shipping_address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village."},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village."}]},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number."},{"type":"null","example":"Dubai","description":"Building name, apartment number."}]},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code."},{"type":"null","example":"1111","description":"Postal code."}]}},"required":["city","address","zip"],"isRequired":true,"uniqueKey":"shipping_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shipping_address","typeLabel":"object | null"},"order":{"oneOf":[{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"1001","description":"Merchant-assigned order number.","isRequired":true,"uniqueKey":"order.oneOf.0.reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"1001","description":"Merchant-assigned order number.","isRequired":true,"uniqueKey":"order.oneOf.0.reference_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.reference_id","typeLabel":"string | null"},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].unit_price","typeLabel":"string"},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Description of the product","description":"Description of the product.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curi> | null"},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_url","typeLabel":"string\u003curi> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","example":"white","description":"white / blue/ green","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].color","typeLabel":"string | null"},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_material.oneOf.0","typeLabel":"string"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_material.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].product_material","typeLabel":"string | null"},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"EU","description":"EU / UK","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size_type","typeLabel":"string | null"},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size.oneOf.0","typeLabel":"string"},{"type":"null","example":"M","description":"L / XL / 12","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].size","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether a product can be returned","uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX].is_refundable","typeLabel":"boolean | null"}},"required":["title","quantity","unit_price","category"],"uniqueKey":"order.oneOf.0.\\items.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Array of objects representing the order items in this payment.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment.","isRequired":true,"uniqueKey":"order.oneOf.0.\\items.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.\\items","typeLabel":"object[] | null"},"updated_at":{"type":"string","format":"date-time","description":"Date and time the order was last updated, in UTC, and displayed in ISO 8601 datetime format.","uniqueKey":"order.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"tax_amount":{"type":"string","default":"0","example":"0.00","description":"Total tax for the order.","uniqueKey":"order.oneOf.0.tax_amount","typeLabel":"string"},"shipping_amount":{"type":"string","default":"0","example":"0.00","description":"Total shipping cost for the order.","uniqueKey":"order.oneOf.0.shipping_amount","typeLabel":"string"},"discount_amount":{"type":"string","default":"0","example":"0.00","description":"Total discount for the order. Should be positive or zero. Shows up on Tabby App for the Customer's convenience.","uniqueKey":"order.oneOf.0.discount_amount","typeLabel":"string"}},"required":["items","reference_id"],"isRequired":true,"uniqueKey":"order.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"reference_id":{"oneOf":[{"type":"string","example":"1001","description":"Merchant-assigned order number."},{"type":"null","example":"1001","description":"Merchant-assigned order number."}]},"updated_at":{"type":"string","format":"date-time","description":"Date and time the order was last updated, in UTC, and displayed in ISO 8601 datetime format."},"tax_amount":{"type":"string","default":"0","example":"0.00","description":"Total tax for the order."},"shipping_amount":{"type":"string","default":"0","example":"0.00","description":"Total shipping cost for the order."},"discount_amount":{"type":"string","default":"0","example":"0.00","description":"Total discount for the order. Should be positive or zero. Shows up on Tabby App for the Customer's convenience."},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment."},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment."}]}},"required":["items","reference_id"],"isRequired":true,"uniqueKey":"order.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order","typeLabel":"object | null"},"buyer_history":{"description":"Customer / user / student information from previous purchases with you.","type":"object","properties":{"registered_since":{"type":"string","format":"date-time","description":"Date and time the customer / user / student got registred with your store / portal, in UTC, and displayed in ISO 8601 datetime format.","isRequired":true,"uniqueKey":"buyer_history.registered_since","typeLabel":"string\u003cdate-time>"},"loyalty_level":{"type":"number","default":0,"description":"Customer / user / student loyalty level with you. Should be sent as a number of successfully placed purchases from your store / portal with any payment methods.","isRequired":true,"uniqueKey":"buyer_history.loyalty_level","typeLabel":"number"},"wishlist_count":{"type":"number","default":0,"minimum":0,"description":"Number of items in Customer's wishlist.","uniqueKey":"buyer_history.wishlist_count","typeLabel":"number"},"is_social_networks_connected":{"oneOf":[{"type":"boolean","description":"Is social network connected.","uniqueKey":"buyer_history.is_social_networks_connected.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Is social network connected.","uniqueKey":"buyer_history.is_social_networks_connected.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer_history.is_social_networks_connected","typeLabel":"boolean | null"},"is_phone_number_verified":{"oneOf":[{"type":"boolean","description":"Is phone number verified.","uniqueKey":"buyer_history.is_phone_number_verified.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Is phone number verified.","uniqueKey":"buyer_history.is_phone_number_verified.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer_history.is_phone_number_verified","typeLabel":"boolean | null"},"is_email_verified":{"oneOf":[{"type":"boolean","description":"Is email verified.","uniqueKey":"buyer_history.is_email_verified.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Is email verified.","uniqueKey":"buyer_history.is_email_verified.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer_history.is_email_verified","typeLabel":"boolean | null"}},"required":["registered_since","loyalty_level"],"isRequired":true,"uniqueKey":"buyer_history","typeLabel":"object"},"order_history":{"oneOf":[{"type":"array","description":"Array of objects, should contain information on 5-10 previously placed via any payment method orders in any status, current order excluded.","items":{"type":"object","properties":{"purchased_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time the order was placed, in UTC, and displayed in ISO 8601 datetime format.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].purchased_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time the order was placed, in UTC, and displayed in ISO 8601 datetime format.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].purchased_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].purchased_at","typeLabel":"string\u003cdate-time> | null"},"amount":{"oneOf":[{"type":"string","example":"100","description":"Total payment amount, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","example":"100","description":"Total payment amount, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].amount","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","enum":["new","processing","complete","refunded","canceled","unknown"],"description":"Status of the order.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["new","processing","complete","refunded","canceled","unknown"],"description":"Status of the order.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"buyer":{"oneOf":[{"description":"Customer information","type":"object","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","example":"John Doe","description":"Customer’s full name.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Customer’s email address.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.email","typeLabel":"string\u003cemail> | null"},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.phone","typeLabel":"string | null"},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD.","uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.dob.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD.","uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.dob.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0.dob","typeLabel":"string\u003cdate> | null"}},"required":["phone","email","name"],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.0","typeLabel":"object"},{"description":"Customer information","type":"null","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name."},{"type":"null","example":"John Doe","description":"Customer’s full name."}]},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address."},{"type":"null","format":"email","description":"Customer’s email address."}]},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."}]},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."}]}},"required":["phone","email","name"],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].buyer","typeLabel":"object | null"},"shipping_address":{"oneOf":[{"type":"object","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.city","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.address.oneOf.0","typeLabel":"string"},{"type":"null","example":"Dubai","description":"Building name, apartment number.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.address","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","example":"1111","description":"Postal code.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0.zip","typeLabel":"string | null"}},"required":["city","address","zip"],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village."},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village."}]},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number."},{"type":"null","example":"Dubai","description":"Building name, apartment number."}]},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code."},{"type":"null","example":"1111","description":"Postal code."}]}},"required":["city","address","zip"],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].shipping_address","typeLabel":"object | null"},"payment_method":{"oneOf":[{"type":"string","enum":["card","cod"],"example":"card","description":"Payment method used.","uniqueKey":"order_history.oneOf.0.items.[INDEX].payment_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["card","cod"],"example":"card","description":"Payment method used.","uniqueKey":"order_history.oneOf.0.items.[INDEX].payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring> | null"},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"quantity":{"type":"integer","default":1,"minimum":0,"example":1,"description":"Quantity of the product ordered.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price","typeLabel":"string"},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Description of the product","description":"Description of the product.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curi> | null"},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url","typeLabel":"string\u003curi> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","example":"white","description":"white / blue/ green","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color","typeLabel":"string | null"},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.0","typeLabel":"string"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material","typeLabel":"string | null"},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"EU","description":"EU / UK","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type","typeLabel":"string | null"},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.0","typeLabel":"string"},{"type":"null","example":"M","description":"L / XL / 12","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether a product can be returned","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable","typeLabel":"boolean | null"},"ordered":{"type":"integer","default":0,"description":"Quantity of SKUs in the order without a final status yet.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].ordered","typeLabel":"integer"},"captured":{"type":"integer","default":0,"description":"Quantity of captured SKUs in the order (paid by customer).","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].captured","typeLabel":"integer"},"shipped":{"type":"integer","default":0,"description":"Quantity of SKUs in the order shipped to the customer.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].shipped","typeLabel":"integer"},"refunded":{"type":"integer","default":0,"description":"Quantity of SKUs in the order refunded to the customer.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].refunded","typeLabel":"integer"}},"required":["title","quantity","unit_price","category"],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Array of objects representing the order items in this payment. If you want to offer consumers a discount, use this object to create a “discount order item”, with the unit_price set to the negative value of the discount.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":1,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]},"ordered":{"type":"integer","default":0,"description":"Quantity of SKUs in the order without a final status yet."},"captured":{"type":"integer","default":0,"description":"Quantity of captured SKUs in the order (paid by customer)."},"shipped":{"type":"integer","default":0,"description":"Quantity of SKUs in the order shipped to the customer."},"refunded":{"type":"integer","default":0,"description":"Quantity of SKUs in the order refunded to the customer."}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment. If you want to offer consumers a discount, use this object to create a “discount order item”, with the unit_price set to the negative value of the discount.","uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_history.oneOf.0.items.[INDEX].\\items","typeLabel":"object[] | null"}},"required":["purchased_at","amount","status","buyer","shipping_address"],"uniqueKey":"order_history.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order_history.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Array of objects, should contain information on 5-10 previously placed via any payment method orders in any status, current order excluded.","items":{"type":"object","properties":{"purchased_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time the order was placed, in UTC, and displayed in ISO 8601 datetime format."},{"type":"null","format":"date-time","description":"Date and time the order was placed, in UTC, and displayed in ISO 8601 datetime format."}]},"amount":{"oneOf":[{"type":"string","example":"100","description":"Total payment amount, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD."},{"type":"null","example":"100","description":"Total payment amount, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD."}]},"payment_method":{"oneOf":[{"type":"string","enum":["card","cod"],"example":"card","description":"Payment method used."},{"type":"null","enum":["card","cod"],"example":"card","description":"Payment method used."}]},"status":{"oneOf":[{"type":"string","enum":["new","processing","complete","refunded","canceled","unknown"],"description":"Status of the order."},{"type":"null","enum":["new","processing","complete","refunded","canceled","unknown"],"description":"Status of the order."}]},"buyer":{"oneOf":[{"description":"Customer information","type":"object","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name."},{"type":"null","example":"John Doe","description":"Customer’s full name."}]},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address."},{"type":"null","format":"email","description":"Customer’s email address."}]},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."}]},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."}]}},"required":["phone","email","name"]},{"description":"Customer information","type":"null","properties":{"name":{"oneOf":[{"type":"string","example":"John Doe","description":"Customer’s full name."},{"type":"null","example":"John Doe","description":"Customer’s full name."}]},"email":{"oneOf":[{"type":"string","format":"email","description":"Customer’s email address."},{"type":"null","format":"email","description":"Customer’s email address."}]},"phone":{"oneOf":[{"type":"string","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."},{"type":"null","example":"500000001","description":"Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages. The accepted phone masks are - `500000001`, `0500000001`, `+971500000001`, `971500000001`."}]},"dob":{"oneOf":[{"type":"string","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."},{"type":"null","format":"date","example":"2000-01-20","description":"Customer's date of birth; format is YYYY-MM-DD."}]}},"required":["phone","email","name"]}]},"shipping_address":{"oneOf":[{"type":"object","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village."},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village."}]},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number."},{"type":"null","example":"Dubai","description":"Building name, apartment number."}]},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code."},{"type":"null","example":"1111","description":"Postal code."}]}},"required":["city","address","zip"]},{"type":"null","properties":{"city":{"oneOf":[{"type":"string","example":"Dubai","description":"Name of city, municipality, or village."},{"type":"null","example":"Dubai","description":"Name of city, municipality, or village."}]},"address":{"oneOf":[{"type":"string","example":"Dubai","description":"Building name, apartment number."},{"type":"null","example":"Dubai","description":"Building name, apartment number."}]},"zip":{"oneOf":[{"type":"string","example":"1111","description":"Postal code."},{"type":"null","example":"1111","description":"Postal code."}]}},"required":["city","address","zip"]}]},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":1,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]},"ordered":{"type":"integer","default":0,"description":"Quantity of SKUs in the order without a final status yet."},"captured":{"type":"integer","default":0,"description":"Quantity of captured SKUs in the order (paid by customer)."},"shipped":{"type":"integer","default":0,"description":"Quantity of SKUs in the order shipped to the customer."},"refunded":{"type":"integer","default":0,"description":"Quantity of SKUs in the order refunded to the customer."}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment. If you want to offer consumers a discount, use this object to create a “discount order item”, with the unit_price set to the negative value of the discount."},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":1,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]},"ordered":{"type":"integer","default":0,"description":"Quantity of SKUs in the order without a final status yet."},"captured":{"type":"integer","default":0,"description":"Quantity of captured SKUs in the order (paid by customer)."},"shipped":{"type":"integer","default":0,"description":"Quantity of SKUs in the order shipped to the customer."},"refunded":{"type":"integer","default":0,"description":"Quantity of SKUs in the order refunded to the customer."}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items in this payment. If you want to offer consumers a discount, use this object to create a “discount order item”, with the unit_price set to the negative value of the discount."}]}},"required":["purchased_at","amount","status","buyer","shipping_address"]},"isRequired":true,"uniqueKey":"order_history.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order_history","typeLabel":"object[] | null"},"id":{"type":"string","format":"uuid","example":"payment id, uuid format","readOnly":true,"description":"Unique identifier for the payment (UUID), assigned by Tabby. Save it on your side!","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","readOnly":true,"format":"date-time","description":"Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","readOnly":true,"format":"date-time","description":"Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","readOnly":true,"enum":["CREATED","AUTHORIZED","CLOSED","REJECTED","EXPIRED"],"example":"CLOSED","description":"Status of the current payment:\n- `CREATED` means that the payment is created successfully, but not finished yet;\n- `AUTHORIZED` and `CLOSED` mark the successfully approved and captured payments accordingly;\n- `REJECTED` is returned when a customer is rejected during Tabby Checkout;\n- `EXPIRED` is used when a customer cancels a payment or when Tabby doesn't receive a successfully paid transaction after timeout.\n","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"is_test":{"readOnly":true,"type":"boolean","description":"Indicates whether this is a test payment (created using the Test API keys or Production API Keys).","uniqueKey":"is_test","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","example":"description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","example":"description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"captures":{"oneOf":[{"type":"array","readOnly":true,"items":{"type":"object","properties":{"amount":{"type":"string","example":"100","description":"Total payment amount captured, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"reference_id":{"oneOf":[{"type":"string","example":"capture idempotency key","description":"Idempotency key. Used to avoid similar capture requests.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"capture idempotency key","description":"Idempotency key. Used to avoid similar capture requests.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"id":{"type":"string","format":"uuid","example":"capture id, uuid format","readOnly":true,"description":"Unique capture ID, assigned by Tabby.","uniqueKey":"captures.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time the capture was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.","uniqueKey":"captures.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"tax_amount":{"type":"string","default":"0","example":"0.00","description":"Tax amount captured.","uniqueKey":"captures.oneOf.0.items.[INDEX].tax_amount","typeLabel":"string"},"shipping_amount":{"type":"string","default":"0","example":"0.00","description":"Shipping cost captured.","uniqueKey":"captures.oneOf.0.items.[INDEX].shipping_amount","typeLabel":"string"},"discount_amount":{"type":"string","default":"0","example":"0.00","description":"Total discount for the order. Should be positive or zero.","uniqueKey":"captures.oneOf.0.items.[INDEX].discount_amount","typeLabel":"string"},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price","typeLabel":"string"},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Description of the product","description":"Description of the product.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curi> | null"},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url","typeLabel":"string\u003curi> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","example":"white","description":"white / blue/ green","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color","typeLabel":"string | null"},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.0","typeLabel":"string"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material","typeLabel":"string | null"},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"EU","description":"EU / UK","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type","typeLabel":"string | null"},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.0","typeLabel":"string"},{"type":"null","example":"M","description":"L / XL / 12","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether a product can be returned","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable","typeLabel":"boolean | null"}},"required":["title","quantity","unit_price","category"],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Array of objects representing the order items being captured.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being captured.","uniqueKey":"captures.oneOf.0.items.[INDEX].\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures.oneOf.0.items.[INDEX].\\items","typeLabel":"object[] | null"}},"required":["amount","reference_id"],"uniqueKey":"captures.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"captures.oneOf.0","typeLabel":"object[]"},{"type":"null","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"capture id, uuid format","readOnly":true,"description":"Unique capture ID, assigned by Tabby."},"created_at":{"type":"string","format":"date-time","description":"Date and time the capture was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby."},"amount":{"type":"string","example":"100","description":"Total payment amount captured, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD."},"tax_amount":{"type":"string","default":"0","example":"0.00","description":"Tax amount captured."},"shipping_amount":{"type":"string","default":"0","example":"0.00","description":"Shipping cost captured."},"discount_amount":{"type":"string","default":"0","example":"0.00","description":"Total discount for the order. Should be positive or zero."},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being captured."},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being captured."}]},"reference_id":{"oneOf":[{"type":"string","example":"capture idempotency key","description":"Idempotency key. Used to avoid similar capture requests."},{"type":"null","example":"capture idempotency key","description":"Idempotency key. Used to avoid similar capture requests."}]}},"required":["amount","reference_id"]},"uniqueKey":"captures.oneOf.1","typeLabel":"null"}],"uniqueKey":"captures","typeLabel":"object[] | null"},"refunds":{"oneOf":[{"type":"array","readOnly":true,"items":{"type":"object","properties":{"amount":{"type":"string","default":"0.00","description":"Amount refunded. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"reference_id":{"oneOf":[{"type":"string","example":"refund idempotency key","description":"Idempotency key. Used to avoid similar refund requests.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"refund idempotency key","description":"Idempotency key. Used to avoid similar refund requests.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"id":{"type":"string","format":"uuid","example":"refund id, uuid format","readOnly":true,"description":"Unique refund ID, assigned by Tabby.","uniqueKey":"refunds.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time the refund was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.","uniqueKey":"refunds.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"reason":{"oneOf":[{"type":"string","example":"Reason for the refund","description":"Reason for the refund.","uniqueKey":"refunds.oneOf.0.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","example":"Reason for the refund","description":"Reason for the refund.","uniqueKey":"refunds.oneOf.0.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].reason","typeLabel":"string | null"},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the product","description":"Name of the product.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price","typeLabel":"string"},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.","isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].reference_id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Description of the product","description":"Description of the product.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curi> | null"},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_url","typeLabel":"string\u003curi> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","example":"white","description":"white / blue/ green","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].color","typeLabel":"string | null"},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.0","typeLabel":"string"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_material","typeLabel":"string | null"},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"EU","description":"EU / UK","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size_type","typeLabel":"string | null"},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.0","typeLabel":"string"},{"type":"null","example":"M","description":"L / XL / 12","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].size","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether a product can be returned","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX].is_refundable","typeLabel":"boolean | null"}},"required":["title","quantity","unit_price","category"],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Array of objects representing the order items being refunded.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being refunded.","uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.oneOf.0.items.[INDEX].\\items","typeLabel":"object[] | null"}},"required":["amount","reference_id"],"uniqueKey":"refunds.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"refunds.oneOf.0","typeLabel":"object[]"},{"type":"null","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"refund id, uuid format","readOnly":true,"description":"Unique refund ID, assigned by Tabby."},"created_at":{"type":"string","format":"date-time","description":"Date and time the refund was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby."},"amount":{"type":"string","default":"0.00","description":"Amount refunded. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD."},"reason":{"oneOf":[{"type":"string","example":"Reason for the refund","description":"Reason for the refund."},{"type":"null","example":"Reason for the refund","description":"Reason for the refund."}]},"items":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being refunded."},{"type":"null","items":{"type":"object","properties":{"reference_id":{"oneOf":[{"type":"string","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."},{"type":"null","example":"SKU123","description":"Merchant’s product identifier. Displayed in Customer's App and Merchant Dashboard, used for Item refunds and disputes."}]},"title":{"oneOf":[{"type":"string","example":"Name of the product","description":"Name of the product."},{"type":"null","example":"Name of the product","description":"Name of the product."}]},"description":{"oneOf":[{"type":"string","example":"Description of the product","description":"Description of the product."},{"type":"null","example":"Description of the product","description":"Description of the product."}]},"quantity":{"type":"integer","default":0,"minimum":0,"example":1,"description":"Quantity of the product ordered."},"unit_price":{"type":"string","default":"0","example":"0.00","description":"Price per unit of the product. Should be positive or zero."},"image_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item image to show in the order information."}]},"product_url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com/","description":"URL of the item at your store."},{"type":"null","format":"uri","example":"https://example.com/","description":"URL of the item at your store."}]},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."},{"type":"null","enum":["Male","Female","Kids","Other"],"example":"Kids","description":"Who the goods are designed to."}]},"category":{"oneOf":[{"type":"string","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."},{"type":"null","example":"Clothes","description":"Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided."}]},"color":{"oneOf":[{"type":"string","example":"white","description":"white / blue/ green"},{"type":"null","example":"white","description":"white / blue/ green"}]},"product_material":{"oneOf":[{"type":"string","example":"cotton","description":"cotton / polyester / synthetic"},{"type":"null","example":"cotton","description":"cotton / polyester / synthetic"}]},"size_type":{"oneOf":[{"type":"string","example":"EU","description":"EU / UK"},{"type":"null","example":"EU","description":"EU / UK"}]},"size":{"oneOf":[{"type":"string","example":"M","description":"L / XL / 12"},{"type":"null","example":"M","description":"L / XL / 12"}]},"brand":{"oneOf":[{"type":"string","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"},{"type":"null","example":"Name of the Brand","description":"Mango / Dorothy Perkins / Tommy Hilfiger"}]},"is_refundable":{"oneOf":[{"type":"boolean","description":"Indicates whether a product can be returned"},{"type":"null","description":"Indicates whether a product can be returned"}]}},"required":["title","quantity","unit_price","category"]},"description":"Array of objects representing the order items being refunded."}]},"reference_id":{"oneOf":[{"type":"string","example":"refund idempotency key","description":"Idempotency key. Used to avoid similar refund requests."},{"type":"null","example":"refund idempotency key","description":"Idempotency key. Used to avoid similar refund requests."}]}},"required":["amount","reference_id"]},"uniqueKey":"refunds.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds","typeLabel":"object[] | null"},"meta":{"oneOf":[{"description":"Merchant-defined data about the payment. This field is a key-value map. The example properties provided below.","type":"object","properties":{"customer":{"oneOf":[{"type":"string","example":"#customer-id","uniqueKey":"meta.oneOf.0.customer.oneOf.0","typeLabel":"string"},{"type":"null","example":"#customer-id","uniqueKey":"meta.oneOf.0.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.oneOf.0.customer","typeLabel":"string | null"},"order_id":{"oneOf":[{"type":"string","example":"#1234","uniqueKey":"meta.oneOf.0.order_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"#1234","uniqueKey":"meta.oneOf.0.order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.oneOf.0.order_id","typeLabel":"string | null"}},"uniqueKey":"meta.oneOf.0","typeLabel":"object"},{"description":"Merchant-defined data about the payment. This field is a key-value map. The example properties provided below.","type":"null","properties":{"customer":{"oneOf":[{"type":"string","example":"#customer-id"},{"type":"null","example":"#customer-id"}]},"order_id":{"oneOf":[{"type":"string","example":"#1234"},{"type":"null","example":"#1234"}]}},"uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"object | null"},"attachment":{"oneOf":[{"type":"object","description":"Extra data (booking info, insurance, flight reservations, ...) as serialized JSON","properties":{"body":{"description":"Should be an object containing any of the keys with corresponded sub objects","example":"{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}","properties":{"flight_reservation_details":{"type":"object","properties":{"itinerary":{"description":"Itinerary data, one per segment","type":"array","items":{"type":"object","properties":{"departure_city":{"type":"string","example":"departure_city","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"departure_country":{"type":"string","example":"departure_country","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].departure_country","typeLabel":"string"},"arrival_city":{"type":"string","example":"arrival_city","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"arrival_country":{"type":"string","example":"arrival_country","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].arrival_country","typeLabel":"string"},"carrier":{"type":"string","example":"carrier","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"description":"RFC3339 e.g. 2018-10-17T07:26:33Z","type":"string","format":"date-time","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]Z$","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string\u003cdate-time>"},"class":{"type":"string","example":"class","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"},"refundable":{"description":"true - if ticket can be cancelled/refunded","type":"boolean","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX].refundable","typeLabel":"boolean"}},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.itinerary","typeLabel":"object[]"},"insurance":{"description":"Insurance data","type":"array","items":{"type":"object","properties":{"insurance_company":{"type":"string","example":"insurance_company","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","example":"insurance_type","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"string"},"insurance_price":{"type":"number","example":"insurance_price","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"number"}},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"description":"Passengers data","type":"array","items":{"type":"object","properties":{"full_name":{"type":"string","example":"full_name","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].full_name","typeLabel":"string"},"first_name":{"type":"string","example":"first_name","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","example":"last_name","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].dob","typeLabel":"string"},"document_type":{"type":"string","example":"document_type","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].document_type","typeLabel":"string"},"document_id":{"type":"string","example":"document_id","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].document_id","typeLabel":"string"},"expiration_id_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].expiration_id_date","typeLabel":"string\u003cdate>"},"nationality":{"type":"string","example":"nationality","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].nationality","typeLabel":"string"},"gender":{"description":"F - female, M - male, O - other","type":"string","enum":["F","M","O"],"example":"F","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX].gender","typeLabel":"enum\u003cstring>"}},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.passengers","typeLabel":"object[]"},"pnr":{"type":"string","example":"Trip booking number, e.g. TR9088999","description":"Trip booking number, e.g. TR9088999","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.pnr","typeLabel":"string"},"affiliate_name":{"description":"Name of the affiliate that originated the purchase. If none, leave blank.","type":"string","example":"Name of the affiliate that originated the purchase. If none, leave blank.","uniqueKey":"attachment.oneOf.0.body.flight_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.flight_reservation_details","typeLabel":"object"},"hotel_reservation_details":{"type":"object","properties":{"hotel_itinerary":{"description":"Hotel itinerary data, one per segment","type":"array","items":{"type":"object","properties":{"hotel_name":{"type":"string","example":"hotel_name","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].hotel_name","typeLabel":"string"},"address":{"type":"string","example":"address","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].address","typeLabel":"string"},"hotel_city":{"type":"string","example":"hotel_city","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].hotel_city","typeLabel":"string"},"hotel_country":{"type":"string","example":"hotel_country","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].hotel_country","typeLabel":"string"},"start_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].start_date","typeLabel":"string\u003cdate>"},"end_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].end_date","typeLabel":"string\u003cdate>"},"number_of_rooms":{"type":"integer","example":1,"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].number_of_rooms","typeLabel":"integer"},"class":{"type":"string","example":"class","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.hotel_itinerary","typeLabel":"object[]"},"insurance":{"description":"Insurance data","type":"array","items":{"type":"object","properties":{"insurance_company":{"type":"string","example":"insurance_company","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","example":"insurance_type","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"string"},"insurance_price":{"type":"number","example":"insurance_price","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"number"}},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"description":"Passengers data","type":"array","items":{"type":"object","properties":{"full_name":{"type":"string","example":"full_name","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].full_name","typeLabel":"string"},"first_name":{"type":"string","example":"first_name","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","example":"last_name","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].dob","typeLabel":"string"},"document_type":{"type":"string","example":"document_type","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].document_type","typeLabel":"string"},"document_id":{"type":"string","example":"document_id","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].document_id","typeLabel":"string"},"expiration_id_dt":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].expiration_id_dt","typeLabel":"string\u003cdate>"},"nationality":{"type":"string","example":"nationality","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].nationality","typeLabel":"string"},"gender":{"description":"F - female, M - male, O - other","type":"string","enum":["F","M","O"],"example":"M","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX].gender","typeLabel":"enum\u003cstring>"}},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.passengers","typeLabel":"object[]"},"pnr":{"type":"string","example":"TR9088999","description":"Trip booking number, e.g. TR9088999","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.pnr","typeLabel":"string"},"affiliate_name":{"description":"Name of the affiliate that originated the purchase. If none, leave blank.","type":"string","example":"Name of the affiliate that originated the purchase. If none, leave blank.","uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.hotel_reservation_details","typeLabel":"object"},"insurance_details":{"type":"object","properties":{"policy_details":{"description":"Information about insurance","type":"object","properties":{"insurance_type":{"description":"Insurance policy type","type":"string","example":"Insurance policy type","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.insurance_type","typeLabel":"string"},"insurance_start_dt":{"description":"ISO 8601 start date, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.insurance_start_dt","typeLabel":"string"},"insurance_end_dt":{"description":"ISO 8601 end date, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.insurance_end_dt","typeLabel":"string"},"insured_amount":{"description":"Amount of insurance policy","type":"string","example":"100","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.insured_amount","typeLabel":"string"},"car_details":{"description":"Required for car insurance","type":"object","properties":{"manufacturer":{"type":"string","example":"manufacturer","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.car_details.manufacturer","typeLabel":"string"},"model":{"type":"string","example":"model","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.car_details.model","typeLabel":"string"},"year":{"type":"string","example":"year","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.car_details.year","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.car_details","typeLabel":"object"},"travel_details":{"description":"Required for travel insurance","type":"object","properties":{"departure_country":{"type":"string","example":"departure_country","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.travel_details.departure_country","typeLabel":"string"},"arrival_country":{"type":"string","example":"arrival_country","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.travel_details.arrival_country","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.travel_details","typeLabel":"object"},"refundable":{"description":"If insurance can be cancelled/refunded - true, otherwise - false","type":"boolean","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.refundable","typeLabel":"boolean"},"provider_name":{"type":"string","example":"provider_name","uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details.provider_name","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details.policy_details","typeLabel":"object"},"client":{"type":"object","properties":{"first_name":{"type":"string","example":"first_name","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"last_name","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.last_name","typeLabel":"string"},"document_type":{"type":"string","example":"document_type","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.document_type","typeLabel":"string"},"full_name":{"type":"string","example":"full_name","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.full_name","typeLabel":"string"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.dob","typeLabel":"string"},"document_id":{"type":"string","example":"document_id","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.document_id","typeLabel":"string"},"expiration_id_dt":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.expiration_id_dt","typeLabel":"string\u003cdate>"},"nationality":{"type":"string","example":"nationality","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.nationality","typeLabel":"string"},"gender":{"description":"F - female, M - male, O - other","example":"F","uniqueKey":"attachment.oneOf.0.body.insurance_details.client.gender","typeLabel":"any"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details.client","typeLabel":"object"},"payment_history_simple":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account","uniqueKey":"attachment.oneOf.0.body.insurance_details.payment_history_simple.unique_account_identifier","typeLabel":"string"},"paid_before_flag":{"type":"boolean","description":"Whether the customer has paid before or not","uniqueKey":"attachment.oneOf.0.body.insurance_details.payment_history_simple.paid_before_flag","typeLabel":"boolean"},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.insurance_details.payment_history_simple.date_of_last_paid_purchase","typeLabel":"string\u003cdate>"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.insurance_details.payment_history_simple.date_of_first_paid_purchase","typeLabel":"string\u003cdate>"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details.payment_history_simple","typeLabel":"object"}},"uniqueKey":"attachment.oneOf.0.body.insurance_details","typeLabel":"object"},"payment_history_full":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account","uniqueKey":"attachment.oneOf.0.body.payment_history_full.unique_account_identifier","typeLabel":"string"},"payment_option":{"description":"One of - card / direct banking / COD (cash) / other","type":"string","enum":["card","direct banking","cod","other"],"example":"card","uniqueKey":"attachment.oneOf.0.body.payment_history_full.payment_option","typeLabel":"enum\u003cstring>"},"number_paid_purchases":{"type":"number","example":1,"uniqueKey":"attachment.oneOf.0.body.payment_history_full.number_paid_purchases","typeLabel":"number"},"total_amount_paid_purchases":{"type":"number","example":1,"uniqueKey":"attachment.oneOf.0.body.payment_history_full.total_amount_paid_purchases","typeLabel":"number"},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.payment_history_full.date_of_last_paid_purchase","typeLabel":"string\u003cdate>"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.payment_history_full.date_of_first_paid_purchase","typeLabel":"string\u003cdate>"},"count_paid_purchases_last_month":{"type":"number","example":1,"uniqueKey":"attachment.oneOf.0.body.payment_history_full.count_paid_purchases_last_month","typeLabel":"number"},"amount_paid_purchases_last_month":{"type":"number","example":1,"uniqueKey":"attachment.oneOf.0.body.payment_history_full.amount_paid_purchases_last_month","typeLabel":"number"},"max_paid_amount_for_1purchase":{"type":"number","example":1,"uniqueKey":"attachment.oneOf.0.body.payment_history_full.max_paid_amount_for_1purchase","typeLabel":"number"}},"uniqueKey":"attachment.oneOf.0.body.payment_history_full","typeLabel":"object"},"payment_history_simple":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account","uniqueKey":"attachment.oneOf.0.body.payment_history_simple.unique_account_identifier","typeLabel":"string"},"paid_before_flag":{"type":"boolean","description":"Whether the customer has paid before or not","uniqueKey":"attachment.oneOf.0.body.payment_history_simple.paid_before_flag","typeLabel":"boolean"},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.payment_history_simple.date_of_last_paid_purchase","typeLabel":"string\u003cdate>"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$","uniqueKey":"attachment.oneOf.0.body.payment_history_simple.date_of_first_paid_purchase","typeLabel":"string\u003cdate>"}},"uniqueKey":"attachment.oneOf.0.body.payment_history_simple","typeLabel":"object"},"flight_points_simple":{"type":"object","properties":{"origin":{"description":"Origin city and airport","type":"object","properties":{"air_code":{"type":"string","example":"JFK","description":"Origin IATA airport code, for example - JFK","uniqueKey":"attachment.oneOf.0.body.flight_points_simple.origin.air_code","typeLabel":"string"},"city_code":{"type":"string","example":"NYC","description":"Origin city code, for example - NYC","uniqueKey":"attachment.oneOf.0.body.flight_points_simple.origin.city_code","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.flight_points_simple.origin","typeLabel":"object"},"destination":{"description":"Destination city and airport","type":"object","properties":{"air_code":{"type":"string","example":"LAX","description":"Destination IATA airport code, for example - LAX","uniqueKey":"attachment.oneOf.0.body.flight_points_simple.destination.air_code","typeLabel":"string"},"city_code":{"type":"string","example":"LAX","description":"Destination city code, for example - LAX","uniqueKey":"attachment.oneOf.0.body.flight_points_simple.destination.city_code","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.flight_points_simple.destination","typeLabel":"object"}},"uniqueKey":"attachment.oneOf.0.body.flight_points_simple","typeLabel":"object"},"marketplaces":{"type":"object","description":"Sellers' details within marketplaces.","properties":{"seller_id":{"type":"string","example":"57327813","description":"Unique ID of the seller within your marketplace.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_id","typeLabel":"string"},"seller_name":{"type":"string","example":"Pet Shop","description":"Name of the seller within your marketplace.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_name","typeLabel":"string"},"seller_category":{"type":"string","example":"Electronics","description":"Category of the seller within your marketplace.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_category","typeLabel":"string"},"seller_website":{"type":"string","example":"https://www.petshop.com","description":"Website of the seller within your marketplace.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_website","typeLabel":"string"},"seller_phone":{"type":"string","example":"500000001","description":"Seller's phone number.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_phone","typeLabel":"string"},"seller_registration_date":{"type":"string","format":"date-time","description":"Seller's registration date, in UTC, and displayed in ISO 8601 datetime format.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_registration_date","typeLabel":"string\u003cdate-time>"},"seller_commercial_registration_number":{"type":"string","example":"1012345678","description":"Seller's commercial registration number.","uniqueKey":"attachment.oneOf.0.body.marketplaces.seller_commercial_registration_number","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0.body.marketplaces","typeLabel":"object"},"education_details":{"type":"object","description":"Education-vertical risk signals for the current session.","properties":{"merchant_subtype":{"type":"string","enum":["formal_education","courses_training"],"example":"formal_education","description":"Duplicated from onboarding config for self-check.","uniqueKey":"attachment.oneOf.0.body.education_details.merchant_subtype","typeLabel":"enum\u003cstring>"},"program":{"type":"object","description":"Details of the education program being paid for.","properties":{"payment_tenure_months":{"type":"integer","example":6,"description":"Total payment plan tenure in months.","uniqueKey":"attachment.oneOf.0.body.education_details.program.payment_tenure_months","typeLabel":"integer"},"months_to_completion":{"type":"integer","example":9,"description":"Months remaining until program completion / graduation.","uniqueKey":"attachment.oneOf.0.body.education_details.program.months_to_completion","typeLabel":"integer"}},"uniqueKey":"attachment.oneOf.0.body.education_details.program","typeLabel":"object"},"student_history":{"type":"object","description":"Student's payment history with the merchant.","properties":{"late_payments_count":{"type":"integer","example":2,"description":"Total count of late payments by the student across history.","uniqueKey":"attachment.oneOf.0.body.education_details.student_history.late_payments_count","typeLabel":"integer"},"avg_overdue_duration_days":{"type":"number","example":4.5,"description":"Average overdue duration in days.","uniqueKey":"attachment.oneOf.0.body.education_details.student_history.avg_overdue_duration_days","typeLabel":"number"},"observation_window_months":{"type":"integer","example":12,"description":"Window over which history was calculated, to distinguish a new student's 0 late payments from a long-history clean student's 0.","uniqueKey":"attachment.oneOf.0.body.education_details.student_history.observation_window_months","typeLabel":"integer"}},"uniqueKey":"attachment.oneOf.0.body.education_details.student_history","typeLabel":"object"}},"uniqueKey":"attachment.oneOf.0.body.education_details","typeLabel":"object"}},"type":"object","uniqueKey":"attachment.oneOf.0.body","typeLabel":"object"},"content_type":{"description":"Version of used schema","type":"string","default":"application/vnd.tabby.v1+json","uniqueKey":"attachment.oneOf.0.content_type","typeLabel":"string"}},"uniqueKey":"attachment.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra data (booking info, insurance, flight reservations, ...) as serialized JSON","properties":{"body":{"description":"Should be an object containing any of the keys with corresponded sub objects","example":"{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}","properties":{"flight_reservation_details":{"type":"object","properties":{"itinerary":{"description":"Itinerary data, one per segment","type":"array","items":{"type":"object","properties":{"departure_city":{"type":"string","example":"departure_city"},"departure_country":{"type":"string","example":"departure_country"},"arrival_city":{"type":"string","example":"arrival_city"},"arrival_country":{"type":"string","example":"arrival_country"},"carrier":{"type":"string","example":"carrier"},"departure_date":{"description":"RFC3339 e.g. 2018-10-17T07:26:33Z","type":"string","format":"date-time","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]Z$"},"class":{"type":"string","example":"class"},"refundable":{"description":"true - if ticket can be cancelled/refunded","type":"boolean"}}}},"insurance":{"description":"Insurance data","type":"array","items":{"type":"object","properties":{"insurance_company":{"type":"string","example":"insurance_company"},"insurance_type":{"type":"string","example":"insurance_type"},"insurance_price":{"type":"number","example":"insurance_price"}}}},"passengers":{"description":"Passengers data","type":"array","items":{"type":"object","properties":{"full_name":{"type":"string","example":"full_name"},"first_name":{"type":"string","example":"first_name"},"last_name":{"type":"string","example":"last_name"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z"},"document_type":{"type":"string","example":"document_type"},"document_id":{"type":"string","example":"document_id"},"expiration_id_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"nationality":{"type":"string","example":"nationality"},"gender":{"description":"F - female, M - male, O - other","type":"string","enum":["F","M","O"],"example":"F"}}}},"pnr":{"type":"string","example":"Trip booking number, e.g. TR9088999","description":"Trip booking number, e.g. TR9088999"},"affiliate_name":{"description":"Name of the affiliate that originated the purchase. If none, leave blank.","type":"string","example":"Name of the affiliate that originated the purchase. If none, leave blank."}}},"hotel_reservation_details":{"type":"object","properties":{"hotel_itinerary":{"description":"Hotel itinerary data, one per segment","type":"array","items":{"type":"object","properties":{"hotel_name":{"type":"string","example":"hotel_name"},"address":{"type":"string","example":"address"},"hotel_city":{"type":"string","example":"hotel_city"},"hotel_country":{"type":"string","example":"hotel_country"},"start_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"end_date":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"number_of_rooms":{"type":"integer","example":1},"class":{"type":"string","example":"class"}}}},"insurance":{"description":"Insurance data","type":"array","items":{"type":"object","properties":{"insurance_company":{"type":"string","example":"insurance_company"},"insurance_type":{"type":"string","example":"insurance_type"},"insurance_price":{"type":"number","example":"insurance_price"}}}},"passengers":{"description":"Passengers data","type":"array","items":{"type":"object","properties":{"full_name":{"type":"string","example":"full_name"},"first_name":{"type":"string","example":"first_name"},"last_name":{"type":"string","example":"last_name"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z"},"document_type":{"type":"string","example":"document_type"},"document_id":{"type":"string","example":"document_id"},"expiration_id_dt":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"nationality":{"type":"string","example":"nationality"},"gender":{"description":"F - female, M - male, O - other","type":"string","enum":["F","M","O"],"example":"M"}}}},"pnr":{"type":"string","example":"TR9088999","description":"Trip booking number, e.g. TR9088999"},"affiliate_name":{"description":"Name of the affiliate that originated the purchase. If none, leave blank.","type":"string","example":"Name of the affiliate that originated the purchase. If none, leave blank."}}},"insurance_details":{"type":"object","properties":{"policy_details":{"description":"Information about insurance","type":"object","properties":{"insurance_type":{"description":"Insurance policy type","type":"string","example":"Insurance policy type"},"insurance_start_dt":{"description":"ISO 8601 start date, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z"},"insurance_end_dt":{"description":"ISO 8601 end date, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z"},"insured_amount":{"description":"Amount of insurance policy","type":"string","example":"100"},"car_details":{"description":"Required for car insurance","type":"object","properties":{"manufacturer":{"type":"string","example":"manufacturer"},"model":{"type":"string","example":"model"},"year":{"type":"string","example":"year"}}},"travel_details":{"description":"Required for travel insurance","type":"object","properties":{"departure_country":{"type":"string","example":"departure_country"},"arrival_country":{"type":"string","example":"arrival_country"}}},"refundable":{"description":"If insurance can be cancelled/refunded - true, otherwise - false","type":"boolean"},"provider_name":{"type":"string","example":"provider_name"}}},"client":{"type":"object","properties":{"first_name":{"type":"string","example":"first_name"},"last_name":{"type":"string","example":"last_name"},"document_type":{"type":"string","example":"document_type"},"full_name":{"type":"string","example":"full_name"},"dob":{"description":"ISO 8601 date of birth, e.g. 2018-10-17","type":"string","example":"2018-10-17T00:00:00.000Z"},"document_id":{"type":"string","example":"document_id"},"expiration_id_dt":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"nationality":{"type":"string","example":"nationality"},"gender":{"description":"F - female, M - male, O - other","example":"F"}}},"payment_history_simple":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account"},"paid_before_flag":{"type":"boolean","description":"Whether the customer has paid before or not"},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"}}}}},"payment_history_full":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account"},"payment_option":{"description":"One of - card / direct banking / COD (cash) / other","type":"string","enum":["card","direct banking","cod","other"],"example":"card"},"number_paid_purchases":{"type":"number","example":1},"total_amount_paid_purchases":{"type":"number","example":1},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"count_paid_purchases_last_month":{"type":"number","example":1},"amount_paid_purchases_last_month":{"type":"number","example":1},"max_paid_amount_for_1purchase":{"type":"number","example":1}}},"payment_history_simple":{"type":"object","properties":{"unique_account_identifier":{"type":"string","example":"unique name / id of the customer","description":"Unique name / number to identify the specific customer account"},"paid_before_flag":{"type":"boolean","description":"Whether the customer has paid before or not"},"date_of_last_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"},"date_of_first_paid_purchase":{"description":"ISO 8601 date e.g. 2018-10-17","type":"string","format":"date","pattern":"^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]$"}}},"flight_points_simple":{"type":"object","properties":{"origin":{"description":"Origin city and airport","type":"object","properties":{"air_code":{"type":"string","example":"JFK","description":"Origin IATA airport code, for example - JFK"},"city_code":{"type":"string","example":"NYC","description":"Origin city code, for example - NYC"}}},"destination":{"description":"Destination city and airport","type":"object","properties":{"air_code":{"type":"string","example":"LAX","description":"Destination IATA airport code, for example - LAX"},"city_code":{"type":"string","example":"LAX","description":"Destination city code, for example - LAX"}}}}},"marketplaces":{"type":"object","description":"Sellers' details within marketplaces.","properties":{"seller_id":{"type":"string","example":"57327813","description":"Unique ID of the seller within your marketplace."},"seller_name":{"type":"string","example":"Pet Shop","description":"Name of the seller within your marketplace."},"seller_category":{"type":"string","example":"Electronics","description":"Category of the seller within your marketplace."},"seller_website":{"type":"string","example":"https://www.petshop.com","description":"Website of the seller within your marketplace."},"seller_phone":{"type":"string","example":"500000001","description":"Seller's phone number."},"seller_registration_date":{"type":"string","format":"date-time","description":"Seller's registration date, in UTC, and displayed in ISO 8601 datetime format."},"seller_commercial_registration_number":{"type":"string","example":"1012345678","description":"Seller's commercial registration number."}}},"education_details":{"type":"object","description":"Education-vertical risk signals for the current session.","properties":{"merchant_subtype":{"type":"string","enum":["formal_education","courses_training"],"example":"formal_education","description":"Duplicated from onboarding config for self-check."},"program":{"type":"object","description":"Details of the education program being paid for.","properties":{"payment_tenure_months":{"type":"integer","example":6,"description":"Total payment plan tenure in months."},"months_to_completion":{"type":"integer","example":9,"description":"Months remaining until program completion / graduation."}}},"student_history":{"type":"object","description":"Student's payment history with the merchant.","properties":{"late_payments_count":{"type":"integer","example":2,"description":"Total count of late payments by the student across history."},"avg_overdue_duration_days":{"type":"number","example":4.5,"description":"Average overdue duration in days."},"observation_window_months":{"type":"integer","example":12,"description":"Window over which history was calculated, to distinguish a new student's 0 late payments from a long-history clean student's 0."}}}}}},"type":"object"},"content_type":{"description":"Version of used schema","type":"string","default":"application/vnd.tabby.v1+json"}},"uniqueKey":"attachment.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment","typeLabel":"object | null"}},"required":["amount","currency","buyer","order","buyer_history","order_history","shipping_address"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":"100","currency":"AED","buyer":{"name":"John Doe","email":"[email protected]","phone":"500000001","dob":"2000-01-20"},"shipping_address":{"city":"Dubai","address":"Dubai","zip":"1111"},"order":{"reference_id":"1001","items":[{"title":"Name of the product","quantity":1,"unit_price":"0.00","category":"Clothes","reference_id":"SKU123","description":"Description of the product","image_url":"https://example.com/","product_url":"https://example.com/","gender":"Kids","color":"white","product_material":"cotton","size_type":"EU","size":"M","brand":"Name of the Brand","is_refundable":true}],"updated_at":"2023-11-07T05:31:56Z","tax_amount":"0.00","shipping_amount":"0.00","discount_amount":"0.00"},"buyer_history":{"registered_since":"2023-11-07T05:31:56Z","loyalty_level":0,"wishlist_count":0,"is_social_networks_connected":true,"is_phone_number_verified":true,"is_email_verified":true},"order_history":[{"purchased_at":"2023-11-07T05:31:56Z","amount":"100","status":"new","buyer":{"name":"John Doe","email":"[email protected]","phone":"500000001","dob":"2000-01-20"},"shipping_address":{"city":"Dubai","address":"Dubai","zip":"1111"},"payment_method":"card","items":[{"title":"Name of the product","quantity":1,"unit_price":"0.00","category":"Clothes","reference_id":"SKU123","description":"Description of the product","image_url":"https://example.com/","product_url":"https://example.com/","gender":"Kids","color":"white","product_material":"cotton","size_type":"EU","size":"M","brand":"Name of the Brand","is_refundable":true,"ordered":0,"captured":0,"shipped":0,"refunded":0}]}],"id":"payment id, uuid format","created_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","status":"CLOSED","is_test":true,"description":"description","captures":[{"amount":"100","reference_id":"capture idempotency key","id":"capture id, uuid format","created_at":"2023-11-07T05:31:56Z","tax_amount":"0.00","shipping_amount":"0.00","discount_amount":"0.00","items":[{"title":"Name of the product","quantity":1,"unit_price":"0.00","category":"Clothes","reference_id":"SKU123","description":"Description of the product","image_url":"https://example.com/","product_url":"https://example.com/","gender":"Kids","color":"white","product_material":"cotton","size_type":"EU","size":"M","brand":"Name of the Brand","is_refundable":true}]}],"refunds":[{"amount":"0.00","reference_id":"refund idempotency key","id":"refund id, uuid format","created_at":"2023-11-07T05:31:56Z","reason":"Reason for the refund","items":[{"title":"Name of the product","quantity":1,"unit_price":"0.00","category":"Clothes","reference_id":"SKU123","description":"Description of the product","image_url":"https://example.com/","product_url":"https://example.com/","gender":"Kids","color":"white","product_material":"cotton","size_type":"EU","size":"M","brand":"Name of the Brand","is_refundable":true}]}],"meta":{"customer":"#customer-id","order_id":"#1234"},"attachment":{"body":"{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}","content_type":"application/vnd.tabby.v1+json"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b3218252-a7fb-4f18-872a-8ebd13fda306":{"description":"One of the required fields is missing or request is not formatted correctly.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"errorType":{"type":"string","example":"bad_data","uniqueKey":"errorType","typeLabel":"string"},"error":{"type":"string","example":"invalid payment id","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","errorType":"bad_data","error":"invalid payment id"}}},"exampleType":"generated"}},"exampleType":"generated"},"b3e9afe9-894f-4c25-a13e-c81df79e2d74":{"description":"The request cannot be authorized.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"errorType":{"type":"string","example":"not_authorized","uniqueKey":"errorType","typeLabel":"string"},"error":{"type":"string","example":"missing Bearer scheme","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","errorType":"not_authorized","error":"missing Bearer scheme"}}},"exampleType":"generated"}},"exampleType":"generated"},"c063a3ba-c5c9-4032-8335-7e2a4a9eab23":{"description":"You are using an incorrect ID.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"errorType":{"type":"string","example":"not_found","uniqueKey":"errorType","typeLabel":"string"},"error":{"type":"string","example":"no such payment","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","errorType":"not_found","error":"no such payment"}}},"exampleType":"generated"}},"exampleType":"generated"},"158d6a03-4571-4868-a616-d5c9ab59645a":{"description":"Something bad happened. We're notified.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"errorType":{"type":"string","example":"internal","uniqueKey":"errorType","typeLabel":"string"},"error":{"type":"string","example":"Internal Server Error","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","errorType":"internal","error":"Internal Server Error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"17c4d33f-ce9e-4276-b33f-6371b39fd4c2":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003csecret_key>`, where `\u003csecret_key>` is your `secret_key`.\n","scopes":["secret_key"]}}},"servers":{"7d7c4395-25e2-4a21-baba-1d9524afd8d7":{"url":"https://api.tabby.ai/","description":"Production (UAE)"},"f6a4d9f7-9247-43bd-896a-c4e6012edea7":{"url":"https://api.tabby.sa/","description":"Production (KSA)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003csecret_key>`, where `\u003csecret_key>` is your `secret_key`.\n","scopes":["secret_key"]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003csecret_key>`, where `\u003csecret_key>` is your `secret_key`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"tabby-26277sa","siteName":"Tabby","title":"Retrieve a payment - Tabby","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/payments/retrieve-a-payment","matchLevel":0},"ar":{"href":"/ar/marketing/toolkit","matchLevel":4}}},"lastModified":"2026-06-11T10:47:00.428Z","originalFileLocation":"api-reference/payments/retrieve-a-payment.mdx","locale":"en"},"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=\"light\"}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=\"description\" content=\"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tabby\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_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/tabby-26277sa/w0O5YG5GGUzj-5B0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a payment - Tabby\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tabby\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tabby-26277sa.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Retrieve+a+payment\u0026amp;description=Retrieves+the+specified+payment.+Returns+the+entire+payment+object%2C+including+the+payment+Status%2C+Captures+and+Refunds+objects.\u0026amp;theme=4e6fe71b00c6800bb4092db9\u0026amp;signature=9d93fbbdedc4f06df474ed989f94bb348b7998751f6c181c661ca8f7a3b84e21\">\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=\"Retrieve a payment - Tabby\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tabby-26277sa.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Retrieve+a+payment\u0026amp;description=Retrieves+the+specified+payment.+Returns+the+entire+payment+object%2C+including+the+payment+Status%2C+Captures+and+Refunds+objects.\u0026amp;theme=4e6fe71b00c6800bb4092db9\u0026amp;signature=9d93fbbdedc4f06df474ed989f94bb348b7998751f6c181c661ca8f7a3b84e21\">\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/tabby-26277sa/w0O5YG5GGUzj-5B0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tabby\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#41A854\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/retrieve-a-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tabby.sa/#organization\",\"name\":\"Tabby\",\"url\":\"https://docs.tabby.sa\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tabby-26277sa/VGR1VunycMFYW0gO/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=VGR1VunycMFYW0gO\u0026q=85\u0026s=0fd2a3090f99185f666929e20a7504a4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tabby.sa#website\",\"name\":\"Tabby\",\"url\":\"https://docs.tabby.sa\",\"publisher\":{\"@id\":\"https://docs.tabby.sa/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment#webpage\",\"url\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment\",\"name\":\"Retrieve a payment\",\"description\":\"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\",\"dateModified\":\"2026-06-11T10:47:00.428Z\",\"isPartOf\":{\"@id\":\"https://docs.tabby.sa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tabby\",\"item\":\"https://docs.tabby.sa\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a payment\",\"item\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment#apireference\",\"headline\":\"Retrieve a payment\",\"name\":\"Retrieve a payment\",\"description\":\"Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects.\",\"url\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tabby.sa/api-reference/payments/retrieve-a-payment#webpage\"},\"dateModified\":\"2026-06-11T10:47:00.428Z\",\"publisher\":{\"@id\":\"https://docs.tabby.sa/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tabby.sa#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tabby\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tabby","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction/what-is-tabby"}]},{"tab":"API Playground","groups":[{"group":"API Playground","pages":[{"title":"API Reference Documentation","href":"/api-reference/overview"},{"title":"API Error Codes","sidebarTitle":"Error codes","href":"/api-reference/response-codes"}]},{"group":"Checkout","pages":[{"openapi":"post /api/v2/checkout","title":"Create a session","href":"/api-reference/checkout/create-a-session"},{"title":"Session creation payload model","description":null,"href":"/api-reference/checkout/session-payload-model"}]},{"group":"Payments","pages":[{"openapi":"get /api/v2/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payments/retrieve-a-payment"},{"openapi":"put /api/v2/payments/{id}","title":"Update a payment","description":"Updates the reference_id. You can only use this endpoint to update this 1 field. If you send other fields in the request, they will simply be ignored by tabby. The payment to be updated can have a status of AUTHORIZED or CLOSED.","href":"/api-reference/payments/update-a-payment"},{"openapi":"post /api/v2/payments/{id}/captures","title":"Capture a payment","href":"/api-reference/payments/capture-a-payment"},{"openapi":"post /api/v2/payments/{id}/refunds","title":"Refund a payment","href":"/api-reference/payments/refund-a-payment"},{"openapi":"post /api/v2/payments/{id}/close","title":"Close a payment","href":"/api-reference/payments/close-a-payment"},{"openapi":"get /api/v2/payments","title":"List of all payments","href":"/api-reference/payments/list-of-all-payments"}]},{"group":"Webhooks","pages":[{"openapi":"post /api/v1/webhooks","title":"Register a webhook","href":"/api-reference/webhooks/register-a-webhook"},{"openapi":"get /api/v1/webhooks","title":"Retrieve all webhooks","href":"/api-reference/webhooks/retrieve-all-webhooks"},{"openapi":"get /api/v1/webhooks/{id}","title":"Retrieve a webhook","href":"/api-reference/webhooks/retrieve-a-webhook"},{"openapi":"put /api/v1/webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"delete /api/v1/webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"}]},{"group":"Dispute Webhooks","pages":[{"openapi":"post /api/v1/dispute-webhooks","title":"Register a dispute webhook","href":"/api-reference/dispute-webhooks/register-a-dispute-webhook"},{"openapi":"get /api/v1/dispute-webhooks","title":"Retrieve all dispute webhooks","href":"/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks"},{"openapi":"get /api/v1/dispute-webhooks/{id}","title":"Retrieve a dispute webhook","href":"/api-reference/dispute-webhooks/retrieve-a-dispute-webhook"},{"openapi":"put /api/v1/dispute-webhooks/{id}","title":"Update a dispute webhook","href":"/api-reference/dispute-webhooks/update-a-dispute-webhook"},{"openapi":"delete /api/v1/dispute-webhooks/{id}","title":"Remove a dispute webhook","href":"/api-reference/dispute-webhooks/remove-a-dispute-webhook"}]},{"group":"Disputes","pages":[{"openapi":"get /api/v1/disputes","title":"Get disputes list","href":"/api-reference/disputes/get-disputes-list"},{"openapi":"get /api/v1/disputes/{disputeId}","title":"Get dispute by id","href":"/api-reference/disputes/get-dispute-by-id"},{"openapi":"post /api/v1/disputes/{disputeId}/provide-evidence","title":"Provide evidence for a dispute","href":"/api-reference/disputes/provide-evidence"},{"openapi":"post /api/v1/disputes/approve","title":"Approve disputes","href":"/api-reference/disputes/approve-disputes"},{"openapi":"post /api/v1/disputes/challenge","title":"Challenge disputes","href":"/api-reference/disputes/challenge-disputes"},{"openapi":"post /api/v1/disputes/attachments/upload","title":"Upload attachment","href":"/api-reference/disputes/upload-attachment"}]}]},{"tab":"Marketing Toolkit","pages":[{"title":"Marketing Toolkit","href":"/marketing/toolkit"}]}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/marketing/toolkit"}]}]},"title":"Retrieve a payment - Tabby","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}