An Express Checkout session is a session where the end user will submit a
shipping address and then select a shipping option before the before a
payment method is selected and the payment is initiated.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Dintero Documentation","colors":{"primary":"#0000FF","light":"#3578e5","dark":"#3578e5"},"logo":{"light":"https://mintcdn.com/dintero-c3a7bfec/D0VX9t09zInvinnk/mintlify-docs/images/light.svg?fit=max\u0026auto=format\u0026n=D0VX9t09zInvinnk\u0026q=85\u0026s=b4717f47bb69fef03f724e6356c03726","dark":"https://mintcdn.com/dintero-c3a7bfec/D0VX9t09zInvinnk/mintlify-docs/images/dark.svg?fit=max\u0026auto=format\u0026n=D0VX9t09zInvinnk\u0026q=85\u0026s=54190188f57c764d58061d5a470ad0a4"},"favicon":"https://mintcdn.com/dintero-c3a7bfec/D0VX9t09zInvinnk/mintlify-docs/images/favicon.png?fit=max\u0026auto=format\u0026n=D0VX9t09zInvinnk\u0026q=85\u0026s=25b7eac359342dc0dabf40fe08ea8cad","api":{"params":{"expanded":"closed"},"examples":{"defaults":"required","languages":["curl","python","javascript","go","java"]},"url":"full"},"appearance":{"default":"light"},"background":{"color":{"dark":"#171717"}},"navbar":{"links":[{"icon":"/mintlify-docs/assets/icons/external-link.svg","href":"https://checkout.demo.dintero.com/","label":"Demo Store"}],"primary":{"type":"button","label":"Get Started","href":"https://onboarding.dintero.com/"}},"seo":{"metatags":{"canonical":"https://docs.dintero.com"}},"integrations":{"cookies":{"key":"cookie_consent","value":"accepted"}},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dintero-c3a7bfec","hasAudioNarration":false,"actualSubdomain":"dintero-c3a7bfec","customDomains":["docs.dintero.com"],"gitSource":{"type":"github","owner":"dintero","repo":"api-spec","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af339d41661757f0de2e92a","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":242},{"language":"default","tag":"Payments","count":169},{"language":"default","tag":"Loyalty \u0026 Virtual Cards","count":113},{"language":"default","tag":"Documentation","count":105},{"language":"default","tag":"Partners","count":42},{"language":"default","tag":"Order Management","count":40},{"language":"default","tag":"Developer Resources","count":37},{"language":"default","tag":"Plugins \u0026 Integrations","count":32},{"language":"default","tag":"Support","count":22},{"language":"default","tag":"Payment Methods","count":19}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@dintero.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"mintlify-docs/styles.css","content":".dark #topbar-cta-button span{color:#fff}.method-pill~div .group{margin-left:0!important}@media (min-width: 1280px){#content-container:has(#api-playground-2-operation-page){display:grid!important;grid-template-columns:1fr 28rem!important;gap:0 3rem!important}#content-container:has(#api-playground-2-operation-page)>#content-area{display:contents!important}#api-playground-2-operation-page{display:contents!important}#api-playground-2-operation-page>.space-y-4{display:contents!important}#content-container:has(#api-playground-2-operation-page)>#content-area>*{grid-column:1!important}#content-container:has(#api-playground-2-operation-page)>#content-area>#header{grid-column:1 / -1!important;grid-row:1!important}#api-playground-2-operation-page .border-standard.rounded-2xl{grid-column:1 / -1!important;grid-row:2!important;margin-top:1.5rem!important}#api-playground-2-operation-page .max-h-\\[30rem\\]{display:none!important}#api-playground-2-operation-page>.mdx-content{grid-column:1!important;grid-row:3!important}#content-container:has(#api-playground-2-operation-page)>#content-side-layout{grid-column:2!important;grid-row:3!important;position:sticky!important;top:9.5rem!important;align-self:start!important;max-height:calc(100vh - 11rem)!important;height:auto!important;width:28rem!important;max-width:28rem!important;margin-top:2rem!important;gap:2rem!important}#content-container:has(#api-playground-2-operation-page) #pagination{grid-row:4!important}#content-container:has(#api-playground-2-operation-page) #footer{margin-top:3rem!important;grid-row:5!important}}#content-container:has(#api-playground-2-operation-page) #header p,#content-container:has(#api-playground-2-operation-page) #header a{margin-top:0!important;margin-bottom:12px!important;padding-top:0!important;padding-bottom:0!important;font-size:16px}#content-container:has(#api-playground-2-operation-page) #header ol,#content-container:has(#api-playground-2-operation-page) #header ul,#content-container:has(#api-playground-2-operation-page) #header li{margin-top:6px!important;margin-bottom:8px!important;padding-top:0!important;padding-bottom:0!important;font-size:16px}#content-container:has(#api-playground-2-operation-page) #header h2,#content-container:has(#api-playground-2-operation-page) #header h3,#content-container:has(#api-playground-2-operation-page) #header h4{margin-top:16px!important}#content-container:has(#api-playground-2-operation-page) #header hr{margin:20px 0!important}#content-container h2{margin-bottom:6px}.product-link span{color:var(--tw-prose-links);text-decoration:none;font-weight:600;border-bottom:1px solid rgb(var(--primary));word-wrap:break-word}.dark .product-link span{border-bottom-color:rgb(var(--primary-light))}.product-link:hover span{border-bottom-width:2px}.dark img[src*=\"/mintlify-docs/assets/icons/\"][src*=\".svg\"]{filter:brightness(0) invert(1)}"},{"filePath":"mintlify-docs/logo-display-builder.css","content":":root{--default-radius:8px;--text-paragraph-lg-line-height:28px;--text-paragraph-lg-font-size:18px;--text-paragraph-md-line-height:24px;--text-paragraph-md-font-size:16px;--text-paragraph-sm-line-height:20px;--text-paragraph-sm-font-size:14px;--text-paragraph-xs-line-height:20px;--text-paragraph-xs-font-size:12px;--text-overline-letter-spacing:1px;--text-overline-text-transform:uppercase;--text-overline-font-weight:600;--shadow-xs:0px 1px 2px 0px rgba(16, 24, 40, 0.1);--shadow-sm:0px 1px 3px 0px rgba(16, 24, 40, 0.1),\n\t\t0px 1px 2px 0px rgba(16, 24, 40, 0.06);--shadow-md:0px 4px 6px -1px rgba(16, 24, 40, 0.1),\n\t\t0px 2px 4px -1px rgba(16, 24, 40, 0.06);--shadow-lg:0px 10px 15px -3px rgba(16, 24, 40, 0.1),\n\t\t0px 4px 6px -2px rgba(16, 24, 40, 0.05);--shadow-xlg:0px 8px 10px -6px rgba(16, 24, 40, 0.1),\n\t\t0px 20px 25px -5px rgba(16, 24, 40, 0.1);--blur-none:none;--blur-sm:blur(4px);--blur-md:blur(8px);--blur-lg:blur(12px);--blur-xl:blur(20px);--spacing-xxs:4px;--spacing-xs:8px;--spacing-sm:16px;--spacing-md:24px;--spacing-lg:32px;--spacing-xlg:40px;--spacing-xxlg:48px;--spacing-xxxlg:56px;--spacing-xxxxlg:64px;--border-radius-sm:4px;--border-radius-md:8px;--border-radius-lg:12px;--border-radius-xlg:16px;--border-radius-xxlg:20px;--color-primary-50:#f2f6ff;--color-primary-100:#d9e4ff;--color-primary-200:#bfd1ff;--color-primary-300:#a6baff;--color-primary-400:#6889fe;--color-primary-500:#0000ff;--color-primary-600:#0000df;--color-primary-700:#0000bf;--color-primary-800:#000080;--color-primary-900:#000040;--color-neutral-50:#fafafa;--color-neutral-100:#f5f5f5;--color-neutral-200:#e5e5e5;--color-neutral-300:#d4d4d4;--color-neutral-400:#a3a3a3;--color-neutral-500:#737373;--color-neutral-600:#525252;--color-neutral-700:#404040;--color-neutral-800:#262626;--color-neutral-900:#171717;--color-destructive-50:#fef2f2;--color-destructive-100:#fee2e2;--color-destructive-200:#fecaca;--color-destructive-300:#fca5a5;--color-destructive-400:#f87171;--color-destructive-500:#ef4444;--color-destructive-600:#dc2626;--color-destructive-700:#b91c1c;--color-destructive-800:#991b1b;--color-destructive-900:#7f1d1d;--color-success-50:#f0fdf4;--color-success-100:#dcfce7;--color-success-200:#bbf7d0;--color-success-300:#86efac;--color-success-400:#4ade80;--color-success-500:#22c55e;--color-success-600:#16a34a;--color-success-700:#15803d;--color-success-800:#166534;--color-success-900:#14532d;--color-warning-50:#fffbeb;--color-warning-100:#fef3c7;--color-warning-200:#fde68a;--color-warning-300:#fcd34d;--color-warning-400:#fbbf24;--color-warning-500:#f59e0b;--color-warning-600:#d97706;--color-warning-700:#b45309;--color-warning-800:#92400e;--color-warning-900:#78350f;--color-surface:white;--color-code-surface:var(--color-neutral-900)}@media (prefers-color-scheme: dark){:root{--color-surface:#1f1f1f;--color-code-surface:#0a0a0a;--color-neutral-50:#171717;--color-neutral-100:#1f1f1f;--color-neutral-200:#292929;--color-neutral-300:#404040;--color-neutral-400:#737373;--color-neutral-500:#a3a3a3;--color-neutral-600:#d4d4d4;--color-neutral-700:#e5e5e5;--color-neutral-800:#f5f5f5;--color-neutral-900:#fafafa;--color-primary-50:#0d0d33;--color-primary-100:#1a1a5c;--color-success-50:#0a1a0f;--color-success-100:#0f2a15;--shadow-xs:0px 1px 2px 0px rgba(0, 0, 0, 0.4);--shadow-sm:0px 1px 3px 0px rgba(0, 0, 0, 0.4), 0px 1px 2px 0px rgba(0, 0, 0, 0.3);--shadow-md:0px 4px 6px -1px rgba(0, 0, 0, 0.4), 0px 2px 4px -1px rgba(0, 0, 0, 0.3);--shadow-lg:0px 10px 15px -3px rgba(0, 0, 0, 0.4), 0px 4px 6px -2px rgba(0, 0, 0, 0.2)}}"}],"page":{"pagePath":"checkout-api/view/checkout_sid_json_order_discount_codes_put","slug":"/checkout-api/view/checkout_sid_json_order_discount_codes_put","pageMetadata":{"title":"Set Express Checkout discount codes","description":"Changes the `order.discount_codes` submitted by end user in the Express Checkout flow.\n\nIf the _`express.discount_codes_callback_url`_ is set, the session will be\nupdated with discount on the order and the shipping options.\n","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout discount codes","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/discount_codes","href":"/checkout-api/view/checkout_sid_json_order_discount_codes_put","autogeneratedByOpenApi":true,"hidden":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n em: \"em\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Changes the \", _jsx(_components.code, {\n children: \"order.discount_codes\"\n }), \" submitted by end user in the Express Checkout flow.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the \", _jsx(_components.em, {\n children: _jsx(_components.code, {\n children: \"express.discount_codes_callback_url\"\n })\n }), \" is set, the session will be\\nupdated with discount on the order and the shipping options.\"]\n })]\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":{"config":{},"pageMetadata":{"title":"Set Express Checkout discount codes","description":"Changes the `order.discount_codes` submitted by end user in the Express Checkout flow.\n\nIf the _`express.discount_codes_callback_url`_ is set, the session will be\nupdated with discount on the order and the shipping options.\n","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout discount codes","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/discount_codes","href":"/checkout-api/view/checkout_sid_json_order_discount_codes_put","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dintero-c3a7bfec/0c27980f89959f8a/scripts/extract-refs.js","/_mintlify/custom/dintero-c3a7bfec/9be648d34348ecd1/scripts/openapi3/convert-to-oa3.js","/_mintlify/custom/dintero-c3a7bfec/acc74eb2f1533c09/scripts/openapi3/convert-to-oa3.test.js","/_mintlify/custom/dintero-c3a7bfec/d1577eed3797a41e/mintlify-docs/cookie-script.js","/_mintlify/custom/dintero-c3a7bfec/ad1f40ff54bd5bfe/mintlify-docs/logo-display-builder.js","/_mintlify/custom/dintero-c3a7bfec/9b750c905d163779/scripts/openapi3/build-operation-map.js","/_mintlify/custom/dintero-c3a7bfec/92de388c069f1bef/scripts/check-broken-links.js","/_mintlify/custom/dintero-c3a7bfec/8ad753e6099cf1b7/scripts/openapi3/build-operation-map.test.js"],"openApiReferenceData":{"operation":{"operationId":"checkout_sid_json_order_discount_codes_put","summary":"checkout_sid_json_order_discount_codes_put","description":"Changes the `order.discount_codes` submitted by end user in the Express Checkout flow.\n\nIf the _`express.discount_codes_callback_url`_ is set, the session will be\nupdated with discount on the order and the shipping options.\n","tags":["view"],"security":[],"parameters":["bebc2a8c-0b2f-4a86-8de0-ae19b29f0abe","91581fc2-ec8c-4a78-a741-7b149cf517a4"],"requestBody":"5b42840d-5d84-4462-ae64-d67f5ed00079","responses":{"200":"e19a0ba0-6c89-4f04-a11f-bd5d16cebffb","204":"b81cb56c-983a-41b8-a63e-eeca70c4430d","404":"c6a0f754-9a71-4f46-ac88-468663cc9192","412":"802ffeb0-6d7f-443f-aed4-daa7188c9baa","500":"fceacff4-5edb-4fdd-abd1-d7e0f9b8f9d6"},"x-mint":{"metadata":{"title":"Set Express Checkout discount codes","sidebarTitle":"Set Express Checkout discount codes"}},"method":"put","type":"path","servers":["24a0cbf3-ae62-426f-9fc5-c08574a6062f"],"path":"/view/{session_id}/session/order/discount_codes","baseUrlOptions":["https://checkout.dintero.com/v1"],"title":"checkout_sid_json_order_discount_codes_put","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go","java"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"bebc2a8c-0b2f-4a86-8de0-ae19b29f0abe":{"name":"session_id","in":"path","description":"The session ID","required":true,"schema":{"type":"string","format":"checkout-id","isRequired":true,"description":"The session ID","uniqueKey":"","typeLabel":"string\u003ccheckout-id>"}},"91581fc2-ec8c-4a78-a741-7b149cf517a4":{"name":"If-Unmodified-Since","in":"header","description":"Optional header. The put request is discarded and a 412 is returned if the header does not match the `updated_at` property of the session.","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional header. The put request is discarded and a 412 is returned if the header does not match the `updated_at` property of the session.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"discount_codes":{"type":"array","items":{"type":"string","uniqueKey":"discount_codes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"discount_codes","typeLabel":"string[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"discount_codes":["\u003cstring>"]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"e19a0ba0-6c89-4f04-a11f-bd5d16cebffb":{"description":"Session updated with discounts","content":{"application/json":{"schema":{"type":"object","required":["configuration","order","url"],"properties":{"url":{"type":"object","required":["return_url"],"properties":{"return_url":{"type":"string","format":"uri","example":"https://example.com/accept","description":"URL to page where Checkout will redirect the\ncustomer to after the Checkout process has ended.\n\nIf a transaction was completed successfully, a `transaction_id`\nwill be appended to the URL as a `query` string parameter\n\n> A `transaction_id` will be appended to the URL if the\n> Checkout failed with `error=capture`\n\n> A transaction with status `ON_HOLD` must be handled as a payment\n> that is pending approval, where the transaction will later be updated\n> with a final payment staus `AUTHORIZED` or `FAILED`.\n> We recommend that `callback_url` is used to receive the callback when\n> the transaction changes status from `ON_HOLD` to `AUTHORIZED` or `FAILED`.\n> Alternative is to do an hourly/daily poll on the transaction to check\n> if the status has changed.\n\n*Example*:\n\n ```\n https://example.com/accept?transaction_id=T00000000.3YkJXSdSnUBXcmQSzn7uJj\n ```\n\n query name | type | description | required\n------------------ | :----------: | ------------------------------ | :-----------:\ntransaction_id | string | Transaction Id | false\nerror | string | Error code identifying cause | false\nmerchant_reference | string | The merchants reference | true\n\nIn case of that something went wrong with the payment flow, an\n`error` query parameter will be appended to the URL. The value\nof the error is a code identifying the cause.\n\nerror | Description\n------------- | ------------\ncancelled | Customer cancelled the checkout payment\nauthorization | Customer failed to authorize the payment\nfailed | The transaction has been rejected by us, or an error has occurred during transaction processing\n\n### configuration.channel=in_app\n\nThe `in_app` channel is intended for payments done from mobile devices\nwhere `url.return_url` can be set to the application's appswitch URL.\n\n#### initial_recipient=merchant\n\nIf the query-param `initial_recipient=merchant` is appended to the\nappswitch URL, the payment app will switch directly to the app,\ni.e. without doing a redirect.\n\n**The option is not supported for:**\n\n- payex.vipps\n- payex.swish\n- bambora.mobilepay\n\nFollowing query parameters will be added to the `return_url`\n\n query name | type | description | required\n------------------------- | :----------: | ------------------------------ | :-----------:\ntransaction_id | string | Transaction Id | false\nsession_id | string | Session Id | false\nerror | string | Error code identifying cause | false\npayment_return_url | string | Redirect URL to Dintero API | false\nmerchant_reference | string | The merchants reference | true\n\nIf the `payment_return_url` is present, you can use it to get a url containing the `session_id`\nor `transaction_id`. `payment_return_url` will only be present when `configuration.channel=in_app`\nand `initial_recipient=merchant` is appended on the appswitch URL.\n\n> The `payment_return_url` may initially return `202 Accepted` if the\n> payment confirmation is not ready yet.\n> Once ready, a `302 Found` redirect is returned to the `return_url`\n\nYou will in this case be required to poll for status on the payment by using the\n`session_id` or `transaction_id` to poll from the endpoints:\n\n- [GET /v1/sessions/{session_id}](/api-reference/default/checkout_session_get)\n- [GET /v1/transactions/{transaction_id}](/api-reference/default/transactions_id_get)\n\nPoll the transaction until it has been updated with one of these statuses:\n\n- AUTHORIZED\n- CAPTURED\n- FAILED\n\nIn case no `transaction_id` is included in the return url, poll the\nsession to get the `transaction_id`\n\nExample url: `myapp://?initial_recipient=merchant\u0026transaction_id=T12345678.abc\u0026merchant_reference=mref123\u0026session_id=T12345678.abd`\n","isRequired":true,"uniqueKey":"url.return_url","typeLabel":"string\u003curi>"},"callback_url":{"type":"string","format":"uri","pattern":"https?://*","example":"https://example.com/callback?method=GET","description":"URL that Checkout will call when the session\npayment is complete and the transaction has been authorized.\n\n> **Callback is only delivered to HTTPS URLs**\n\n> A callback done with a transaction with status `ON_HOLD` will receive\n> an aditional callback (later) when the transaction state changes status\n> from `ON_HOLD`.\n\n> The callback may be received after the transaction is `CAPTURED`\n> in case when the transaction was created from a session where\n> `auto_capture` was enabled.\n\nUnlike the `return_url` the `callback_url` is system-to-system\nwhich means delivery is guaranteed.\n\nOnce a session payment is complete the callback_url is invoked as a\n`GET` request to notify your system that the payment has been approved.\n\n- A callback_url with `method=POST` query parameter will be invoked as a\n `POST` request with the transaction included in the request body.\n\n- A callback_url with `report_error=true` will enable the callback_url\n to be called if the payment failed with error `cancelled`, `authorization`\n or `failed`.\n\n- A callback_url with `delay_callback=\u003cseconds>` will delay the callback\n before trying to deliver the callback. The **maximum** delay is 60 seconds.\n\n- A callback_url with `report_event={EVENT}` will enable the callback_url\n to be called if a payment event has been applied to the transaction. Valid\n values are `CAPTURE`, `REFUND` and `VOID`. The callback_url can contain\n multiple `report_event` query parameters. An `event` query parameter will be\n included in the request sent to the callback_url.\n\n- A callback_url with `includes=session` will enable the callback_url\n to include the session data in the body.\n\n- A callback_url with `sid_parameter_name=sid` will change the query param `session_id`\n to `sid` to avoid false session fixation alarms in firewalls. Possible values: `sid`, `session_id`\n\nA successful delivery to an HTTPS callback_url sometimes requires\nmore than one attempt. This can be the case, for example, if the server\nhosting the callback_url is down for maintenance or is experiencing\nheavy traffic.\n\nDintero attempts a retry only after a failed delivery attempt, following\nsituations is considered as failed delivery\n\n - HTTP status code 100 to 101 and 500 to 599 (inclusive)\n (HTTP status code 400 to 499 is considered as permanent failure)\n - A request timeout (10 seconds)\n - Any connection error such as connection timeout, bad certificate, etc\n\nFailed delivery will be retried 20 times.\n\n query name | type | description | required\n------------------ | :-----------: | :--------------------------- | :-----------\ntransaction_id | string | Transaction Id | true\nsession_id | string | Session Id | true\nsid | string | Session Id when sid_parameter_name=sid | true\nmerchant_reference | string | The merchants reference | true\ntime | string | ISO 8601 format | true\nerror | string | Error code | false\nevent | string | event applied | false\nevent_id | string | event id for callback | false\nincludes | string array | include additional data | false\n\n> The transaction_id is optional when callback_url enables `report_error`\n> where error query will be included in case where the payment was completed\n> without creating an authorized transaction.\n\n> It is not possible to use `https://localhost` or `http://127.0.0.1` for\n> the callback URL as Checkout backend would then call itself.\n\nSee [validating callbacks](https://docs.dintero.com/docs/checkout/validating-callbacks) to see how you can verify the integrity of the callbacks,\n","uniqueKey":"url.callback_url","typeLabel":"string\u003curi>"},"merchant_terms_url":{"type":"string","format":"uri","pattern":"https?://*","example":"https://example.com/terms.html","description":"URL to a webpage with the merchant's Terms of Service. Will be linked to from the checkout.\n","uniqueKey":"url.merchant_terms_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"url","typeLabel":"object"},"order":{"type":"object","required":["amount","currency","merchant_reference"],"properties":{"amount":{"type":"integer","format":"int32","example":72200,"description":"The amount to authorize/capture including VAT and discounts.\nIn smallest unit for the currency, e.g. cents\n\nThe `amount` should be equal to the sum of the `items.amount` + `shipping_option.amount`.\n","isRequired":true,"uniqueKey":"order.amount","typeLabel":"integer\u003cint32>"},"currency":{"type":"string","format":"iso4217-code","example":"NOK","description":"The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217","isRequired":true,"uniqueKey":"order.currency","typeLabel":"string\u003ciso4217-code>"},"merchant_reference":{"type":"string","description":"A reference by the merchant to identify the corresponding\norder for the Checkout Session\n\n#### Kravia\nWhen Kravia is enabled and `merchant_reference_2` is not set,\nthis value is used as the Kravia case reference and must be\nat most 35 characters.\n","isRequired":true,"uniqueKey":"order.merchant_reference","typeLabel":"string"},"vat_amount":{"type":"integer","format":"int32","example":13660,"description":"The VAT of the `amount` parameter.\nOnly used for display purposes.\n\nIn smallest unit for the currency, e.g. cents\n\nThe `vat_amount` should be equal to the sum of the `items.vat_amount` + `shipping_option.vat_amount`.\n","uniqueKey":"order.vat_amount","typeLabel":"integer\u003cint32>"},"merchant_reference_2":{"type":"string","description":"A reference by the merchant to identify the corresponding\norder for the Checkout Session\n\n#### Kravia\nWhen Kravia is enabled and `merchant_reference_2` is set, it\ntakes precedence over `merchant_reference` as the Kravia case\nreference and must be at most 35 characters.\n","uniqueKey":"order.merchant_reference_2","typeLabel":"string"},"event_reference":{"type":"string","description":"Default event_reference to include in transaction events. The value is included\nin the settlement report\n\nUse of `capture_reference` and `refund_reference` during capture and refund\noverrides the provided value\n","uniqueKey":"order.event_reference","typeLabel":"string"},"shipping_address":{"type":"object","description":"Address","properties":{"first_name":{"type":"string","example":"John","uniqueKey":"order.shipping_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"order.shipping_address.last_name","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","uniqueKey":"order.shipping_address.address_line","typeLabel":"string"},"address_line_2":{"type":"string","description":"PB 123","uniqueKey":"order.shipping_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","example":"Land Lord","uniqueKey":"order.shipping_address.co_address","typeLabel":"string"},"business_name":{"type":"string","description":"Name of the company","uniqueKey":"order.shipping_address.business_name","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","uniqueKey":"order.shipping_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","uniqueKey":"order.shipping_address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso3166-alpha2","description":"Country of the location","example":"NO","uniqueKey":"order.shipping_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","pattern":"^\\+?\\d{5,15}$","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","uniqueKey":"order.shipping_address.phone_number","typeLabel":"string"},"email":{"type":"string","description":"The email address of a person or an organization\n","uniqueKey":"order.shipping_address.email","typeLabel":"string"},"latitude":{"type":"number","uniqueKey":"order.shipping_address.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"order.shipping_address.longitude","typeLabel":"number"},"comment":{"type":"string","description":"Comment about the address\n","uniqueKey":"order.shipping_address.comment","typeLabel":"string"},"organization_number":{"type":"string","description":"The organization number of the customer.\n","uniqueKey":"order.shipping_address.organization_number","typeLabel":"string"},"organization_type":{"type":"string","description":"Type indicating what kind of organization it is.\n","uniqueKey":"order.shipping_address.organization_type","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference\n\n#### Kravia\nWhen Kravia is enabled, `billing_address.customer_reference` must\nbe at most 30 characters.\n","uniqueKey":"order.shipping_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","uniqueKey":"order.shipping_address.cost_center","typeLabel":"string"}},"uniqueKey":"order.shipping_address","typeLabel":"object"},"billing_address":{"type":"object","description":"Address","properties":{"first_name":{"type":"string","example":"John","uniqueKey":"order.billing_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"order.billing_address.last_name","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","uniqueKey":"order.billing_address.address_line","typeLabel":"string"},"address_line_2":{"type":"string","description":"PB 123","uniqueKey":"order.billing_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","example":"Land Lord","uniqueKey":"order.billing_address.co_address","typeLabel":"string"},"business_name":{"type":"string","description":"Name of the company","uniqueKey":"order.billing_address.business_name","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","uniqueKey":"order.billing_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","uniqueKey":"order.billing_address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso3166-alpha2","description":"Country of the location","example":"NO","uniqueKey":"order.billing_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","pattern":"^\\+?\\d{5,15}$","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","uniqueKey":"order.billing_address.phone_number","typeLabel":"string"},"email":{"type":"string","description":"The email address of a person or an organization\n","uniqueKey":"order.billing_address.email","typeLabel":"string"},"latitude":{"type":"number","uniqueKey":"order.billing_address.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"order.billing_address.longitude","typeLabel":"number"},"comment":{"type":"string","description":"Comment about the address\n","uniqueKey":"order.billing_address.comment","typeLabel":"string"},"organization_number":{"type":"string","description":"The organization number of the customer.\n","uniqueKey":"order.billing_address.organization_number","typeLabel":"string"},"organization_type":{"type":"string","description":"Type indicating what kind of organization it is.\n","uniqueKey":"order.billing_address.organization_type","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference\n\n#### Kravia\nWhen Kravia is enabled, `billing_address.customer_reference` must\nbe at most 30 characters.\n","uniqueKey":"order.billing_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","uniqueKey":"order.billing_address.cost_center","typeLabel":"string"}},"uniqueKey":"order.billing_address","typeLabel":"object"},"partial_payment":{"type":"boolean","default":false,"description":"This is a partial payment where the `order.amount` can be lower or\nequal to the sum of `order.items.amount`\n","uniqueKey":"order.partial_payment","typeLabel":"boolean"},"items":{"type":"array","description":"Details about the order items. A maximum of 100 items are allowed. If providing items with `splits` - a maximum total of 200 `splits` are allowed in total across all items.\n\n#### Instabank\n`required` if Instabank payment is configured in and partial_payment is false.\nAll items must include a unique `line_id`, quantity and amount\n\n#### Collector Bank\n`required` if Collector Bank payment is configured in and partial_payment is false.\nAll items must include a unique `line_id`, quantity and amount\n","items":{"type":"object","description":"Discount details for an order item","properties":{"id":{"type":"string","description":"The ID or SKU of the product on the line\n","example":"item_01","uniqueKey":"order.\\items.items.[INDEX].id","typeLabel":"string"},"groups":{"type":"array","description":"The groups the product on the line belongs to\n","example":[{"id":"B234","name":"Stol"}],"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Group ID","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].groups.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Group name","uniqueKey":"order.\\items.items.[INDEX].groups.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].groups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].groups","typeLabel":"object[]"},"line_id":{"type":"string","description":"the number of the line (or id), must be `unique` between\nall items. `required` when Instabank payment is configured.\n","example":"1","uniqueKey":"order.\\items.items.[INDEX].line_id","typeLabel":"string"},"version":{"type":"number","readOnly":true,"description":"The version where the item was added or last updated, see the\nevents for the source.\n","uniqueKey":"order.\\items.items.[INDEX].version","typeLabel":"number"},"description":{"type":"string","description":"A short, localized description of the line item\n","example":"Stablestol","uniqueKey":"order.\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"number","description":"The quantity of the product in the item line.\n\nQuantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations.\n","example":1,"uniqueKey":"order.\\items.items.[INDEX].quantity","typeLabel":"number"},"amount":{"type":"integer","description":"The total monetary amount of the line item, including VAT and discounts.\n\nIn smallest unit for the currency, e.g. cents\n","example":2000,"uniqueKey":"order.\\items.items.[INDEX].amount","typeLabel":"integer"},"vat_amount":{"type":"integer","description":"The VAT of the `amount` parameter. Only\nused for display purposes.\n\nIn smallest unit for the currency, e.g. cents\n","example":400,"uniqueKey":"order.\\items.items.[INDEX].vat_amount","typeLabel":"integer"},"vat":{"type":"number","description":"The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2.\n","example":20,"uniqueKey":"order.\\items.items.[INDEX].vat","typeLabel":"number"},"unit_volume":{"type":"number","description":"The volume of one item in m³ (cubic meters)\n","uniqueKey":"order.\\items.items.[INDEX].unit_volume","typeLabel":"number"},"unit_weight":{"type":"number","description":"The volume of one item in kg (kilo grams)\n","uniqueKey":"order.\\items.items.[INDEX].unit_weight","typeLabel":"number"},"unit_dimensional_weight":{"type":"number","description":"The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight)\n","uniqueKey":"order.\\items.items.[INDEX].unit_dimensional_weight","typeLabel":"number"},"type":{"type":"string","description":"The type of order item this is.\n\n- **physical** - a physical item which must be delivered or handed over\n- **digital** - a digital item which doesn't need shipping\n- **service** - payment for services like maintenance performed in your home\n- **gift_card** - usage of a gift card, where the amount is usually a negative number\n- **shipping** - payment for shipping of the order\n- **surcharge** - extra incurred costs, like taxes or necessary rounding\n- **tip** - a tip added to the order. The item's `splits` are calculated from `configuration.payout.tip_split`\n","enum":["physical","digital","service","gift_card","shipping","surcharge","tip"],"uniqueKey":"order.\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"fee_split":{"type":"object","description":"Specify how fees are handled with splits. The default behaviour is to share\nthe fees proportional with all splits destinations\n","required":["type"],"properties":{"type":{"type":"string","description":"- **`proportional`**: Fees are shared proportionally across `destinations`, weighted by each destination's split amount. Every destination must also be included in `splits`.\n- **`equal_fee_only`**: Fees are shared equally across `destinations`. These destinations must not be included in `splits` and receive no income from the order - they only accumulate fee debt.\n","enum":["proportional","equal_fee_only"],"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].fee_split.type","typeLabel":"enum\u003cstring>"},"destinations":{"type":"array","description":"Seller ids that will be debited for the payment fees.\n\n- When `type` is `proportional`, all destinations must also be included in the list of `splits`.\n- When `type` is `equal_fee_only`, destinations must not be included in `splits`. The fee is divided equally between them, and they receive no income from the order - only fee debt.\n","minItems":1,"items":{"type":"string","maxLength":40,"uniqueKey":"order.\\items.items.[INDEX].fee_split.destinations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.\\items.items.[INDEX].fee_split.destinations","typeLabel":"string[]"}},"uniqueKey":"order.\\items.items.[INDEX].fee_split","typeLabel":"object"},"splits":{"type":"array","description":"An array of objects specifying how the amount should be split between\nsellers when using Dintero Payout\n\nSpecify an empty array if the splits will be provided during capture.\n`auto_capture` cannot be enabled when splits are defined as empty array.\n","items":{"type":"object","required":["payout_destination_id","amount"],"properties":{"payout_destination_id":{"type":"string","maxLength":40,"example":"seller-1","description":"An id that identifies the seller\n\nNote: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations\n","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].splits.items.[INDEX].payout_destination_id","typeLabel":"string"},"amount":{"type":"integer","format":"int32","example":29700,"minimum":0,"description":"The split amount in smallest unit for the currency, e.g. cents.\n","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].splits.items.[INDEX].amount","typeLabel":"integer\u003cint32>"}},"uniqueKey":"order.\\items.items.[INDEX].splits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].splits","typeLabel":"object[]"},"thumbnail_url":{"type":"string","description":"URL to a thumbnail of the item. Will be displayed when redirecting to the session.\n\nRecommended limitations for the image:\n\n- all images should preferrably have the same dimensions\n- max file size should be less than 2MB\n","format":"uri","uniqueKey":"order.\\items.items.[INDEX].thumbnail_url","typeLabel":"string\u003curi>"},"emd":{"type":"object","description":"Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/).\n\nSome items require extra information to be provided when using\nKlarna as an enabled payment option.\n","properties":{"event":{"type":"array","description":"Only required if the item is related to an event or multiple events,\nlike for example tickets to a concert.\n\nIf you are selling an event package as a single ticket or item that\nincludes multiple events, for example a festival, you need to provide\ninformation about all the individual events that are part of the package.\n","items":{"type":"object","required":["event_name","event_company","genre_of_event","start_time","end_time","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"event_name":{"type":"string","description":"Name of the event, e.g. \"Fancy Singer\"","example":"Michael Jackson","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].event_name","typeLabel":"string"},"event_company":{"type":"string","description":"Name of the company arranging the event, e.g. \"Happy Parties Ltd.\"","example":"Diamond Events","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].event_company","typeLabel":"string"},"genre_of_event":{"type":"string","description":"Category or type of venue, e.g. \"Pop\"","example":"Pop","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].genre_of_event","typeLabel":"string"},"start_time":{"type":"string","format":"date-time","description":"Start time of the event (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"End time of the event (ISO 8601 format), e.g. \"2023-08-16T16:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T16:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].end_time","typeLabel":"string\u003cdate-time>"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"email","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"recipient@mail.com\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"recipient@mail.com","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"arena_name":{"type":"string","description":"Name of the venue, e.g. \"Song Arena\"","example":"Oslo Spektrum","uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_name","typeLabel":"string"},"arena_location":{"type":"object","required":["city","country"],"properties":{"city":{"type":"string","description":"City that the venue is located in, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country that the venue is located in (ISO 3166-1 alpha-2 format), e.g. \"NO\"\n","example":"NO","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address representing the venue location, e.g. \"Sonja Henies plass 2\"","example":"Sonja Henies plass 2","uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code for the venue location, e.g. \"0185\"","example":"0185","uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].arena_location","typeLabel":"object"},"access_controlled_venue":{"type":"boolean","description":"If tickets are digitally checked when entering the venue, e.g. true","example":true,"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].access_controlled_venue","typeLabel":"boolean"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.\n","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX].affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.event.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.event","typeLabel":"object[]"},"subscription":{"type":"object","description":"Only required if the item is related to a subscription.\n\nIf that is the case, you need to provide information about both the subscription\nand the customer account.\n","required":["subscription","customer_account_info"],"properties":{"subscription":{"type":"object","description":"Details related to the subscription.\n","required":["subscription_name","start_time","end_time","auto_renewal_of_subscription"],"properties":{"subscription_name":{"type":"string","description":"Name of the product on subscription, e.g. \"Contact lenses\"","example":"Contact lenses","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription.subscription_name","typeLabel":"string"},"start_time":{"type":"string","format":"date-time","description":"The start time of the subscription (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription.start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"The end time of the subscription (ISO 8601 format),\ne.g. \"2023-09-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC\n","example":"2023-09-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription.end_time","typeLabel":"string\u003cdate-time>"},"auto_renewal_of_subscription":{"type":"boolean","description":"Whether the subscription will be auto renewed upon expiry, e.g. true\n","example":true,"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription.auto_renewal_of_subscription","typeLabel":"boolean"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.\n","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription.affiliate_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.subscription","typeLabel":"object"},"customer_account_info":{"type":"object","description":"Information related to the customer that wants to purchase the subscription.\n","required":["unique_account_identifier","account_registration_date","account_last_modified"],"properties":{"unique_account_identifier":{"type":"string","description":"Unique name / number to identify the specific customer account.\nMax 24 characters, e.g. \"Adam Adamsson\"\n","example":"Adam Adamsson","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.customer_account_info.unique_account_identifier","typeLabel":"string"},"account_registration_date":{"type":"string","description":"The date and time the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.customer_account_info.account_registration_date","typeLabel":"string"},"account_last_modified":{"type":"string","description":"The date and time the account was last modified (ISO 8601 format),\ne.g. \"2023-10-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-10-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.customer_account_info.account_last_modified","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.subscription.customer_account_info","typeLabel":"object"}},"uniqueKey":"order.\\items.items.[INDEX].emd.subscription","typeLabel":"object"},"travel":{"type":"object","description":"Only required if the item is part of a travel-related transaction.\n\nIf that is the case, you need to provide information about the itinerary\nto be booked.\n","properties":{"air_reservation_details":{"type":"object","description":"Details about the reservation of airline tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one flight from Oslo to Munich,\nand another flight from Munich to Dubai, you need to provide one\nitinerary object for each of these two flights, and so on.\n","items":{"type":"object","required":["departure","arrival","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure":{"type":"string","description":"IATA Airport Code (three letters), e.g. \"OSL\"","example":"OSL","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].departure","typeLabel":"string"},"arrival":{"type":"string","description":"IATA Airport Code (three letters), e.g. \"MUC\"","example":"MUC","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].arrival","typeLabel":"string"},"carrier":{"type":"string","description":"IATA Airline standard (two letters or digits), e.g. \"LH\"","example":"LH","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\"\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"departure_city":{"type":"string","description":"City the flight departs from, e.g. \"Oslo\"","example":"Oslo","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the flight arrives in, e.g. \"Munich\"","example":"Munich","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the flight\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.air_reservation_details","typeLabel":"object"},"bus_reservation_details":{"type":"object","description":"Details about the reservation of bus tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one bus journey from Oslo to Munich,\nand another bus journey from Munich to Rome, you need to provide one\nitinerary object for each of these two bus journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure_city":{"type":"string","description":"City the bus departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the bus arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Bus Travels Ltd.\"","example":"Big Bus Travels Ltd.","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the bus journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.bus_reservation_details","typeLabel":"object"},"train_reservation_details":{"type":"object","description":"Details about the reservation of train tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one train journey from Oslo to Munich,\nand another train journey from Munich to Rome, you need to provide one\nitinerary object for each of these two train journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient","passenger_id"],"properties":{"departure_city":{"type":"string","description":"City the train departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the train arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Train Travels Ltd.\"","example":"Big Train Travels Ltd.","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"segment_price":{"type":"integer","description":"Price for that specific segment of the train journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.train_reservation_details","typeLabel":"object"},"ferry_reservation_details":{"type":"object","description":"Details about the reservation of ferry tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one ferry journey from Oslo to Kiel,\nand another ferry journey from Kiel to Gothenburg, you need to provide one\nitinerary object for each of these two ferry journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure_city":{"type":"string","description":"City the ferry departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the ferry arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Ferry Travels Ltd.\"","example":"Big Ferry Travels Ltd.","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the ferry journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.ferry_reservation_details","typeLabel":"object"},"hotel_reservation_details":{"type":"object","description":"Details about the reservation of hotel rooms.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Hotel itinerary data, one per hotel stay.\n\nIf you are selling a package that contains multiple hotel stays,\nyou need to provide itinerary data for each of the individual stays.\n","items":{"type":"object","required":["start_time","end_time","number_of_rooms","passenger_id","ticket_delivery_method","ticket_delivery_recipient","hotel_price"],"properties":{"start_time":{"type":"string","description":"Start time of the hotel stay (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","description":"End time of the hotel stay (ISO 8601 format), e.g. \"2023-08-20T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-20T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].end_time","typeLabel":"string"},"number_of_rooms":{"type":"integer","description":"Number of rooms booked, e.g. 2","example":2,"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].number_of_rooms","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"hotel_price":{"type":"integer","description":"Price for the hotel stay in smallest unit of local currency, e.g. 200000\n","example":200000,"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].hotel_price","typeLabel":"integer"},"hotel_name":{"type":"string","description":"Name of the hotel, e.g. \"Premium Hotel\"","example":"Premium Hotel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].hotel_name","typeLabel":"string"},"address":{"type":"object","description":"Address details of the hotel.","required":["city","country"],"properties":{"city":{"type":"string","description":"City the hotel is located in, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.city","typeLabel":"string"},"country":{"type":"string","description":"Country the hotel is located in (ISO 3166-1 alpha-2 format), e.g. \"NO\",\n","example":"NO","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address of the hotel, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code of the hotel, e.g. \"0159\"","example":"0159","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.postal_code","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address","typeLabel":"object"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.hotel_reservation_details","typeLabel":"object"},"car_rental_reservation_details":{"type":"object","description":"Details about the reservation of rental cars.\n","required":["itinerary","drivers"],"properties":{"itinerary":{"type":"array","description":"Car rental itinerary data, one per car rental.\n\nIf you are selling a package that contains multiple car rentals,\nyou need to provide itinerary data for each of the individual rentals.\n","items":{"type":"object","required":["rental_company","start_time","end_time"],"properties":{"rental_company":{"type":"string","description":"Name of the car rental company, e.g. \"Premium Cars Ltd.\"","example":"Premium Cars","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].rental_company","typeLabel":"string"},"start_time":{"type":"string","description":"Start time of the car rental reservation (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","description":"End time of the car rental reservation (ISO 8601 format), e.g. \"2023-08-20T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-20T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].end_time","typeLabel":"string"},"drivers_id":{"type":"array","description":"Driver IDs.","items":{"type":"integer","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drivers_id.items.[INDEX]","typeLabel":"integer"},"example":[1],"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drivers_id","typeLabel":"integer[]"},"pick_up_location":{"type":"object","description":"Details related to the pick up location.","required":["city","country"],"properties":{"city":{"type":"string","description":"City where the car should be picked up, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country where the car should be picked up (ISO 3166-1 alpha-2 format), e.g. \"NO\",\n","example":"NO","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address where the car should be picked up, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code where the car should be picked up, e.g. \"0159\"","example":"0159","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location","typeLabel":"object"},"drop_off_location":{"type":"object","description":"Details related to the drop off location.","required":["city","country"],"properties":{"city":{"type":"string","description":"City where the car should be dropped off, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country where the car should be dropped off (ISO 3166-1 alpha-2 format), e.g. \"NO\"\n","example":"NO","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address where the car should be dropped off, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code where the car should be dropped off, e.g. \"0159\"","example":"0159","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location","typeLabel":"object"},"car_price":{"type":"integer","description":"Price for the car rental reservation in smallest unit of local currency, e.g. 500000\n","example":500000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].car_price","typeLabel":"integer"},"class":{"type":"string","description":"Travel class, e.g. \"Premium Cars Premium Class\"","example":"Premium Cars Premium Class","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.itinerary","typeLabel":"object[]"},"drivers":{"type":"array","description":"Driver data, one per driver.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.drivers","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.insurance","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel.car_rental_reservation_details","typeLabel":"object"}},"uniqueKey":"order.\\items.items.[INDEX].emd.travel","typeLabel":"object"},"marketplace_order":{"type":"object","description":"Only required if them item is related to a marketplace order.\n\nIf that is the case, you need to provide information about both the seller and\nthe winner.\n","required":["seller_info","winner_info"],"properties":{"seller_info":{"type":"object","description":"Details related to the seller involved in the marketplace order.\n","required":["sub_merchant_id","product_category","account_registration_date","account_last_modified","number_of_trades"],"properties":{"sub_merchant_id":{"type":"string","description":"Name or unique number of the selling/delivering merchant,\ne.g. \"Marketbrick Ltd.\"\n","example":"Marketbrick Ltd.","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.sub_merchant_id","typeLabel":"string"},"product_category":{"type":"string","description":"Name of the category to which the specific good belongs to,\naccording to the selling merchant's categorization, e.g. \"Phones\".\n","example":"Phones","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.product_category","typeLabel":"string"},"account_registration_date":{"type":"string","format":"date-time","description":"Date and time that the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_registration_date","typeLabel":"string\u003cdate-time>"},"account_last_modified":{"type":"object","required":["password","email","listing","login","address"],"properties":{"password":{"type":"string","format":"date-time","description":"Date and time that the password was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified.password","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","format":"date-time","description":"Date and time that the email was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified.email","typeLabel":"string\u003cdate-time>"},"listing":{"type":"string","format":"date-time","description":"Date and time that the listing details were last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified.listing","typeLabel":"string\u003cdate-time>"},"login":{"type":"string","format":"date-time","description":"Date and time that the login details were last changed (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified.login","typeLabel":"string\u003cdate-time>"},"address":{"type":"string","format":"date-time","description":"Date and time that the (physical) address was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified.address","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.account_last_modified","typeLabel":"object"},"number_of_trades":{"type":"integer","description":"Number of trades the sub-merchant did in the last 12 months, e.g. 23\n","example":23,"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.number_of_trades","typeLabel":"integer"},"unique_account_identifier_seller":{"type":"object","description":"Details about the seller.","properties":{"email":{"type":"string","description":"Seller's email address, e.g. \"seller@mail.com\"\n","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.unique_account_identifier_seller.email","typeLabel":"string"},"phone_number":{"type":"string","description":"Seller's phone number, e.g. \"97712123\"","example":"97712123","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.unique_account_identifier_seller.phone_number","typeLabel":"string"},"other":{"type":"string","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.unique_account_identifier_seller.other","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.unique_account_identifier_seller","typeLabel":"object"},"product_name":{"type":"string","description":"Name of the good purchased.\n","example":"iPhone 14 Pro Max","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.product_name","typeLabel":"string"},"seller_rating":{"type":"number","description":"Current rating of the good purchased according\nto the marketplace's rating scale, e.g. 5\n","example":5,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.seller_rating","typeLabel":"number"},"volume_of_trades":{"type":"integer","description":"Volumes of trades the sub-merchant did in the last 12 months,\ne.g. 230\n","example":230,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info.volume_of_trades","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.seller_info","typeLabel":"object"},"winner_info":{"type":"object","description":"Details related to the winner involved in the marketplace order.\n","required":["account_registration_date","account_last_modified","number_of_trades"],"properties":{"account_registration_date":{"type":"string","format":"date-time","description":"Date and time that the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_registration_date","typeLabel":"string\u003cdate-time>"},"account_last_modified":{"type":"object","required":["password","email","listing","login","address"],"properties":{"password":{"type":"string","format":"date-time","description":"Date and time that the password was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified.password","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","format":"date-time","description":"Date and time that the email was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified.email","typeLabel":"string\u003cdate-time>"},"listing":{"type":"string","format":"date-time","description":"Date and time that the listing details were last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified.listing","typeLabel":"string\u003cdate-time>"},"login":{"type":"string","format":"date-time","description":"Date and time that the login details were last changed (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified.login","typeLabel":"string\u003cdate-time>"},"address":{"type":"string","format":"date-time","description":"Date and time that the (physical) address was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified.address","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.account_last_modified","typeLabel":"object"},"number_of_trades":{"type":"integer","description":"Number of trades the winner did in the last 12 months, e.g. 23\n","example":23,"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.number_of_trades","typeLabel":"integer"},"unique_account_identifier_winner":{"type":"object","description":"Details about the winner.","properties":{"email":{"type":"string","description":"Winner's email address, e.g. \"winner@mail.com\"\n","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.unique_account_identifier_winner.email","typeLabel":"string"},"phone_number":{"type":"string","description":"Winner's phone number, e.g. \"97712123\"","example":"97712123","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.unique_account_identifier_winner.phone_number","typeLabel":"string"},"other":{"type":"string","uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.unique_account_identifier_winner.other","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.unique_account_identifier_winner","typeLabel":"object"},"volume_of_trades":{"type":"integer","description":"Volumes of trades the winner did in the last 12 months,\ne.g. 230\n","example":230,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info.volume_of_trades","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order.winner_info","typeLabel":"object"}},"uniqueKey":"order.\\items.items.[INDEX].emd.marketplace_order","typeLabel":"object"}},"uniqueKey":"order.\\items.items.[INDEX].emd","typeLabel":"object"},"store":{"type":"object","description":"Store metadata, it can be used to track supplier/vendor/partner\ninformation when the main `order.store` is a marketplace / reseller\n","required":["id"],"properties":{"id":{"type":"string","example":"sc029","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].store.id","typeLabel":"string"},"name":{"type":"string","description":"name of the store, aka trade name of the store\n","example":"SC Oslo","uniqueKey":"order.\\items.items.[INDEX].store.name","typeLabel":"string"},"business_name":{"type":"string","description":"Official name of the person or entity that owns the store.\n","example":"SC Oslo AS","uniqueKey":"order.\\items.items.[INDEX].store.business_name","typeLabel":"string"},"address":{"type":"object","required":["address_line","postal_place","country"],"properties":{"address_line":{"type":"string","example":"Sommerkroveien 34","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].store.address.address_line","typeLabel":"string"},"postal_place":{"type":"string","example":"Oslo","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].store.address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso-3166-1","description":"ISO 3166-1 country code\n","example":"NO","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].store.address.country","typeLabel":"string\u003ciso-3166-1>"},"address_line_2":{"type":"string","example":"PB 123","uniqueKey":"order.\\items.items.[INDEX].store.address.address_line_2","typeLabel":"string"},"postal_code":{"type":"string","example":"0349","uniqueKey":"order.\\items.items.[INDEX].store.address.postal_code","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].store.address","typeLabel":"object"},"chain":{"type":"string","example":"SuperChain","uniqueKey":"order.\\items.items.[INDEX].store.chain","typeLabel":"string"},"email":{"type":"string","example":"contact@superchain.com","uniqueKey":"order.\\items.items.[INDEX].store.email","typeLabel":"string"},"gln":{"type":"string","example":"5790001398644","uniqueKey":"order.\\items.items.[INDEX].store.gln","typeLabel":"string"},"organization_number":{"type":"string","example":"123456789MVA","uniqueKey":"order.\\items.items.[INDEX].store.organization_number","typeLabel":"string"},"phone_number":{"type":"string","example":"+4738260107","uniqueKey":"order.\\items.items.[INDEX].store.phone_number","typeLabel":"string"},"mcc":{"type":"string","format":"iso-18245","description":"A four-digit Merchant Category Code (MCC) for the store\n[ISO 18245:2003](https://www.iso.org/standard/33365.html)\n","example":"5814","minimum":4,"maximum":4,"uniqueKey":"order.\\items.items.[INDEX].store.mcc","typeLabel":"string\u003ciso-18245>"},"bax":{"type":"string","example":"102603","description":"Merchant number associated with the stores\npayment terminal\n","uniqueKey":"order.\\items.items.[INDEX].store.bax","typeLabel":"string"},"terminal_id":{"type":"string","description":"Id to a specific point-of-sale (POS) terminal\nor workstation\n","example":"T0292","uniqueKey":"order.\\items.items.[INDEX].store.terminal_id","typeLabel":"string"},"payout_destination_id":{"type":"string","maxLength":40,"description":"The payout destination id for the merchant of record,\ni.e. the seller responsible for the transaction.\n\nRequired when `seitatech.in_person` payment is enabled.\n","example":"seller-1","uniqueKey":"order.\\items.items.[INDEX].store.payout_destination_id","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].store","typeLabel":"object"},"eligible_for_discount":{"type":"boolean","default":false,"example":true,"description":"The item is eligible for discount\n","uniqueKey":"order.\\items.items.[INDEX].eligible_for_discount","typeLabel":"boolean"},"is_changed":{"type":"boolean","description":"Discount applied to amount\n","uniqueKey":"order.\\items.items.[INDEX].is_changed","typeLabel":"boolean"},"gross_amount":{"type":"number","readOnly":true,"description":"The origin item amount before any discount\n","uniqueKey":"order.\\items.items.[INDEX].gross_amount","typeLabel":"number"},"discount_lines":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"integer","example":4400,"description":"Monetary amount in smallest unit for the currency\n","uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].amount","typeLabel":"integer"},"percentage":{"type":"number","description":"Optional, set if the amount given was from a percentage discount\n","example":44,"uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].percentage","typeLabel":"number"},"discount_type":{"type":"string","enum":["customer","periodic","manual","loyalty","total","employee","external"],"uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].discount_type","typeLabel":"enum\u003cstring>"},"discount_id":{"type":"string","example":"766da0ef-9283-42bd-b012-0582344ec53c","uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].discount_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].description","typeLabel":"string"},"line_id":{"type":"integer","example":1,"uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX].line_id","typeLabel":"integer"}},"uniqueKey":"order.\\items.items.[INDEX].discount_lines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.items.[INDEX].discount_lines","typeLabel":"object[]"}},"uniqueKey":"order.\\items.items.[INDEX]","typeLabel":"object"},"example":[{"amount":2000,"quantity":2,"line_id":"1","description":"Forsvinnignspølse","vat":20,"id":"10"},{"amount":6600,"quantity":2,"line_id":"2","description":"Vissvossafår på neppebrød","vat":20,"id":"6","eligible_for_discount":true,"is_changed":true,"gross_amount":10000,"discount_lines":[{"amount":4400,"discount_type":"customer","discount_id":"ed960ace-eb16-4e2e-ae52-b27647ccae8d","description":"Vossafestpris","line_id":1}]},{"amount":59700,"quantity":3,"line_id":"3","description":"Luftboller","vat":20,"id":"1"}],"uniqueKey":"order.\\items","typeLabel":"object[]"},"gross_amount":{"type":"number","readOnly":true,"description":"The origin amount to authorize/capture including VAT\nbefore any discount, only set if the session was updated\nwhen calculating discounts.\n\nIn smallest unit for the currency, e.g. cents\n","uniqueKey":"order.gross_amount","typeLabel":"number"},"is_changed":{"type":"boolean","readOnly":true,"description":"The original order amount was changed by discount\ngiven.\n","uniqueKey":"order.is_changed","typeLabel":"boolean"},"shipping_option":{"type":"object","description":"A shipping option\n","required":["id","line_id","amount","operator","title"],"properties":{"id":{"type":"string","description":"Id of this shipping option product.\n\nThe express checkout will group all products with the same id. Used for\ngrouping delivery to the same address at different time slots, or for\ngrouping deliveries to different pick up points.\n","example":"bring-pick-up-00001","isRequired":true,"uniqueKey":"order.shipping_option.id","typeLabel":"string"},"line_id":{"type":"string","description":"Unique id of the specific configuration of this shipping product\n","example":"bring-pick-up-00001-location-0a1f6b","isRequired":true,"uniqueKey":"order.shipping_option.line_id","typeLabel":"string"},"amount":{"type":"integer","description":"The monetary amount of the shipping option, including VAT and discounts.\n\nIn smallest unit for the currency, e.g. cents\n","example":3900,"isRequired":true,"uniqueKey":"order.shipping_option.amount","typeLabel":"integer"},"title":{"type":"string","description":"A shipping option title. Eg. \"Standard\"\n","example":"Standard","isRequired":true,"uniqueKey":"order.shipping_option.title","typeLabel":"string"},"operator":{"type":"string","description":"Name of company that provides shipping service\n","example":"Bring","isRequired":true,"uniqueKey":"order.shipping_option.operator","typeLabel":"string"},"countries":{"description":"Countries where this shipping option can be used","type":"array","items":{"type":"string","format":"iso3166-alpha2","example":"NO","uniqueKey":"order.shipping_option.countries.items.[INDEX]","typeLabel":"string\u003ciso3166-alpha2>"},"uniqueKey":"order.shipping_option.countries","typeLabel":"string\u003ciso3166-alpha2>[]"},"vat_amount":{"type":"integer","description":"The VAT of the `amount` parameter. Only\nused for display purposes.\n","example":975,"uniqueKey":"order.shipping_option.vat_amount","typeLabel":"integer"},"vat":{"type":"number","description":"The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2.\n","example":25,"uniqueKey":"order.shipping_option.vat","typeLabel":"number"},"description":{"type":"string","description":"A short description of the shipping option product\n","example":"Pick up at your nearest postal office","uniqueKey":"order.shipping_option.description","typeLabel":"string"},"delivery_method":{"type":"string","enum":["delivery","pick_up","unspecified","none"],"example":"pick_up","uniqueKey":"order.shipping_option.delivery_method","typeLabel":"enum\u003cstring>"},"operator_product_id":{"type":"string","description":"The operators own id for this shipping product\n","example":"pick-up-00001-location-0a1f6b","uniqueKey":"order.shipping_option.operator_product_id","typeLabel":"string"},"eta":{"type":"object","description":"Estimated time of arrival","properties":{"working_days":{"type":"array","description":"The expected range of days until the relative time is reached.\nA range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days.\n","example":[1,2],"minItems":2,"maxItems":2,"items":{"type":"number","minimum":0,"uniqueKey":"order.shipping_option.eta.working_days.items.[INDEX]","typeLabel":"number"},"uniqueKey":"order.shipping_option.eta.working_days","typeLabel":"number[]"},"shipping_day_of_week":{"type":"number","description":"The day of the week the relative time for shipping is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","example":3,"minimum":1,"maximum":7,"uniqueKey":"order.shipping_option.eta.shipping_day_of_week","typeLabel":"number"},"arrival_day_of_week":{"type":"number","description":"The day of the week the relative time for arrival is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","example":3,"minimum":1,"maximum":7,"uniqueKey":"order.shipping_option.eta.arrival_day_of_week","typeLabel":"number"},"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"order.shipping_option.eta.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"order.shipping_option.eta.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"order.shipping_option.eta","typeLabel":"object"},"time_slot":{"description":"A specified time for delivery to customer","type":"object","properties":{"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"order.shipping_option.time_slot.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"order.shipping_option.time_slot.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"order.shipping_option.time_slot","typeLabel":"object"},"pick_up_address":{"type":"object","description":"Additional information about the shipping address","properties":{"first_name":{"type":"string","example":"John","uniqueKey":"order.shipping_option.pick_up_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"order.shipping_option.pick_up_address.last_name","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","uniqueKey":"order.shipping_option.pick_up_address.address_line","typeLabel":"string"},"address_line_2":{"type":"string","description":"PB 123","uniqueKey":"order.shipping_option.pick_up_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","example":"Land Lord","uniqueKey":"order.shipping_option.pick_up_address.co_address","typeLabel":"string"},"business_name":{"type":"string","description":"Name of the company","uniqueKey":"order.shipping_option.pick_up_address.business_name","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","uniqueKey":"order.shipping_option.pick_up_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","uniqueKey":"order.shipping_option.pick_up_address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso3166-alpha2","description":"Country of the location","example":"NO","uniqueKey":"order.shipping_option.pick_up_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","pattern":"^\\+?\\d{5,15}$","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","uniqueKey":"order.shipping_option.pick_up_address.phone_number","typeLabel":"string"},"email":{"type":"string","description":"The email address of a person or an organization\n","uniqueKey":"order.shipping_option.pick_up_address.email","typeLabel":"string"},"latitude":{"type":"number","uniqueKey":"order.shipping_option.pick_up_address.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"order.shipping_option.pick_up_address.longitude","typeLabel":"number"},"comment":{"type":"string","description":"Comment about the address\n","uniqueKey":"order.shipping_option.pick_up_address.comment","typeLabel":"string"},"organization_number":{"type":"string","description":"The organization number of the customer.\n","uniqueKey":"order.shipping_option.pick_up_address.organization_number","typeLabel":"string"},"organization_type":{"type":"string","description":"Type indicating what kind of organization it is.\n","uniqueKey":"order.shipping_option.pick_up_address.organization_type","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference\n\n#### Kravia\nWhen Kravia is enabled, `billing_address.customer_reference` must\nbe at most 30 characters.\n","uniqueKey":"order.shipping_option.pick_up_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","uniqueKey":"order.shipping_option.pick_up_address.cost_center","typeLabel":"string"},"website_url":{"type":"string","description":"The website URL of the customer.\n","uniqueKey":"order.shipping_option.pick_up_address.website_url","typeLabel":"string"},"opening_hours":{"type":"object","properties":{"open_now":{"type":"boolean","description":"Indicates if the location is open now.\n","example":true,"uniqueKey":"order.shipping_option.pick_up_address.opening_hours.open_now","typeLabel":"boolean"},"periods":{"type":"array","items":{"type":"object","description":"A period of time when the opening hours are valid.\n","properties":{"opens_at":{"type":"string","format":"time","example":"08:00","uniqueKey":"order.shipping_option.pick_up_address.opening_hours.periods.items.[INDEX].opens_at","typeLabel":"string\u003ctime>"},"closes_at":{"type":"string","format":"time","example":"16:00","uniqueKey":"order.shipping_option.pick_up_address.opening_hours.periods.items.[INDEX].closes_at","typeLabel":"string\u003ctime>"},"day_of_week":{"type":"number","description":"The day of the week when the opening hours are valid.\n","example":1,"uniqueKey":"order.shipping_option.pick_up_address.opening_hours.periods.items.[INDEX].day_of_week","typeLabel":"number"}},"uniqueKey":"order.shipping_option.pick_up_address.opening_hours.periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.pick_up_address.opening_hours.periods","typeLabel":"object[]"},"timezone":{"type":"string","description":"The timezone of the location.\n","example":"Europe/Oslo","uniqueKey":"order.shipping_option.pick_up_address.opening_hours.timezone","typeLabel":"string"}},"uniqueKey":"order.shipping_option.pick_up_address.opening_hours","typeLabel":"object"},"distance":{"type":"number","description":"Distance in kilometers from the shipping_address.\n","uniqueKey":"order.shipping_option.pick_up_address.distance","typeLabel":"number"}},"uniqueKey":"order.shipping_option.pick_up_address","typeLabel":"object"},"metadata":{"type":"object","description":"Additional metadata about the shipping_option","maxProperties":20,"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"order.shipping_option.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"order.shipping_option.metadata.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"order.shipping_option.metadata.additionalProperties","typeLabel":"string | number"},"example":{"operator_dest":"XAB1239","number_x":1921},"uniqueKey":"order.shipping_option.metadata","typeLabel":"object"},"environmental_data":{"type":"object","description":"Environmental data about the shipping option\n","required":["description"],"properties":{"description":{"type":"string","description":"A short description of the environmental data, something like\n- \"Fossil free\",\n- \"Carbon neutral\"\n- \"Low emissions\"\n- \"Renewable Energy Sourced\"\n- \"Eco-certified Fleet\"\n","example":"Fossil free","isRequired":true,"uniqueKey":"order.shipping_option.environmental_data.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"description":"Give context to the value field. Example:\n- \"CO2 emissions\"\n- \"Energy consumption\"\n- \"Carbon footprint\"\n- \"Carbon offset\"\n- \"Trees planted\"\n- \"Renewable energy percentage\"\n","type":"string","example":"Carbon offset","maxLength":50,"isRequired":true,"uniqueKey":"order.shipping_option.environmental_data.details.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","example":"1KG CO2","maxLength":50,"isRequired":true,"uniqueKey":"order.shipping_option.environmental_data.details.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"order.shipping_option.environmental_data.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.environmental_data.details","typeLabel":"object[]"}},"uniqueKey":"order.shipping_option.environmental_data","typeLabel":"object"},"thumbnail_url":{"type":"string","description":"URL to a thumbnail of the shipping option. Will be displayed when\nredirecting to the session.\nRecommended limitations for the image:\n - all images should preferrably have the same dimensions\n - max file size should be less than 2MB\n","format":"uri","uniqueKey":"order.shipping_option.thumbnail_url","typeLabel":"string\u003curi>"},"pay_in_store":{"description":"Enable pay in-store during pick-up. The amount to be paid will be zero.\nRequires that the payment method `dintero.zero` is enabled\n","type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["full"],"isRequired":true,"uniqueKey":"order.shipping_option.pay_in_store.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.shipping_option.pay_in_store","typeLabel":"object"},"fee_split":{"type":"object","description":"Specify how fees are handled with splits. The default behaviour is to share\nthe fees proportional with all splits destinations\n","required":["type"],"properties":{"type":{"type":"string","description":"- **`proportional`**: Fees are shared proportionally across `destinations`, weighted by each destination's split amount. Every destination must also be included in `splits`.\n- **`equal_fee_only`**: Fees are shared equally across `destinations`. These destinations must not be included in `splits` and receive no income from the order - they only accumulate fee debt.\n","enum":["proportional","equal_fee_only"],"isRequired":true,"uniqueKey":"order.shipping_option.fee_split.type","typeLabel":"enum\u003cstring>"},"destinations":{"type":"array","description":"Seller ids that will be debited for the payment fees.\n\n- When `type` is `proportional`, all destinations must also be included in the list of `splits`.\n- When `type` is `equal_fee_only`, destinations must not be included in `splits`. The fee is divided equally between them, and they receive no income from the order - only fee debt.\n","minItems":1,"items":{"type":"string","maxLength":40,"uniqueKey":"order.shipping_option.fee_split.destinations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping_option.fee_split.destinations","typeLabel":"string[]"}},"uniqueKey":"order.shipping_option.fee_split","typeLabel":"object"},"splits":{"type":"array","description":"An array of objects specifying how the amount should be split between\nsellers when using Dintero Payout\n\nSpecify an empty array if the splits will be provided during capture.\n`auto_capture` cannot be enabled when splits are defined as empty array.\n","items":{"type":"object","required":["payout_destination_id","amount"],"properties":{"payout_destination_id":{"type":"string","maxLength":40,"example":"seller-1","description":"An id that identifies the seller\n\nNote: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations\n","isRequired":true,"uniqueKey":"order.shipping_option.splits.items.[INDEX].payout_destination_id","typeLabel":"string"},"amount":{"type":"integer","format":"int32","example":29700,"minimum":0,"description":"The split amount in smallest unit for the currency, e.g. cents.\n","isRequired":true,"uniqueKey":"order.shipping_option.splits.items.[INDEX].amount","typeLabel":"integer\u003cint32>"}},"uniqueKey":"order.shipping_option.splits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.splits","typeLabel":"object[]"},"shipments":{"type":"array","description":"For multiple shipments we have a single top-level shipping object that contains\nthe shipments for the order. The shipping options defined in `shipments` must contain\n`shipment_items` that define what items belong to what shipment.\n\nFor multiple shipments:\n - do not define `splits` on the toplevel shipping option\n - do not define `fee_split` on the toplevel shipping option\n - the `pay_in_store` option is not compatible with `shipments`\n - empty shipments array is not allowed\n - single item multi shipping option is not allowed\n","minItems":2,"items":{"type":"object","description":"A shipping option\n","required":["id","line_id","amount","operator","title"],"properties":{"id":{"type":"string","description":"Id of this shipping option product.\n\nThe express checkout will group all products with the same id. Used for\ngrouping delivery to the same address at different time slots, or for\ngrouping deliveries to different pick up points.\n","example":"bring-pick-up-00001","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].id","typeLabel":"string"},"line_id":{"type":"string","description":"Unique id of the specific configuration of this shipping product\n","example":"bring-pick-up-00001-location-0a1f6b","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].line_id","typeLabel":"string"},"amount":{"type":"integer","description":"The monetary amount of the shipping option, including VAT and discounts.\n\nIn smallest unit for the currency, e.g. cents\n","example":3900,"isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].amount","typeLabel":"integer"},"title":{"type":"string","description":"A shipping option title. Eg. \"Standard\"\n","example":"Standard","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].title","typeLabel":"string"},"operator":{"type":"string","description":"Name of company that provides shipping service\n","example":"Bring","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].operator","typeLabel":"string"},"countries":{"description":"Countries where this shipping option can be used","type":"array","items":{"type":"string","format":"iso3166-alpha2","example":"NO","uniqueKey":"order.shipping_option.shipments.items.[INDEX].countries.items.[INDEX]","typeLabel":"string\u003ciso3166-alpha2>"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].countries","typeLabel":"string\u003ciso3166-alpha2>[]"},"vat_amount":{"type":"integer","description":"The VAT of the `amount` parameter. Only\nused for display purposes.\n","example":975,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].vat_amount","typeLabel":"integer"},"vat":{"type":"number","description":"The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2.\n","example":25,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].vat","typeLabel":"number"},"description":{"type":"string","description":"A short description of the shipping option product\n","example":"Pick up at your nearest postal office","uniqueKey":"order.shipping_option.shipments.items.[INDEX].description","typeLabel":"string"},"delivery_method":{"type":"string","enum":["delivery","pick_up","unspecified","none"],"example":"pick_up","uniqueKey":"order.shipping_option.shipments.items.[INDEX].delivery_method","typeLabel":"enum\u003cstring>"},"operator_product_id":{"type":"string","description":"The operators own id for this shipping product\n","example":"pick-up-00001-location-0a1f6b","uniqueKey":"order.shipping_option.shipments.items.[INDEX].operator_product_id","typeLabel":"string"},"eta":{"type":"object","description":"Estimated time of arrival","properties":{"working_days":{"type":"array","description":"The expected range of days until the relative time is reached.\nA range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days.\n","example":[1,2],"minItems":2,"maxItems":2,"items":{"type":"number","minimum":0,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.working_days.items.[INDEX]","typeLabel":"number"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.working_days","typeLabel":"number[]"},"shipping_day_of_week":{"type":"number","description":"The day of the week the relative time for shipping is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","example":3,"minimum":1,"maximum":7,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.shipping_day_of_week","typeLabel":"number"},"arrival_day_of_week":{"type":"number","description":"The day of the week the relative time for arrival is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","example":3,"minimum":1,"maximum":7,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.arrival_day_of_week","typeLabel":"number"},"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].eta","typeLabel":"object"},"time_slot":{"description":"A specified time for delivery to customer","type":"object","properties":{"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"order.shipping_option.shipments.items.[INDEX].time_slot.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"order.shipping_option.shipments.items.[INDEX].time_slot.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].time_slot","typeLabel":"object"},"pick_up_address":{"type":"object","description":"Additional information about the shipping address","properties":{"first_name":{"type":"string","example":"John","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.last_name","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.address_line","typeLabel":"string"},"address_line_2":{"type":"string","description":"PB 123","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","example":"Land Lord","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.co_address","typeLabel":"string"},"business_name":{"type":"string","description":"Name of the company","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.business_name","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso3166-alpha2","description":"Country of the location","example":"NO","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","pattern":"^\\+?\\d{5,15}$","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.phone_number","typeLabel":"string"},"email":{"type":"string","description":"The email address of a person or an organization\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.email","typeLabel":"string"},"latitude":{"type":"number","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.longitude","typeLabel":"number"},"comment":{"type":"string","description":"Comment about the address\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.comment","typeLabel":"string"},"organization_number":{"type":"string","description":"The organization number of the customer.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.organization_number","typeLabel":"string"},"organization_type":{"type":"string","description":"Type indicating what kind of organization it is.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.organization_type","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference\n\n#### Kravia\nWhen Kravia is enabled, `billing_address.customer_reference` must\nbe at most 30 characters.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.cost_center","typeLabel":"string"},"website_url":{"type":"string","description":"The website URL of the customer.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.website_url","typeLabel":"string"},"opening_hours":{"type":"object","properties":{"open_now":{"type":"boolean","description":"Indicates if the location is open now.\n","example":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.open_now","typeLabel":"boolean"},"periods":{"type":"array","items":{"type":"object","description":"A period of time when the opening hours are valid.\n","properties":{"opens_at":{"type":"string","format":"time","example":"08:00","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].opens_at","typeLabel":"string\u003ctime>"},"closes_at":{"type":"string","format":"time","example":"16:00","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].closes_at","typeLabel":"string\u003ctime>"},"day_of_week":{"type":"number","description":"The day of the week when the opening hours are valid.\n","example":1,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].day_of_week","typeLabel":"number"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.periods","typeLabel":"object[]"},"timezone":{"type":"string","description":"The timezone of the location.\n","example":"Europe/Oslo","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours.timezone","typeLabel":"string"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.opening_hours","typeLabel":"object"},"distance":{"type":"number","description":"Distance in kilometers from the shipping_address.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address.distance","typeLabel":"number"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pick_up_address","typeLabel":"object"},"metadata":{"type":"object","description":"Additional metadata about the shipping_option","maxProperties":20,"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"order.shipping_option.shipments.items.[INDEX].metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"order.shipping_option.shipments.items.[INDEX].metadata.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"order.shipping_option.shipments.items.[INDEX].metadata.additionalProperties","typeLabel":"string | number"},"example":{"operator_dest":"XAB1239","number_x":1921},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].metadata","typeLabel":"object"},"environmental_data":{"type":"object","description":"Environmental data about the shipping option\n","required":["description"],"properties":{"description":{"type":"string","description":"A short description of the environmental data, something like\n- \"Fossil free\",\n- \"Carbon neutral\"\n- \"Low emissions\"\n- \"Renewable Energy Sourced\"\n- \"Eco-certified Fleet\"\n","example":"Fossil free","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"description":"Give context to the value field. Example:\n- \"CO2 emissions\"\n- \"Energy consumption\"\n- \"Carbon footprint\"\n- \"Carbon offset\"\n- \"Trees planted\"\n- \"Renewable energy percentage\"\n","type":"string","example":"Carbon offset","maxLength":50,"isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data.details.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","example":"1KG CO2","maxLength":50,"isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data.details.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data.details","typeLabel":"object[]"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].environmental_data","typeLabel":"object"},"thumbnail_url":{"type":"string","description":"URL to a thumbnail of the shipping option. Will be displayed when\nredirecting to the session.\nRecommended limitations for the image:\n - all images should preferrably have the same dimensions\n - max file size should be less than 2MB\n","format":"uri","uniqueKey":"order.shipping_option.shipments.items.[INDEX].thumbnail_url","typeLabel":"string\u003curi>"},"pay_in_store":{"description":"Enable pay in-store during pick-up. The amount to be paid will be zero.\nRequires that the payment method `dintero.zero` is enabled\n","type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["full"],"isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pay_in_store.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].pay_in_store","typeLabel":"object"},"fee_split":{"type":"object","description":"Specify how fees are handled with splits. The default behaviour is to share\nthe fees proportional with all splits destinations\n","required":["type"],"properties":{"type":{"type":"string","description":"- **`proportional`**: Fees are shared proportionally across `destinations`, weighted by each destination's split amount. Every destination must also be included in `splits`.\n- **`equal_fee_only`**: Fees are shared equally across `destinations`. These destinations must not be included in `splits` and receive no income from the order - they only accumulate fee debt.\n","enum":["proportional","equal_fee_only"],"isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].fee_split.type","typeLabel":"enum\u003cstring>"},"destinations":{"type":"array","description":"Seller ids that will be debited for the payment fees.\n\n- When `type` is `proportional`, all destinations must also be included in the list of `splits`.\n- When `type` is `equal_fee_only`, destinations must not be included in `splits`. The fee is divided equally between them, and they receive no income from the order - only fee debt.\n","minItems":1,"items":{"type":"string","maxLength":40,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].fee_split.destinations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].fee_split.destinations","typeLabel":"string[]"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].fee_split","typeLabel":"object"},"splits":{"type":"array","description":"An array of objects specifying how the amount should be split between\nsellers when using Dintero Payout\n\nSpecify an empty array if the splits will be provided during capture.\n`auto_capture` cannot be enabled when splits are defined as empty array.\n","items":{"type":"object","required":["payout_destination_id","amount"],"properties":{"payout_destination_id":{"type":"string","maxLength":40,"example":"seller-1","description":"An id that identifies the seller\n\nNote: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations\n","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].splits.items.[INDEX].payout_destination_id","typeLabel":"string"},"amount":{"type":"integer","format":"int32","example":29700,"minimum":0,"description":"The split amount in smallest unit for the currency, e.g. cents.\n","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].splits.items.[INDEX].amount","typeLabel":"integer\u003cint32>"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].splits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].splits","typeLabel":"object[]"},"shipment_id":{"type":"string","description":"For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`.\nIn order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment.","uniqueKey":"order.shipping_option.shipments.items.[INDEX].shipment_id","typeLabel":"string"},"shipment_items":{"type":"array","description":"An array of objects specifying what items will be delivered by this shipment. Should\nonly be specified when an order has multiple shipments so the checkout knows what\nitems will be shipped by the shipping options.\n\nIf there are multiple shipments the session (and resulting transaction) will have a\nsingle top-level shipping object that contains multiple `shipments` for the order.\n","items":{"type":"object","required":["line_id"],"properties":{"line_id":{"type":"string","example":"line-id-1","description":"The line_id or an item in order.items\n","isRequired":true,"uniqueKey":"order.shipping_option.shipments.items.[INDEX].shipment_items.items.[INDEX].line_id","typeLabel":"string"},"quantity":{"type":"number","description":"The quantity of the product in the item line.\n","uniqueKey":"order.shipping_option.shipments.items.[INDEX].shipment_items.items.[INDEX].quantity","typeLabel":"number"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].shipment_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.shipments.items.[INDEX].shipment_items","typeLabel":"object[]"}},"uniqueKey":"order.shipping_option.shipments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping_option.shipments","typeLabel":"object[]"}},"uniqueKey":"order.shipping_option","typeLabel":"object"},"store":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"sc029","isRequired":true,"uniqueKey":"order.store.id","typeLabel":"string"},"name":{"type":"string","description":"name of the store, aka trade name of the store\n","example":"SC Oslo","uniqueKey":"order.store.name","typeLabel":"string"},"business_name":{"type":"string","description":"Official name of the person or entity that owns the store.\n","example":"SC Oslo AS","uniqueKey":"order.store.business_name","typeLabel":"string"},"address":{"type":"object","required":["address_line","postal_place","country"],"properties":{"address_line":{"type":"string","example":"Sommerkroveien 34","isRequired":true,"uniqueKey":"order.store.address.address_line","typeLabel":"string"},"postal_place":{"type":"string","example":"Oslo","isRequired":true,"uniqueKey":"order.store.address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso-3166-1","description":"ISO 3166-1 country code\n","example":"NO","isRequired":true,"uniqueKey":"order.store.address.country","typeLabel":"string\u003ciso-3166-1>"},"address_line_2":{"type":"string","example":"PB 123","uniqueKey":"order.store.address.address_line_2","typeLabel":"string"},"postal_code":{"type":"string","example":"0349","uniqueKey":"order.store.address.postal_code","typeLabel":"string"}},"uniqueKey":"order.store.address","typeLabel":"object"},"chain":{"type":"string","example":"SuperChain","uniqueKey":"order.store.chain","typeLabel":"string"},"email":{"type":"string","example":"contact@superchain.com","uniqueKey":"order.store.email","typeLabel":"string"},"gln":{"type":"string","example":"5790001398644","uniqueKey":"order.store.gln","typeLabel":"string"},"organization_number":{"type":"string","example":"123456789MVA","uniqueKey":"order.store.organization_number","typeLabel":"string"},"phone_number":{"type":"string","example":"+4738260107","uniqueKey":"order.store.phone_number","typeLabel":"string"},"mcc":{"type":"string","format":"iso-18245","description":"A four-digit Merchant Category Code (MCC) for the store\n[ISO 18245:2003](https://www.iso.org/standard/33365.html)\n","example":"5814","minimum":4,"maximum":4,"uniqueKey":"order.store.mcc","typeLabel":"string\u003ciso-18245>"},"bax":{"type":"string","example":"102603","description":"Merchant number associated with the stores\npayment terminal\n","uniqueKey":"order.store.bax","typeLabel":"string"},"terminal_id":{"type":"string","description":"Id to a specific point-of-sale (POS) terminal\nor workstation\n","example":"T0292","uniqueKey":"order.store.terminal_id","typeLabel":"string"},"payout_destination_id":{"type":"string","maxLength":40,"description":"The payout destination id for the merchant of record,\ni.e. the seller responsible for the transaction.\n\nRequired when `seitatech.in_person` payment is enabled.\n","example":"seller-1","uniqueKey":"order.store.payout_destination_id","typeLabel":"string"}},"uniqueKey":"order.store","typeLabel":"object"},"discount_lines":{"description":"Discounts given, additions to any items discount_lines.\n","type":"array","items":{"type":"object","properties":{"amount":{"type":"integer","example":4400,"description":"Monetary amount in smallest unit for the currency\n","uniqueKey":"order.discount_lines.items.[INDEX].amount","typeLabel":"integer"},"percentage":{"type":"number","description":"Optional, set if the amount given was from a percentage discount\n","example":44,"uniqueKey":"order.discount_lines.items.[INDEX].percentage","typeLabel":"number"},"discount_type":{"type":"string","enum":["customer","periodic","manual","loyalty","total","employee","external"],"uniqueKey":"order.discount_lines.items.[INDEX].discount_type","typeLabel":"enum\u003cstring>"},"discount_id":{"type":"string","example":"766da0ef-9283-42bd-b012-0582344ec53c","uniqueKey":"order.discount_lines.items.[INDEX].discount_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"order.discount_lines.items.[INDEX].description","typeLabel":"string"},"line_id":{"type":"integer","example":1,"uniqueKey":"order.discount_lines.items.[INDEX].line_id","typeLabel":"integer"}},"uniqueKey":"order.discount_lines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.discount_lines","typeLabel":"object[]"},"discount_codes":{"type":"array","items":{"type":"string","example":"SUMMER20","uniqueKey":"order.discount_codes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.discount_codes","typeLabel":"string[]"},"gift_cards":{"type":"array","items":{"type":"object","required":["type","card_id","amount"],"properties":{"type":{"type":"string","enum":["dintero.wallets"],"isRequired":true,"uniqueKey":"order.gift_cards.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"card_id":{"type":"string","isRequired":true,"uniqueKey":"order.gift_cards.items.[INDEX].card_id","typeLabel":"string"},"amount":{"type":"integer","description":"Non-negative, minor units. Total amount for the gift card\n","isRequired":true,"uniqueKey":"order.gift_cards.items.[INDEX].amount","typeLabel":"integer"},"masked_card_token":{"type":"string","uniqueKey":"order.gift_cards.items.[INDEX].masked_card_token","typeLabel":"string"}},"uniqueKey":"order.gift_cards.items.[INDEX]","typeLabel":"object"},"description":"The gift cards selected, the part of `order.amount` that will be\nauthorized using gift cards\n","maxItems":1,"uniqueKey":"order.gift_cards","typeLabel":"object[]"},"emd":{"type":"object","description":"Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/).\n\nSome items require extra information to be provided when using\nKlarna as an enabled payment option.\n","properties":{"event":{"type":"array","description":"Only required if the item is related to an event or multiple events,\nlike for example tickets to a concert.\n\nIf you are selling an event package as a single ticket or item that\nincludes multiple events, for example a festival, you need to provide\ninformation about all the individual events that are part of the package.\n","items":{"type":"object","required":["event_name","event_company","genre_of_event","start_time","end_time","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"event_name":{"type":"string","description":"Name of the event, e.g. \"Fancy Singer\"","example":"Michael Jackson","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].event_name","typeLabel":"string"},"event_company":{"type":"string","description":"Name of the company arranging the event, e.g. \"Happy Parties Ltd.\"","example":"Diamond Events","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].event_company","typeLabel":"string"},"genre_of_event":{"type":"string","description":"Category or type of venue, e.g. \"Pop\"","example":"Pop","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].genre_of_event","typeLabel":"string"},"start_time":{"type":"string","format":"date-time","description":"Start time of the event (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"End time of the event (ISO 8601 format), e.g. \"2023-08-16T16:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T16:00:00Z","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].end_time","typeLabel":"string\u003cdate-time>"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"email","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"recipient@mail.com\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"recipient@mail.com","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"arena_name":{"type":"string","description":"Name of the venue, e.g. \"Song Arena\"","example":"Oslo Spektrum","uniqueKey":"order.emd.event.items.[INDEX].arena_name","typeLabel":"string"},"arena_location":{"type":"object","required":["city","country"],"properties":{"city":{"type":"string","description":"City that the venue is located in, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].arena_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country that the venue is located in (ISO 3166-1 alpha-2 format), e.g. \"NO\"\n","example":"NO","isRequired":true,"uniqueKey":"order.emd.event.items.[INDEX].arena_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address representing the venue location, e.g. \"Sonja Henies plass 2\"","example":"Sonja Henies plass 2","uniqueKey":"order.emd.event.items.[INDEX].arena_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code for the venue location, e.g. \"0185\"","example":"0185","uniqueKey":"order.emd.event.items.[INDEX].arena_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.emd.event.items.[INDEX].arena_location","typeLabel":"object"},"access_controlled_venue":{"type":"boolean","description":"If tickets are digitally checked when entering the venue, e.g. true","example":true,"uniqueKey":"order.emd.event.items.[INDEX].access_controlled_venue","typeLabel":"boolean"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.\n","example":"Klarna affiliate","uniqueKey":"order.emd.event.items.[INDEX].affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.event.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.event","typeLabel":"object[]"},"subscription":{"type":"object","description":"Only required if the item is related to a subscription.\n\nIf that is the case, you need to provide information about both the subscription\nand the customer account.\n","required":["subscription","customer_account_info"],"properties":{"subscription":{"type":"object","description":"Details related to the subscription.\n","required":["subscription_name","start_time","end_time","auto_renewal_of_subscription"],"properties":{"subscription_name":{"type":"string","description":"Name of the product on subscription, e.g. \"Contact lenses\"","example":"Contact lenses","isRequired":true,"uniqueKey":"order.emd.subscription.subscription.subscription_name","typeLabel":"string"},"start_time":{"type":"string","format":"date-time","description":"The start time of the subscription (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.subscription.subscription.start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"The end time of the subscription (ISO 8601 format),\ne.g. \"2023-09-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC\n","example":"2023-09-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.subscription.subscription.end_time","typeLabel":"string\u003cdate-time>"},"auto_renewal_of_subscription":{"type":"boolean","description":"Whether the subscription will be auto renewed upon expiry, e.g. true\n","example":true,"isRequired":true,"uniqueKey":"order.emd.subscription.subscription.auto_renewal_of_subscription","typeLabel":"boolean"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.\n","example":"Klarna affiliate","uniqueKey":"order.emd.subscription.subscription.affiliate_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order.emd.subscription.subscription","typeLabel":"object"},"customer_account_info":{"type":"object","description":"Information related to the customer that wants to purchase the subscription.\n","required":["unique_account_identifier","account_registration_date","account_last_modified"],"properties":{"unique_account_identifier":{"type":"string","description":"Unique name / number to identify the specific customer account.\nMax 24 characters, e.g. \"Adam Adamsson\"\n","example":"Adam Adamsson","isRequired":true,"uniqueKey":"order.emd.subscription.customer_account_info.unique_account_identifier","typeLabel":"string"},"account_registration_date":{"type":"string","description":"The date and time the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.subscription.customer_account_info.account_registration_date","typeLabel":"string"},"account_last_modified":{"type":"string","description":"The date and time the account was last modified (ISO 8601 format),\ne.g. \"2023-10-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-10-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.subscription.customer_account_info.account_last_modified","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order.emd.subscription.customer_account_info","typeLabel":"object"}},"uniqueKey":"order.emd.subscription","typeLabel":"object"},"travel":{"type":"object","description":"Only required if the item is part of a travel-related transaction.\n\nIf that is the case, you need to provide information about the itinerary\nto be booked.\n","properties":{"air_reservation_details":{"type":"object","description":"Details about the reservation of airline tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one flight from Oslo to Munich,\nand another flight from Munich to Dubai, you need to provide one\nitinerary object for each of these two flights, and so on.\n","items":{"type":"object","required":["departure","arrival","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure":{"type":"string","description":"IATA Airport Code (three letters), e.g. \"OSL\"","example":"OSL","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].departure","typeLabel":"string"},"arrival":{"type":"string","description":"IATA Airport Code (three letters), e.g. \"MUC\"","example":"MUC","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].arrival","typeLabel":"string"},"carrier":{"type":"string","description":"IATA Airline standard (two letters or digits), e.g. \"LH\"","example":"LH","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\"\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"departure_city":{"type":"string","description":"City the flight departs from, e.g. \"Oslo\"","example":"Oslo","uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the flight arrives in, e.g. \"Munich\"","example":"Munich","uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the flight\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.air_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.air_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.air_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.air_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.air_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.air_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.air_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.air_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.air_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.air_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.air_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.air_reservation_details","typeLabel":"object"},"bus_reservation_details":{"type":"object","description":"Details about the reservation of bus tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one bus journey from Oslo to Munich,\nand another bus journey from Munich to Rome, you need to provide one\nitinerary object for each of these two bus journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure_city":{"type":"string","description":"City the bus departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the bus arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Bus Travels Ltd.\"","example":"Big Bus Travels Ltd.","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the bus journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.bus_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.bus_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.bus_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.bus_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.bus_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.bus_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.bus_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.bus_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.bus_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.bus_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.bus_reservation_details","typeLabel":"object"},"train_reservation_details":{"type":"object","description":"Details about the reservation of train tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one train journey from Oslo to Munich,\nand another train journey from Munich to Rome, you need to provide one\nitinerary object for each of these two train journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient","passenger_id"],"properties":{"departure_city":{"type":"string","description":"City the train departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the train arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Train Travels Ltd.\"","example":"Big Train Travels Ltd.","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"segment_price":{"type":"integer","description":"Price for that specific segment of the train journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.train_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.train_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.train_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.train_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.train_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.train_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.train_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.train_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.train_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.train_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.train_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.train_reservation_details","typeLabel":"object"},"ferry_reservation_details":{"type":"object","description":"Details about the reservation of ferry tickets.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Itinerary data, one per segment.\n\nIf you are selling a ticket that contains one ferry journey from Oslo to Kiel,\nand another ferry journey from Kiel to Gothenburg, you need to provide one\nitinerary object for each of these two ferry journeys, and so on.\n","items":{"type":"object","required":["departure_city","arrival_city","carrier","departure_date","ticket_delivery_method","ticket_delivery_recipient"],"properties":{"departure_city":{"type":"string","description":"City the ferry departs from, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].departure_city","typeLabel":"string"},"arrival_city":{"type":"string","description":"City the ferry arrives in, e.g. \"Munich\"","example":"Munich","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].arrival_city","typeLabel":"string"},"carrier":{"type":"string","description":"Name of transportation company. \"Big Ferry Travels Ltd.\"","example":"Big Ferry Travels Ltd.","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].carrier","typeLabel":"string"},"departure_date":{"type":"string","description":"Departure date (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].departure_date","typeLabel":"string"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"segment_price":{"type":"integer","description":"Price for that specific segment of the ferry journey\nin smallest unit of local currency, e.g. 200000\n","example":200000,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].segment_price","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.ferry_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.ferry_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.ferry_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.ferry_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.ferry_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.ferry_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.ferry_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.ferry_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.ferry_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.ferry_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.ferry_reservation_details","typeLabel":"object"},"hotel_reservation_details":{"type":"object","description":"Details about the reservation of hotel rooms.\n","required":["itinerary"],"properties":{"itinerary":{"type":"array","description":"Hotel itinerary data, one per hotel stay.\n\nIf you are selling a package that contains multiple hotel stays,\nyou need to provide itinerary data for each of the individual stays.\n","items":{"type":"object","required":["start_time","end_time","number_of_rooms","passenger_id","ticket_delivery_method","ticket_delivery_recipient","hotel_price"],"properties":{"start_time":{"type":"string","description":"Start time of the hotel stay (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","description":"End time of the hotel stay (ISO 8601 format), e.g. \"2023-08-20T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-20T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].end_time","typeLabel":"string"},"number_of_rooms":{"type":"integer","description":"Number of rooms booked, e.g. 2","example":2,"isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].number_of_rooms","typeLabel":"integer"},"passenger_id":{"type":"array","description":"IDs of all the passengers included in this itinerary.","example":[1],"items":{"type":"integer","uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].passenger_id.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].passenger_id","typeLabel":"integer[]"},"ticket_delivery_method":{"type":"string","enum":["pick_up","email","post","phone"],"example":"phone","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].ticket_delivery_method","typeLabel":"enum\u003cstring>"},"ticket_delivery_recipient":{"type":"string","description":"Name of the recipient the ticket is delivered to, e.g. \"Maximilian\".\n\nIf email or phone, then use either the email address or the phone number respectively.\n","example":"97712123","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].ticket_delivery_recipient","typeLabel":"string"},"hotel_price":{"type":"integer","description":"Price for the hotel stay in smallest unit of local currency, e.g. 200000\n","example":200000,"isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].hotel_price","typeLabel":"integer"},"hotel_name":{"type":"string","description":"Name of the hotel, e.g. \"Premium Hotel\"","example":"Premium Hotel","uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].hotel_name","typeLabel":"string"},"address":{"type":"object","description":"Address details of the hotel.","required":["city","country"],"properties":{"city":{"type":"string","description":"City the hotel is located in, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.city","typeLabel":"string"},"country":{"type":"string","description":"Country the hotel is located in (ISO 3166-1 alpha-2 format), e.g. \"NO\",\n","example":"NO","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address of the hotel, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code of the hotel, e.g. \"0159\"","example":"0159","uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address.postal_code","typeLabel":"string"}},"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].address","typeLabel":"object"},"class":{"type":"string","description":"Travel class, e.g. \"First Class\"","example":"First Class","uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.itinerary","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.hotel_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.hotel_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.hotel_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.hotel_reservation_details.insurance","typeLabel":"object[]"},"passengers":{"type":"array","description":"Passenger data, one per passenger.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.passengers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.hotel_reservation_details.passengers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.hotel_reservation_details.passengers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.hotel_reservation_details.passengers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.hotel_reservation_details.passengers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.hotel_reservation_details.passengers","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.hotel_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.hotel_reservation_details","typeLabel":"object"},"car_rental_reservation_details":{"type":"object","description":"Details about the reservation of rental cars.\n","required":["itinerary","drivers"],"properties":{"itinerary":{"type":"array","description":"Car rental itinerary data, one per car rental.\n\nIf you are selling a package that contains multiple car rentals,\nyou need to provide itinerary data for each of the individual rentals.\n","items":{"type":"object","required":["rental_company","start_time","end_time"],"properties":{"rental_company":{"type":"string","description":"Name of the car rental company, e.g. \"Premium Cars Ltd.\"","example":"Premium Cars","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].rental_company","typeLabel":"string"},"start_time":{"type":"string","description":"Start time of the car rental reservation (ISO 8601 format), e.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","description":"End time of the car rental reservation (ISO 8601 format), e.g. \"2023-08-20T15:00:00Z\".\n\nIf a timezone is not specified, we assume UTC.\n","example":"2023-08-20T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].end_time","typeLabel":"string"},"drivers_id":{"type":"array","description":"Driver IDs.","items":{"type":"integer","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drivers_id.items.[INDEX]","typeLabel":"integer"},"example":[1],"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drivers_id","typeLabel":"integer[]"},"pick_up_location":{"type":"object","description":"Details related to the pick up location.","required":["city","country"],"properties":{"city":{"type":"string","description":"City where the car should be picked up, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country where the car should be picked up (ISO 3166-1 alpha-2 format), e.g. \"NO\",\n","example":"NO","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address where the car should be picked up, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code where the car should be picked up, e.g. \"0159\"","example":"0159","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].pick_up_location","typeLabel":"object"},"drop_off_location":{"type":"object","description":"Details related to the drop off location.","required":["city","country"],"properties":{"city":{"type":"string","description":"City where the car should be dropped off, e.g. \"Oslo\"","example":"Oslo","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.city","typeLabel":"string"},"country":{"type":"string","description":"Country where the car should be dropped off (ISO 3166-1 alpha-2 format), e.g. \"NO\"\n","example":"NO","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.country","typeLabel":"string"},"street_address":{"type":"string","description":"Street address where the car should be dropped off, e.g. \"Karl Johans gt. 31\"","example":"Karl Johans gt. 31","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.street_address","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code where the car should be dropped off, e.g. \"0159\"","example":"0159","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location.postal_code","typeLabel":"string"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].drop_off_location","typeLabel":"object"},"car_price":{"type":"integer","description":"Price for the car rental reservation in smallest unit of local currency, e.g. 500000\n","example":500000,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].car_price","typeLabel":"integer"},"class":{"type":"string","description":"Travel class, e.g. \"Premium Cars Premium Class\"","example":"Premium Cars Premium Class","uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX].class","typeLabel":"string"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.itinerary","typeLabel":"object[]"},"drivers":{"type":"array","description":"Driver data, one per driver.","items":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the passenger, e.g. \"Paul\"","example":"Paul","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the passenger, e.g. \"Lamb\"","example":"Lamb","isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers.items.[INDEX].last_name","typeLabel":"string"},"id":{"type":"integer","description":"Passenger id, e.g. 1","example":1,"uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers.items.[INDEX].id","typeLabel":"integer"},"title":{"type":"string","enum":["mr","mrs","ms",""],"description":"Passenger title, e.g. \"mr\".\n\nBlank if under 12 years.\n","example":"mr","uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers.items.[INDEX].title","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.emd.travel.car_rental_reservation_details.drivers","typeLabel":"object[]"},"pnr":{"type":"string","description":"Trip booking number, e.g. \"VH67899\"\n","example":"VH67899","uniqueKey":"order.emd.travel.car_rental_reservation_details.pnr","typeLabel":"string"},"insurance":{"type":"array","description":"Insurance data, one per segment","items":{"type":"object","properties":{"insurance_company":{"type":"string","description":"Name of the company which offers the insurance, e.g. \"Oopsie Insurance Ltd.\"","example":"Oopsie Insurance Ltd.","uniqueKey":"order.emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_company","typeLabel":"string"},"insurance_type":{"type":"string","enum":["cancellation","travel","cancellation_travel","bankruptcy"],"description":"Type of insurance, e.g. \"travel\"","example":"travel","uniqueKey":"order.emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_type","typeLabel":"enum\u003cstring>"},"insurance_price":{"type":"integer","description":"Price of the insurance in smallest unit of local currency,\ne.g. 50000\n","example":50000,"uniqueKey":"order.emd.travel.car_rental_reservation_details.insurance.items.[INDEX].insurance_price","typeLabel":"integer"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details.insurance.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.emd.travel.car_rental_reservation_details.insurance","typeLabel":"object[]"},"affiliate_name":{"type":"string","description":"Name of the affiliate that originated the purchase.","example":"Klarna affiliate","uniqueKey":"order.emd.travel.car_rental_reservation_details.affiliate_name","typeLabel":"string"}},"uniqueKey":"order.emd.travel.car_rental_reservation_details","typeLabel":"object"}},"uniqueKey":"order.emd.travel","typeLabel":"object"},"marketplace_order":{"type":"object","description":"Only required if them item is related to a marketplace order.\n\nIf that is the case, you need to provide information about both the seller and\nthe winner.\n","required":["seller_info","winner_info"],"properties":{"seller_info":{"type":"object","description":"Details related to the seller involved in the marketplace order.\n","required":["sub_merchant_id","product_category","account_registration_date","account_last_modified","number_of_trades"],"properties":{"sub_merchant_id":{"type":"string","description":"Name or unique number of the selling/delivering merchant,\ne.g. \"Marketbrick Ltd.\"\n","example":"Marketbrick Ltd.","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.sub_merchant_id","typeLabel":"string"},"product_category":{"type":"string","description":"Name of the category to which the specific good belongs to,\naccording to the selling merchant's categorization, e.g. \"Phones\".\n","example":"Phones","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.product_category","typeLabel":"string"},"account_registration_date":{"type":"string","format":"date-time","description":"Date and time that the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_registration_date","typeLabel":"string\u003cdate-time>"},"account_last_modified":{"type":"object","required":["password","email","listing","login","address"],"properties":{"password":{"type":"string","format":"date-time","description":"Date and time that the password was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified.password","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","format":"date-time","description":"Date and time that the email was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified.email","typeLabel":"string\u003cdate-time>"},"listing":{"type":"string","format":"date-time","description":"Date and time that the listing details were last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified.listing","typeLabel":"string\u003cdate-time>"},"login":{"type":"string","format":"date-time","description":"Date and time that the login details were last changed (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified.login","typeLabel":"string\u003cdate-time>"},"address":{"type":"string","format":"date-time","description":"Date and time that the (physical) address was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified.address","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.account_last_modified","typeLabel":"object"},"number_of_trades":{"type":"integer","description":"Number of trades the sub-merchant did in the last 12 months, e.g. 23\n","example":23,"isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info.number_of_trades","typeLabel":"integer"},"unique_account_identifier_seller":{"type":"object","description":"Details about the seller.","properties":{"email":{"type":"string","description":"Seller's email address, e.g. \"seller@mail.com\"\n","uniqueKey":"order.emd.marketplace_order.seller_info.unique_account_identifier_seller.email","typeLabel":"string"},"phone_number":{"type":"string","description":"Seller's phone number, e.g. \"97712123\"","example":"97712123","uniqueKey":"order.emd.marketplace_order.seller_info.unique_account_identifier_seller.phone_number","typeLabel":"string"},"other":{"type":"string","uniqueKey":"order.emd.marketplace_order.seller_info.unique_account_identifier_seller.other","typeLabel":"string"}},"uniqueKey":"order.emd.marketplace_order.seller_info.unique_account_identifier_seller","typeLabel":"object"},"product_name":{"type":"string","description":"Name of the good purchased.\n","example":"iPhone 14 Pro Max","uniqueKey":"order.emd.marketplace_order.seller_info.product_name","typeLabel":"string"},"seller_rating":{"type":"number","description":"Current rating of the good purchased according\nto the marketplace's rating scale, e.g. 5\n","example":5,"uniqueKey":"order.emd.marketplace_order.seller_info.seller_rating","typeLabel":"number"},"volume_of_trades":{"type":"integer","description":"Volumes of trades the sub-merchant did in the last 12 months,\ne.g. 230\n","example":230,"uniqueKey":"order.emd.marketplace_order.seller_info.volume_of_trades","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"order.emd.marketplace_order.seller_info","typeLabel":"object"},"winner_info":{"type":"object","description":"Details related to the winner involved in the marketplace order.\n","required":["account_registration_date","account_last_modified","number_of_trades"],"properties":{"account_registration_date":{"type":"string","format":"date-time","description":"Date and time that the account was registered (ISO 8601 format),\ne.g. \"2023-08-16T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-16T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_registration_date","typeLabel":"string\u003cdate-time>"},"account_last_modified":{"type":"object","required":["password","email","listing","login","address"],"properties":{"password":{"type":"string","format":"date-time","description":"Date and time that the password was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified.password","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","format":"date-time","description":"Date and time that the email was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified.email","typeLabel":"string\u003cdate-time>"},"listing":{"type":"string","format":"date-time","description":"Date and time that the listing details were last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified.listing","typeLabel":"string\u003cdate-time>"},"login":{"type":"string","format":"date-time","description":"Date and time that the login details were last changed (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified.login","typeLabel":"string\u003cdate-time>"},"address":{"type":"string","format":"date-time","description":"Date and time that the (physical) address was last modified (ISO 8601 format),\ne.g. \"2023-08-17T15:00:00Z\".\n\nIf a timezone is not specified we assume UTC.\n","example":"2023-08-17T15:00:00Z","isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified.address","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.account_last_modified","typeLabel":"object"},"number_of_trades":{"type":"integer","description":"Number of trades the winner did in the last 12 months, e.g. 23\n","example":23,"isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info.number_of_trades","typeLabel":"integer"},"unique_account_identifier_winner":{"type":"object","description":"Details about the winner.","properties":{"email":{"type":"string","description":"Winner's email address, e.g. \"winner@mail.com\"\n","uniqueKey":"order.emd.marketplace_order.winner_info.unique_account_identifier_winner.email","typeLabel":"string"},"phone_number":{"type":"string","description":"Winner's phone number, e.g. \"97712123\"","example":"97712123","uniqueKey":"order.emd.marketplace_order.winner_info.unique_account_identifier_winner.phone_number","typeLabel":"string"},"other":{"type":"string","uniqueKey":"order.emd.marketplace_order.winner_info.unique_account_identifier_winner.other","typeLabel":"string"}},"uniqueKey":"order.emd.marketplace_order.winner_info.unique_account_identifier_winner","typeLabel":"object"},"volume_of_trades":{"type":"integer","description":"Volumes of trades the winner did in the last 12 months,\ne.g. 230\n","example":230,"uniqueKey":"order.emd.marketplace_order.winner_info.volume_of_trades","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"order.emd.marketplace_order.winner_info","typeLabel":"object"}},"uniqueKey":"order.emd.marketplace_order","typeLabel":"object"}},"uniqueKey":"order.emd","typeLabel":"object"},"payout_destination_id":{"type":"string","maxLength":40,"description":"An id that identifies the seller, value will be included\nin the settlement reports.\n\nNote: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations\n","uniqueKey":"order.payout_destination_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"configuration":{"type":"object","properties":{"auto_capture":{"type":"boolean","description":"If `true` the transaction from the payment session will be captured\nautomatically after the transaction has been `AUTHORIZED`. The checkout\nsessions `callback_url` will not be called until after the transaction\nhas been `CAPTURED`.\n\nIf `auto_capture` is not specified it defaults to `false`.\n\n`auto_capture` is ignored for `seitatech.in_person` payments. They\nare processed as a sale (authorized and captured in one step).\n\nA successful auto-capture of a transaction sometimes requires more\nthan one capture attempt. This can be the case if the payment gateway\nis down or is experiencing heavy traffic.\n\nDintero will attempts capture retries for 48 hours, the `callback_url`\nwill be invoked when capture succeeds.\n\nManual capture of a transaction that is pending auto-capture will\nstop the auto-capture process from completing the capture.\n","uniqueKey":"configuration.auto_capture","typeLabel":"boolean"},"channel":{"type":"string","enum":["ecommerce","in_app","in_store","hosted"],"default":"ecommerce","description":"`channel` enables special behaviour for various scenarios.\n\nThe majority of web integrations will not need to set this property.\n\n**`ecommerce`**\n\nThe default channel (also used if channel is not specified). The\nurl in the session created response body opens the Dintero Checkout\npage.\n\n**`in_app`**\n\nThe `in_app` channel is intended for payments done from\nmobile devices where `url.return_url` can be set to the\napplication's appswitch URL.\n\nCreating a session with `channel=in_app` will return an\nappswitch deeplink URL if the enabled payment options in\nthe session supports it\n\nAppswitch deeplink is currently only supported for sessions\nthat has only Vipps enabled via Dintero PSP, Vipps, Worldline\n(bambora) or Swedbank (payex), MobilePay enabled via\nWoldline (bambora) or Swedbank (payex) or Swish\n\n - configuration.vipps.enabled\n - configuration.payex.vipps.enabled\n - configuration.payex.mobilepay.enabled\n - configuration.dintero_psp.vipps.enabled\n - configuration.bambora.vipps.enabled\n - configuration.swish.swish.enabled\n\n> `in_app` is currently not supported when express is enabled\n> `in_app` with deeplink URL is not supported if `publish` is enabled\n\n**`in_store`**\n\nFor payments where the customer is present in a physical store.\nThe channel is stored on the transaction, and affects:\n\n - **Klarna**: sent with `acquiring_channel=in_store` and the\n `order.store` details as in-store payment data.\n - **Walley (`collector`)**: fraud analysis disabled, and the\n invoice is auto-activated when `auto_capture` is enabled.\n - **In-person (`seitatech.in_person`)**: set it to mark\n the transaction as in-store.\n\nOther payment types ignore the channel.\n\n**`hosted`**\n\nThe `hosted` channel will skip the Dintero Checkout page and the\nreturned `url` takes the end user directly to the payment service's\npayment page, if the enabled payment options in the session support it.\n\nIf the url to the hosted page is a universal link then visiting the\nurl can launch an app if the device used supports universal links\nand the payment app is installed on the device. The Vipps and\nMobilePay hosted page acts as a universal link.\n\nThe `hosted` channel is currently only supported for sessions that\nhave a single payment method enabled and the payment method is one of the\nfollowing:\n - configuration.vipps.enabled\n - configuration.payex.vipps.enabled\n - configuration.payex.mobilepay.enabled\n - configuration.dintero_psp.vipps.enabled\n - configuration.bambora.vipps.enabled\n\nIf the session contains more than one enabled payment method, or the\npayment method does not support the `hosted` channel, the setting is\nignored and the `url` will open the Dintero Checkout (the default\n`ecommerce` behaviour).\n","uniqueKey":"configuration.channel","typeLabel":"enum\u003cstring>"},"publish":{"description":"Publish checkout message to the customer.\n","type":"array","items":{"type":"object","required":["type","channel"],"properties":{"channel":{"type":"string","enum":["sms","push"],"isRequired":true,"uniqueKey":"configuration.publish.items.[INDEX].channel","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["checkout-link","app","terminal"],"isRequired":true,"uniqueKey":"configuration.publish.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","readOnly":true,"uniqueKey":"configuration.publish.items.[INDEX].id","typeLabel":"string"},"status":{"type":"string","readOnly":true,"description":"status of the message sent to the customer.\n\n**`skipped`** will used in case where publish\ncannot be sent given the `session.customer`.\n","enum":["sent","skipped","failed"],"uniqueKey":"configuration.publish.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.publish.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.publish","typeLabel":"object[]"},"active_payment_types":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Use this flag as wildcard to include all active payment types\nconfigured for a given currency when creating a payment session.\n","uniqueKey":"configuration.active_payment_types.enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.active_payment_types","typeLabel":"object"},"default_payment_type":{"type":"string","description":"Configure the default payment type, the selected payment when\nloading the checkout window. The value must be an enabled payment type.\n","enum":["bambora.applepay","bambora.creditcard","bambora.googlepay","bambora.mobilepay","bambora.vipps","dintero.zero","dintero_psp.applepay","dintero_psp.creditcard","dintero_psp.vipps","dintero_psp.googlepay","dintero_psp.clicktopay","instabank.finance","instabank.invoice","instabank.installment","instabank.postponement","vipps","payex.creditcard","payex.mobilepay","payex.swish","payex.vipps","payex.applepay","payex.clicktopay","payex.googlepay","collector.finance","collector.invoice","collector.invoice_b2b","collector.invoice_b2b_preapproved","collector.installment_b2b_preapproved","collector.installment","santander.debit_account","swish.swish","netaxept.creditcard","klarna.klarna","klarna.billie","kravia.invoice_b2b","kravia.invoice_b2b_grouped","kravia.invoice_b2c","seitatech.in_person","two.invoice_b2b","walley.checkout_b2b","walley.checkout_b2c"],"uniqueKey":"configuration.default_payment_type","typeLabel":"enum\u003cstring>"},"bambora":{"type":"object","description":"Bambora configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.bambora.type","typeLabel":"enum\u003cstring>"},"applepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"Enable Apple Pay Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.bambora.applepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.bambora.applepay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.bambora.applepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.applepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.applepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.bambora.applepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.bambora.applepay.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.bambora.applepay","typeLabel":"object"},"creditcard":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Credit Card Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.bambora.creditcard.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.bambora.creditcard.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.bambora.creditcard.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.creditcard.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.creditcard.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.bambora.creditcard.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.bambora.creditcard.payability_disabled_reasons","typeLabel":"object[]"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.bambora.creditcard.generate_payment_token","typeLabel":"boolean"}},"uniqueKey":"configuration.bambora.creditcard","typeLabel":"object"},"googlepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"Enable Google Pay Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.bambora.googlepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.bambora.googlepay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.bambora.googlepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.googlepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.googlepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.bambora.googlepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.bambora.googlepay.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.bambora.googlepay","typeLabel":"object"},"mobilepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable MobilePay Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.bambora.mobilepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.bambora.mobilepay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.bambora.mobilepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.mobilepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.mobilepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.bambora.mobilepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.bambora.mobilepay.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.bambora.mobilepay","typeLabel":"object"},"vipps":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Vipps Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.bambora.vipps.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.bambora.vipps.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.bambora.vipps.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.vipps.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.bambora.vipps.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.bambora.vipps.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.bambora.vipps.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.bambora.vipps","typeLabel":"object"}},"uniqueKey":"configuration.bambora","typeLabel":"object"},"dintero":{"type":"object","description":"Dintero configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.dintero.type","typeLabel":"enum\u003cstring>"},"wallets":{"type":"object","description":"Allow the payment session to be fully or partially authorized with\nDintero Wallets gift card.\n\nPlease note that the following payment methods are not supported together\nwith Dintero Wallets gift cards: `vipps`, `swish.swish`,\n`klarna.billie`, `collector`.\nCreating a session with Dintero Wallets and either of the abovementioned\npayment types enabled will result in an error.\n\nFor `kravia` and `two` payment is disabled if end customer adds a gift card in the checkout.\n","required":["enabled"],"properties":{"enabled":{"description":"enable gift card","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero.wallets.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero.wallets.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero.wallets.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.wallets.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.wallets.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero.wallets.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero.wallets.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.dintero.wallets","typeLabel":"object"},"zero":{"type":"object","description":"Allow initiating pay on zero amount session, the payability will only\nbe enabled if the session order amount is zero. Initiating a `dintero.zero`\npayment will result in a transaction with `dintero.zero` payment product type\nthat will be excluded from settlement reports (as it will not have any payout)\n","required":["enabled"],"properties":{"enabled":{"description":"enable zero amount session","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero.zero.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero.zero.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero.zero.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.zero.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.zero.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero.zero.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero.zero.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.dintero.zero","typeLabel":"object"},"external":{"type":"object","description":"Allow initiating pay on an external payment method.\n","required":["enabled","display"],"properties":{"enabled":{"description":"enable external payment method","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero.external.enabled","typeLabel":"boolean"},"display":{"type":"object","description":"Display configuration for the payment method\n","required":["payment_method_label","button_label"],"properties":{"payment_method_label":{"type":"string","maxLength":50,"description":"Label to be shown in Checkout for the payment method\n","isRequired":true,"uniqueKey":"configuration.dintero.external.display.payment_method_label","typeLabel":"string"},"button_label":{"type":"string","maxLength":50,"description":"Label to be shown on the pay button within the payment method\n","isRequired":true,"uniqueKey":"configuration.dintero.external.display.button_label","typeLabel":"string"},"content":{"type":"object","description":"Supplimentary content to be rendered within the payment method.\n\nHaving both `content.title` and `content.description` omitted will render just the pay button in the payment method.\n","properties":{"title":{"type":"string","maxLength":50,"description":"Title to be shown over the pay button within the payment method. If omitted, it will not be rendered.\n","uniqueKey":"configuration.dintero.external.display.content.title","typeLabel":"string"},"description":{"type":"string","maxLength":255,"description":"Description to be shown underneath the title within the payment method. If omitted, it will not be rendered.\n","uniqueKey":"configuration.dintero.external.display.content.description","typeLabel":"string"}},"uniqueKey":"configuration.dintero.external.display.content","typeLabel":"object"},"terms":{"type":"array","description":"Terms \u0026 conditions to be presented for the payment method\n","items":{"type":"object","maxItems":5,"required":["ref","href","label"],"properties":{"ref":{"type":"string","description":"Reference for the link\n","isRequired":true,"uniqueKey":"configuration.dintero.external.display.terms.items.[INDEX].ref","typeLabel":"string"},"label":{"type":"string","description":"Label to use in place of the link\n","isRequired":true,"uniqueKey":"configuration.dintero.external.display.terms.items.[INDEX].label","typeLabel":"string"},"href":{"type":"string","format":"uri","description":"URL of the link\n","isRequired":true,"uniqueKey":"configuration.dintero.external.display.terms.items.[INDEX].href","typeLabel":"string\u003curi>"}},"uniqueKey":"configuration.dintero.external.display.terms.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero.external.display.terms","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"configuration.dintero.external.display","typeLabel":"object"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero.external.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero.external.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.external.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero.external.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero.external.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero.external.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.dintero.external","typeLabel":"object"}},"uniqueKey":"configuration.dintero","typeLabel":"object"},"dintero_psp":{"type":"object","description":"Dintero PSP configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.dintero_psp.type","typeLabel":"enum\u003cstring>"},"creditcard":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable creditcard","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero_psp.creditcard.type","typeLabel":"enum\u003cstring>"},"card_brands":{"type":"array","description":"Card brands available for this payment product. Read-only.","readOnly":true,"items":{"type":"string","enum":["visa","mastercard","maestro"],"uniqueKey":"configuration.dintero_psp.creditcard.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.dintero_psp.creditcard.card_brands","typeLabel":"enum\u003cstring>[]"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero_psp.creditcard.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.creditcard.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.creditcard.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.creditcard.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero_psp.creditcard.payability_disabled_reasons","typeLabel":"object[]"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.dintero_psp.creditcard.generate_payment_token","typeLabel":"boolean"},"token_supported_auth_methods":{"type":"array","description":"Indicates which authentication methods to support during token authentication flows.\nThe list order determines which method is preferred.\nMethods are subject to card and device support.\n\n- `3DS`: Carholder authentication through 3D-Secure.\n- `PASSKEY`: Cardholder is prompted to create and authenticate with a device-bound Passkey.\n","example":["PASSKEY","3DS"],"items":{"type":"string","enum":["3DS","PASSKEY"],"uniqueKey":"configuration.dintero_psp.creditcard.token_supported_auth_methods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.dintero_psp.creditcard.token_supported_auth_methods","typeLabel":"enum\u003cstring>[]"},"sca_policy":{"type":"object","description":"Configuration for SCA (Strong Customer Authentication) policies for Dintero PSP payment methods.\nAllows merchants to set up exemptions for when SCA can be skipped for a transaction.\nIf SCA is skipped for a transaction the merchant will generally have liability for the transaction.\n","properties":{"network_exemptions":{"type":"object","description":"Configuration for network exemptions, such as low_value and low_risk exemptions.\nThe merchant can choose to enable/disable each exemption type, but they need to be\napproved to use them by Dintero. Low risk exemption takes precedence over low value exemption.\n","properties":{"low_value":{"type":"boolean","description":"If true the low value exemption can be passed to issuer if the transaction amount is below 30 EUR or equivalent.\n","example":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.network_exemptions.low_value","typeLabel":"boolean"},"low_risk":{"type":"boolean","description":"If true the low risk exemption can be passed to issuer.\n","example":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.network_exemptions.low_risk","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.network_exemptions","typeLabel":"object"},"liability_rules":{"type":"array","description":"List of rules for when SCA can be skipped for a transaction.\nIf multiple rules match the most restrictive rule will be applied.\n","items":{"type":"object","title":"amount_lte","required":["limit","issuer_countries","enabled","type"],"x-discriminator-value":"amount_lte","properties":{"type":{"type":"string","description":"The type of rule.","enum":["amount_lte"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"limit":{"type":"array","description":"The maximum transaction amounts in the smallest currency unit (e.g., cents) for which SCA (Strong Customer Authentication) can be exempted.\n","uniqueItems":true,"maxItems":250,"items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":"The maximum transaction amount in the smallest currency unit (e.g., cents).\n","example":50000,"isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The ISO 4217 currency code for the limit.","example":"NOK","isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].limit","typeLabel":"object[]"},"issuer_countries":{"type":"array","description":"List of country codes (ISO 3166-1 alpha-2) for which the merchant can add exemptions for.\nAdd a wildcard (`*`) to a allow all countries. Leaving it empty will not allow skipping SCA.\n","uniqueItems":true,"maxItems":250,"items":{"type":"string","description":"A valid ISO 3166-1 alpha-2 country code","pattern":"^([A-Z]{2}|\\*)$","uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].issuer_countries.items.[INDEX]","typeLabel":"string"},"example":["NO","SE","DK"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].issuer_countries","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether or not the rule is applied.\n","isRequired":true,"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules.items.[INDEX]","typeLabel":"amount_lte · object"},"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy.liability_rules","typeLabel":"amount_lte · object[]"}},"uniqueKey":"configuration.dintero_psp.creditcard.sca_policy","typeLabel":"object"},"generate_payment_token_config":{"type":"object","additionalProperties":false,"description":"Configuration for generating payment token. If `generate_payment_token` is true and \nconfiguration is omitted, the card will be tokenized.\n","properties":{"save_card_checkbox":{"type":"string","enum":["opt_in","opt_out"],"description":"`opt_in` - Cardholder needs to opt-in to saving card, so the checkbox should not be checked by default.\n`opt_out` - Cardholder needs to opt-out of saving card, so the checkbox should be checked by default.\n\n`generate_payment_token` must be true for this to have any effect. If `generate_payment_token` is true\nand `save_card_checkbox` is omitted, the card will be tokenized.\n","uniqueKey":"configuration.dintero_psp.creditcard.generate_payment_token_config.save_card_checkbox","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.dintero_psp.creditcard.generate_payment_token_config","typeLabel":"object"}},"uniqueKey":"configuration.dintero_psp.creditcard","typeLabel":"object"},"vipps":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Vipps","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero_psp.vipps.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero_psp.vipps.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.vipps.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.vipps.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.vipps.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero_psp.vipps.payability_disabled_reasons","typeLabel":"object[]"},"sca_policy":{"type":"object","description":"Configuration for SCA (Strong Customer Authentication) policies for Dintero PSP payment methods.\nAllows merchants to set up exemptions for when SCA can be skipped for a transaction.\nIf SCA is skipped for a transaction the merchant will generally have liability for the transaction.\n","properties":{"network_exemptions":{"type":"object","description":"Configuration for network exemptions, such as low_value and low_risk exemptions.\nThe merchant can choose to enable/disable each exemption type, but they need to be\napproved to use them by Dintero. Low risk exemption takes precedence over low value exemption.\n","properties":{"low_value":{"type":"boolean","description":"If true the low value exemption can be passed to issuer if the transaction amount is below 30 EUR or equivalent.\n","example":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.network_exemptions.low_value","typeLabel":"boolean"},"low_risk":{"type":"boolean","description":"If true the low risk exemption can be passed to issuer.\n","example":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.network_exemptions.low_risk","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.network_exemptions","typeLabel":"object"},"liability_rules":{"type":"array","description":"List of rules for when SCA can be skipped for a transaction.\nIf multiple rules match the most restrictive rule will be applied.\n","items":{"type":"object","title":"amount_lte","required":["limit","issuer_countries","enabled","type"],"x-discriminator-value":"amount_lte","properties":{"type":{"type":"string","description":"The type of rule.","enum":["amount_lte"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"limit":{"type":"array","description":"The maximum transaction amounts in the smallest currency unit (e.g., cents) for which SCA (Strong Customer Authentication) can be exempted.\n","uniqueItems":true,"maxItems":250,"items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":"The maximum transaction amount in the smallest currency unit (e.g., cents).\n","example":50000,"isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The ISO 4217 currency code for the limit.","example":"NOK","isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].limit","typeLabel":"object[]"},"issuer_countries":{"type":"array","description":"List of country codes (ISO 3166-1 alpha-2) for which the merchant can add exemptions for.\nAdd a wildcard (`*`) to a allow all countries. Leaving it empty will not allow skipping SCA.\n","uniqueItems":true,"maxItems":250,"items":{"type":"string","description":"A valid ISO 3166-1 alpha-2 country code","pattern":"^([A-Z]{2}|\\*)$","uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].issuer_countries.items.[INDEX]","typeLabel":"string"},"example":["NO","SE","DK"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].issuer_countries","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether or not the rule is applied.\n","isRequired":true,"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules.items.[INDEX]","typeLabel":"amount_lte · object"},"uniqueKey":"configuration.dintero_psp.vipps.sca_policy.liability_rules","typeLabel":"amount_lte · object[]"}},"uniqueKey":"configuration.dintero_psp.vipps.sca_policy","typeLabel":"object"}},"uniqueKey":"configuration.dintero_psp.vipps","typeLabel":"object"},"applepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Apple Pay","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero_psp.applepay.type","typeLabel":"enum\u003cstring>"},"card_brands":{"type":"array","description":"Card brands available for this payment product. Read-only.","readOnly":true,"items":{"type":"string","enum":["visa","mastercard","maestro"],"uniqueKey":"configuration.dintero_psp.applepay.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.dintero_psp.applepay.card_brands","typeLabel":"enum\u003cstring>[]"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero_psp.applepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.applepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.applepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.applepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero_psp.applepay.payability_disabled_reasons","typeLabel":"object[]"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.dintero_psp.applepay.generate_payment_token","typeLabel":"boolean"},"sca_policy":{"type":"object","description":"Configuration for SCA (Strong Customer Authentication) policies for Dintero PSP payment methods.\nAllows merchants to set up exemptions for when SCA can be skipped for a transaction.\nIf SCA is skipped for a transaction the merchant will generally have liability for the transaction.\n","properties":{"network_exemptions":{"type":"object","description":"Configuration for network exemptions, such as low_value and low_risk exemptions.\nThe merchant can choose to enable/disable each exemption type, but they need to be\napproved to use them by Dintero. Low risk exemption takes precedence over low value exemption.\n","properties":{"low_value":{"type":"boolean","description":"If true the low value exemption can be passed to issuer if the transaction amount is below 30 EUR or equivalent.\n","example":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.network_exemptions.low_value","typeLabel":"boolean"},"low_risk":{"type":"boolean","description":"If true the low risk exemption can be passed to issuer.\n","example":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.network_exemptions.low_risk","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.network_exemptions","typeLabel":"object"},"liability_rules":{"type":"array","description":"List of rules for when SCA can be skipped for a transaction.\nIf multiple rules match the most restrictive rule will be applied.\n","items":{"type":"object","title":"amount_lte","required":["limit","issuer_countries","enabled","type"],"x-discriminator-value":"amount_lte","properties":{"type":{"type":"string","description":"The type of rule.","enum":["amount_lte"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"limit":{"type":"array","description":"The maximum transaction amounts in the smallest currency unit (e.g., cents) for which SCA (Strong Customer Authentication) can be exempted.\n","uniqueItems":true,"maxItems":250,"items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":"The maximum transaction amount in the smallest currency unit (e.g., cents).\n","example":50000,"isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The ISO 4217 currency code for the limit.","example":"NOK","isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].limit","typeLabel":"object[]"},"issuer_countries":{"type":"array","description":"List of country codes (ISO 3166-1 alpha-2) for which the merchant can add exemptions for.\nAdd a wildcard (`*`) to a allow all countries. Leaving it empty will not allow skipping SCA.\n","uniqueItems":true,"maxItems":250,"items":{"type":"string","description":"A valid ISO 3166-1 alpha-2 country code","pattern":"^([A-Z]{2}|\\*)$","uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].issuer_countries.items.[INDEX]","typeLabel":"string"},"example":["NO","SE","DK"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].issuer_countries","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether or not the rule is applied.\n","isRequired":true,"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules.items.[INDEX]","typeLabel":"amount_lte · object"},"uniqueKey":"configuration.dintero_psp.applepay.sca_policy.liability_rules","typeLabel":"amount_lte · object[]"}},"uniqueKey":"configuration.dintero_psp.applepay.sca_policy","typeLabel":"object"},"details":{"type":"object","properties":{"domain_names":{"description":"An array of domain names used for embedding the checkout with Apple Pay. The value is just the domain name, without the protocol, port or path.\n","type":"array","items":{"type":"string","example":"example.dintero.com","uniqueKey":"configuration.dintero_psp.applepay.details.domain_names.items.[INDEX]","typeLabel":"string"},"uniqueKey":"configuration.dintero_psp.applepay.details.domain_names","typeLabel":"string[]"},"token_event_notification_url":{"type":"string","description":"URL used for recieving of merchant token notifications. It should\nbe set as `tokenNotificationURL` parameter when reccuring/MIT\npayment is being created.\n","uniqueKey":"configuration.dintero_psp.applepay.details.token_event_notification_url","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.applepay.details","typeLabel":"object"}},"uniqueKey":"configuration.dintero_psp.applepay","typeLabel":"object"},"googlepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Google Pay","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero_psp.googlepay.type","typeLabel":"enum\u003cstring>"},"card_brands":{"type":"array","description":"Card brands available for this payment product. Read-only.","readOnly":true,"items":{"type":"string","enum":["visa","mastercard"],"uniqueKey":"configuration.dintero_psp.googlepay.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.dintero_psp.googlepay.card_brands","typeLabel":"enum\u003cstring>[]"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero_psp.googlepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.googlepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.googlepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.googlepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero_psp.googlepay.payability_disabled_reasons","typeLabel":"object[]"},"sca_policy":{"type":"object","description":"Configuration for SCA (Strong Customer Authentication) policies for Dintero PSP payment methods.\nAllows merchants to set up exemptions for when SCA can be skipped for a transaction.\nIf SCA is skipped for a transaction the merchant will generally have liability for the transaction.\n","properties":{"network_exemptions":{"type":"object","description":"Configuration for network exemptions, such as low_value and low_risk exemptions.\nThe merchant can choose to enable/disable each exemption type, but they need to be\napproved to use them by Dintero. Low risk exemption takes precedence over low value exemption.\n","properties":{"low_value":{"type":"boolean","description":"If true the low value exemption can be passed to issuer if the transaction amount is below 30 EUR or equivalent.\n","example":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.network_exemptions.low_value","typeLabel":"boolean"},"low_risk":{"type":"boolean","description":"If true the low risk exemption can be passed to issuer.\n","example":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.network_exemptions.low_risk","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.network_exemptions","typeLabel":"object"},"liability_rules":{"type":"array","description":"List of rules for when SCA can be skipped for a transaction.\nIf multiple rules match the most restrictive rule will be applied.\n","items":{"type":"object","title":"amount_lte","required":["limit","issuer_countries","enabled","type"],"x-discriminator-value":"amount_lte","properties":{"type":{"type":"string","description":"The type of rule.","enum":["amount_lte"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"limit":{"type":"array","description":"The maximum transaction amounts in the smallest currency unit (e.g., cents) for which SCA (Strong Customer Authentication) can be exempted.\n","uniqueItems":true,"maxItems":250,"items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":"The maximum transaction amount in the smallest currency unit (e.g., cents).\n","example":50000,"isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The ISO 4217 currency code for the limit.","example":"NOK","isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].limit","typeLabel":"object[]"},"issuer_countries":{"type":"array","description":"List of country codes (ISO 3166-1 alpha-2) for which the merchant can add exemptions for.\nAdd a wildcard (`*`) to a allow all countries. Leaving it empty will not allow skipping SCA.\n","uniqueItems":true,"maxItems":250,"items":{"type":"string","description":"A valid ISO 3166-1 alpha-2 country code","pattern":"^([A-Z]{2}|\\*)$","uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].issuer_countries.items.[INDEX]","typeLabel":"string"},"example":["NO","SE","DK"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].issuer_countries","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether or not the rule is applied.\n","isRequired":true,"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules.items.[INDEX]","typeLabel":"amount_lte · object"},"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy.liability_rules","typeLabel":"amount_lte · object[]"}},"uniqueKey":"configuration.dintero_psp.googlepay.sca_policy","typeLabel":"object"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.dintero_psp.googlepay.generate_payment_token","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.googlepay","typeLabel":"object"},"clicktopay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Visa Click-to-Pay","type":"boolean","isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.dintero_psp.clicktopay.type","typeLabel":"enum\u003cstring>"},"card_brands":{"type":"array","description":"Card brands available for this payment product. Read-only.","readOnly":true,"items":{"type":"string","enum":["visa","mastercard"],"uniqueKey":"configuration.dintero_psp.clicktopay.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.dintero_psp.clicktopay.card_brands","typeLabel":"enum\u003cstring>[]"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.dintero_psp.clicktopay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.clicktopay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.dintero_psp.clicktopay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.clicktopay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.dintero_psp.clicktopay.payability_disabled_reasons","typeLabel":"object[]"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.dintero_psp.clicktopay.generate_payment_token","typeLabel":"boolean"},"sca_policy":{"type":"object","description":"Configuration for SCA (Strong Customer Authentication) policies for Dintero PSP payment methods.\nAllows merchants to set up exemptions for when SCA can be skipped for a transaction.\nIf SCA is skipped for a transaction the merchant will generally have liability for the transaction.\n","properties":{"network_exemptions":{"type":"object","description":"Configuration for network exemptions, such as low_value and low_risk exemptions.\nThe merchant can choose to enable/disable each exemption type, but they need to be\napproved to use them by Dintero. Low risk exemption takes precedence over low value exemption.\n","properties":{"low_value":{"type":"boolean","description":"If true the low value exemption can be passed to issuer if the transaction amount is below 30 EUR or equivalent.\n","example":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.network_exemptions.low_value","typeLabel":"boolean"},"low_risk":{"type":"boolean","description":"If true the low risk exemption can be passed to issuer.\n","example":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.network_exemptions.low_risk","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.network_exemptions","typeLabel":"object"},"liability_rules":{"type":"array","description":"List of rules for when SCA can be skipped for a transaction.\nIf multiple rules match the most restrictive rule will be applied.\n","items":{"type":"object","title":"amount_lte","required":["limit","issuer_countries","enabled","type"],"x-discriminator-value":"amount_lte","properties":{"type":{"type":"string","description":"The type of rule.","enum":["amount_lte"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"limit":{"type":"array","description":"The maximum transaction amounts in the smallest currency unit (e.g., cents) for which SCA (Strong Customer Authentication) can be exempted.\n","uniqueItems":true,"maxItems":250,"items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":"The maximum transaction amount in the smallest currency unit (e.g., cents).\n","example":50000,"isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The ISO 4217 currency code for the limit.","example":"NOK","isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].limit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].limit","typeLabel":"object[]"},"issuer_countries":{"type":"array","description":"List of country codes (ISO 3166-1 alpha-2) for which the merchant can add exemptions for.\nAdd a wildcard (`*`) to a allow all countries. Leaving it empty will not allow skipping SCA.\n","uniqueItems":true,"maxItems":250,"items":{"type":"string","description":"A valid ISO 3166-1 alpha-2 country code","pattern":"^([A-Z]{2}|\\*)$","uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].issuer_countries.items.[INDEX]","typeLabel":"string"},"example":["NO","SE","DK"],"isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].issuer_countries","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether or not the rule is applied.\n","isRequired":true,"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules.items.[INDEX]","typeLabel":"amount_lte · object"},"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy.liability_rules","typeLabel":"amount_lte · object[]"}},"uniqueKey":"configuration.dintero_psp.clicktopay.sca_policy","typeLabel":"object"}},"uniqueKey":"configuration.dintero_psp.clicktopay","typeLabel":"object"}},"uniqueKey":"configuration.dintero_psp","typeLabel":"object"},"instabank":{"type":"object","properties":{"finance":{"type":"object","description":"finance payment","required":["enabled"],"properties":{"enabled":{"description":"enable finance payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.instabank.finance.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.instabank.finance.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.finance.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.finance.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.instabank.finance.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.finance.payability_disabled_reasons","typeLabel":"object[]"},"product":{"type":"object","required":["product_code","minimum_monthly_balance_rate","origination_fee","notification_fee","loan_example"],"properties":{"product_code":{"type":"string","example":"630","isRequired":true,"uniqueKey":"configuration.instabank.finance.product.product_code","typeLabel":"string"},"minimum_monthly_balance_rate":{"type":"string","description":"The minimum monthly installment basis as a percentage of the account balance.\n","format":"^([0-9]*[.])?[0-9]+$","example":"1.67","isRequired":true,"uniqueKey":"configuration.instabank.finance.product.minimum_monthly_balance_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"},"origination_fee":{"type":"integer","description":"The startup fee for the payment product.\n","minimum":0,"example":9500,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.origination_fee","typeLabel":"integer"},"notification_fee":{"type":"integer","description":"The notification fee for the payment product.\n","minimum":0,"example":3900,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.notification_fee","typeLabel":"integer"},"loan_example":{"type":"object","required":["amount","years","total_amount","cost","effective_annual_interest_rate"],"properties":{"amount":{"type":"integer","description":"The amount loaned in the example.\n","minimum":0,"example":2500000,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example.amount","typeLabel":"integer"},"years":{"type":"integer","description":"Years of payment in the example.\n","minimum":1,"example":1,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example.years","typeLabel":"integer"},"total_amount":{"type":"integer","description":"The total amount paid back in the example.\n","minimum":0,"example":2772300,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example.total_amount","typeLabel":"integer"},"cost":{"type":"integer","description":"The cost of the loan in the example.\n","minimum":0,"example":272300,"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example.cost","typeLabel":"integer"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"format":"^([0-9]*[.])?[0-9]+$","description":"The effective annual interest rate in the example\n","example":"21.38","isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example.effective_annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"}},"isRequired":true,"uniqueKey":"configuration.instabank.finance.product.loan_example","typeLabel":"object"},"annual_interest_rate":{"type":"string","description":"The interest rate for the payment product.\n","format":"^([0-9]*[.])?[0-9]+$","example":"0.0","uniqueKey":"configuration.instabank.finance.product.annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"description":"The effective annual interest rate for the payment product\n","example":"0.0","uniqueKey":"configuration.instabank.finance.product.effective_annual_interest_rate","typeLabel":"string"},"minimum_amount":{"type":"integer","description":"Minimum order amount for this product. The product option will be\nexcluded in payments where the order amount is less than the minimum\namount.\n","example":20000,"minimum":1,"uniqueKey":"configuration.instabank.finance.product.minimum_amount","typeLabel":"integer"},"branding_image_url":{"type":"string","description":"Url for a custom branding image","uniqueKey":"configuration.instabank.finance.product.branding_image_url","typeLabel":"string"}},"uniqueKey":"configuration.instabank.finance.product","typeLabel":"object"}},"uniqueKey":"configuration.instabank.finance","typeLabel":"object"},"invoice":{"type":"object","description":"invoice payment","required":["enabled"],"properties":{"enabled":{"description":"enable invoice payment (only for amounts greater than 500 NOK)","type":"boolean","isRequired":true,"uniqueKey":"configuration.instabank.invoice.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.instabank.invoice.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.invoice.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.invoice.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.instabank.invoice.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.invoice.payability_disabled_reasons","typeLabel":"object[]"},"require_applicant":{"type":"boolean","uniqueKey":"configuration.instabank.invoice.require_applicant","typeLabel":"boolean"},"product":{"type":"object","required":["product_code","due_in_days","invoice_fee","require_applicant_amount"],"properties":{"product_code":{"type":"string","example":"632","isRequired":true,"uniqueKey":"configuration.instabank.invoice.product.product_code","typeLabel":"string"},"due_in_days":{"type":"integer","minimum":0,"description":"Number of days before the payment is due.","example":10,"isRequired":true,"uniqueKey":"configuration.instabank.invoice.product.due_in_days","typeLabel":"integer"},"invoice_fee":{"type":"integer","description":"The fee for the payment product\n","minimum":0,"example":9500,"isRequired":true,"uniqueKey":"configuration.instabank.invoice.product.invoice_fee","typeLabel":"integer"},"require_applicant_amount":{"type":"integer","description":"The limit for when instabank will require a full applicant during payment.\n","minimum":0,"example":7500000,"isRequired":true,"uniqueKey":"configuration.instabank.invoice.product.require_applicant_amount","typeLabel":"integer"},"minimum_amount":{"type":"integer","description":"Minimum order amount for this product. The product option will be\nexcluded in payments where the order amount is less than the minimum\namount.\n","example":20000,"minimum":1,"uniqueKey":"configuration.instabank.invoice.product.minimum_amount","typeLabel":"integer"},"branding_image_url":{"type":"string","description":"Url for a custom branding image","uniqueKey":"configuration.instabank.invoice.product.branding_image_url","typeLabel":"string"}},"uniqueKey":"configuration.instabank.invoice.product","typeLabel":"object"}},"uniqueKey":"configuration.instabank.invoice","typeLabel":"object"},"installment":{"type":"object","description":"Fixed Part Payment","required":["enabled"],"properties":{"enabled":{"description":"enable Instabank Installment Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.instabank.installment.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.instabank.installment.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.instabank.installment.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.installment.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.installment.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.instabank.installment.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.installment.payability_disabled_reasons","typeLabel":"object[]"},"products":{"readOnly":true,"type":"array","items":{"type":"object","description":"Payment product configuration\n","required":["product_code","credit_time","origination_fee","notification_fee","annual_interest_rate"],"properties":{"product_code":{"type":"string","example":"633","isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].product_code","typeLabel":"string"},"credit_time":{"type":"integer","description":"Number of months\n","minimum":1,"example":36,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].credit_time","typeLabel":"integer"},"origination_fee":{"type":"integer","description":"The startup fee for the payment product\n","minimum":0,"example":9500,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].origination_fee","typeLabel":"integer"},"notification_fee":{"type":"integer","description":"The notification fee for the payment product\n","minimum":0,"example":3900,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].notification_fee","typeLabel":"integer"},"annual_interest_rate":{"type":"string","description":"The interest rate for the payment product.\n","format":"^([0-9]*[.])?[0-9]+$","example":"0.0","isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"},"minimum_amount":{"type":"integer","description":"Minimum order amount for this product. The product option will be\nexcluded in payments where the order amount is less than the minimum\namount.\n","example":20000,"minimum":1,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].minimum_amount","typeLabel":"integer"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"description":"The effective annual interest rate for the payment product\n","example":"54.69","uniqueKey":"configuration.instabank.installment.products.items.[INDEX].effective_annual_interest_rate","typeLabel":"string"},"total_amount":{"type":"integer","readOnly":true,"example":309400,"description":"The total amount to pay","uniqueKey":"configuration.instabank.installment.products.items.[INDEX].total_amount","typeLabel":"integer"},"monthly_amount":{"type":"integer","readOnly":true,"example":100000,"description":"The amount to pay pr month","uniqueKey":"configuration.instabank.installment.products.items.[INDEX].monthly_amount","typeLabel":"integer"},"first_monthly_amount":{"type":"integer","readOnly":true,"description":"The amount to pay in the first invoice. Origantion fee is added\nto the first invoice.\n","example":109500,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].first_monthly_amount","typeLabel":"integer"},"require_applicant_amount":{"type":"integer","description":"The limit for when instabank will require a full applicant during payment.\n","minimum":0,"example":2500000,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].require_applicant_amount","typeLabel":"integer"},"loan_example":{"type":"object","required":["amount","years","total_amount","cost","effective_annual_interest_rate"],"properties":{"amount":{"type":"integer","description":"The amount loaned in the example.\n","minimum":0,"example":2500000,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example.amount","typeLabel":"integer"},"years":{"type":"integer","description":"Years of payment in the example.\n","minimum":1,"example":1,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example.years","typeLabel":"integer"},"total_amount":{"type":"integer","description":"The total amount paid back in the example.\n","minimum":0,"example":2772300,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example.total_amount","typeLabel":"integer"},"cost":{"type":"integer","description":"The cost of the loan in the example.\n","minimum":0,"example":272300,"isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example.cost","typeLabel":"integer"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"format":"^([0-9]*[.])?[0-9]+$","description":"The effective annual interest rate in the example\n","example":"21.38","isRequired":true,"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example.effective_annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"}},"uniqueKey":"configuration.instabank.installment.products.items.[INDEX].loan_example","typeLabel":"object"},"branding_image_url":{"type":"string","description":"Url for a custom branding image","uniqueKey":"configuration.instabank.installment.products.items.[INDEX].branding_image_url","typeLabel":"string"}},"uniqueKey":"configuration.instabank.installment.products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.installment.products","typeLabel":"object[]"}},"uniqueKey":"configuration.instabank.installment","typeLabel":"object"},"postponement":{"type":"object","description":"Postpone payment","required":["enabled"],"properties":{"enabled":{"description":"enable Instabank Postponement Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.instabank.postponement.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.instabank.postponement.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.instabank.postponement.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.postponement.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.instabank.postponement.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.instabank.postponement.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.postponement.payability_disabled_reasons","typeLabel":"object[]"},"products":{"readOnly":true,"type":"array","items":{"type":"object","description":"Payment product configuration\n","required":["product_code","postponement_months","origination_fee","annual_interest_rate"],"properties":{"product_code":{"type":"string","example":"633","isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].product_code","typeLabel":"string"},"postponement_months":{"type":"integer","description":"Number of months\n","minimum":1,"example":36,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].postponement_months","typeLabel":"integer"},"origination_fee":{"type":"integer","description":"The startup fee for the payment product\n","minimum":0,"example":9500,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].origination_fee","typeLabel":"integer"},"annual_interest_rate":{"type":"string","description":"The interest rate for the payment product.\n","format":"^([0-9]*[.])?[0-9]+$","example":"0.0","isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"},"minimum_amount":{"type":"integer","description":"Minimum order amount for this product. The product option will be\nexcluded in payments where the order amount is less than the minimum\namount.\n","example":20000,"minimum":1,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].minimum_amount","typeLabel":"integer"},"notification_fee":{"type":"integer","description":"The notification fee for the payment product\n","minimum":0,"example":3900,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].notification_fee","typeLabel":"integer"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"description":"The effective annual interest rate for the payment product\n","example":"54.69","uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].effective_annual_interest_rate","typeLabel":"string"},"total_amount":{"type":"integer","readOnly":true,"example":309400,"description":"The total amount to pay","uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].total_amount","typeLabel":"integer"},"require_applicant_amount":{"type":"integer","description":"The limit for when instabank will require a full applicant during payment.\n","minimum":0,"example":2500000,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].require_applicant_amount","typeLabel":"integer"},"loan_example":{"type":"object","required":["amount","years","total_amount","cost","effective_annual_interest_rate"],"properties":{"amount":{"type":"integer","description":"The amount loaned in the example.\n","minimum":0,"example":2500000,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example.amount","typeLabel":"integer"},"years":{"type":"integer","description":"Years of payment in the example.\n","minimum":1,"example":1,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example.years","typeLabel":"integer"},"total_amount":{"type":"integer","description":"The total amount paid back in the example.\n","minimum":0,"example":2772300,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example.total_amount","typeLabel":"integer"},"cost":{"type":"integer","description":"The cost of the loan in the example.\n","minimum":0,"example":272300,"isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example.cost","typeLabel":"integer"},"effective_annual_interest_rate":{"type":"string","readOnly":true,"format":"^([0-9]*[.])?[0-9]+$","description":"The effective annual interest rate in the example\n","example":"21.38","isRequired":true,"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example.effective_annual_interest_rate","typeLabel":"string\u003c^([0-9]*[.])?[0-9]+$>"}},"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].loan_example","typeLabel":"object"},"branding_image_url":{"type":"string","description":"Url for a custom branding image","uniqueKey":"configuration.instabank.postponement.products.items.[INDEX].branding_image_url","typeLabel":"string"}},"uniqueKey":"configuration.instabank.postponement.products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.instabank.postponement.products","typeLabel":"object[]"}},"uniqueKey":"configuration.instabank.postponement","typeLabel":"object"}},"uniqueKey":"configuration.instabank","typeLabel":"object"},"netaxept":{"type":"object","description":"Netaxept configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.netaxept.type","typeLabel":"enum\u003cstring>"},"creditcard":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Credit Card Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.netaxept.creditcard.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.netaxept.creditcard.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.netaxept.creditcard.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.netaxept.creditcard.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.netaxept.creditcard.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.netaxept.creditcard.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.netaxept.creditcard.payability_disabled_reasons","typeLabel":"object[]"},"terminal":{"type":"object","description":"Use Netaxept terminal instead of Dintero Checkout\n\nSee https://shop.nets.eu/web/partners/register\n","required":["terminal","terminal_single_page"],"properties":{"terminal":{"type":"string","enum":["/Terminal/default.aspx","/terminal/mobile/default.aspx"],"isRequired":true,"uniqueKey":"configuration.netaxept.creditcard.terminal.terminal","typeLabel":"enum\u003cstring>"},"terminal_single_page":{"description":"Set hosted payment window to single page","type":"boolean","isRequired":true,"uniqueKey":"configuration.netaxept.creditcard.terminal.terminal_single_page","typeLabel":"boolean"},"terminal_design":{"description":"Name of the terminal template to use, created in Netaxept Admin\n","type":"string","uniqueKey":"configuration.netaxept.creditcard.terminal.terminal_design","typeLabel":"string"},"terminal_layout":{"type":"string","uniqueKey":"configuration.netaxept.creditcard.terminal.terminal_layout","typeLabel":"string"}},"uniqueKey":"configuration.netaxept.creditcard.terminal","typeLabel":"object"}},"uniqueKey":"configuration.netaxept.creditcard","typeLabel":"object"}},"uniqueKey":"configuration.netaxept","typeLabel":"object"},"payex":{"type":"object","properties":{"dynamic_descriptor":{"type":"string","maxLength":40,"description":"A textual description max 40 characters of the purchase.\n","uniqueKey":"configuration.payex.dynamic_descriptor","typeLabel":"string"},"swish":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Payex Swish Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.swish.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.swish.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.swish.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.swish.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.swish.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.swish.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.payex.swish","typeLabel":"object"},"creditcard":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Credit Card Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.creditcard.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.creditcard.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.creditcard.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.creditcard.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.creditcard.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.creditcard.payability_disabled_reasons","typeLabel":"object[]"},"generate_payment_token":{"type":"boolean","default":false,"description":"generate payment token to use for future payments\n\nThe generated payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.payex.creditcard.generate_payment_token","typeLabel":"boolean"},"generate_recurrence_token":{"type":"boolean","default":false,"description":"generate recurrence payment token to use for future payments\n\nThe generated recurrence payment token will be made available from\nthe transaction details.\n","uniqueKey":"configuration.payex.creditcard.generate_recurrence_token","typeLabel":"boolean"},"no_cvc":{"type":"boolean","description":"Disable the CVC field for payments where payment token is used.\n> To use this feature it has to be enabled on the contract with Swedbank Pay.\n","uniqueKey":"configuration.payex.creditcard.no_cvc","typeLabel":"boolean"}},"uniqueKey":"configuration.payex.creditcard","typeLabel":"object"},"mobilepay":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Payex MobilePay Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.mobilepay.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.mobilepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.mobilepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.mobilepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.mobilepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.mobilepay.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.payex.mobilepay","typeLabel":"object"},"vipps":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Payex Vipps Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.vipps.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.vipps.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.vipps.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.vipps.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.vipps.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.vipps.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.payex.vipps","typeLabel":"object"},"applepay":{"required":["enabled"],"properties":{"enabled":{"description":"enable PayEx Apple Pay payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.applepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.payex.applepay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.applepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.applepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.applepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.applepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.applepay.payability_disabled_reasons","typeLabel":"object[]"}},"type":"object","uniqueKey":"configuration.payex.applepay","typeLabel":"object"},"clicktopay":{"required":["enabled"],"properties":{"enabled":{"description":"enable PayEx Click to Pay payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.clicktopay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.payex.clicktopay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.clicktopay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.clicktopay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.clicktopay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.clicktopay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.clicktopay.payability_disabled_reasons","typeLabel":"object[]"}},"type":"object","uniqueKey":"configuration.payex.clicktopay","typeLabel":"object"},"googlepay":{"required":["enabled"],"properties":{"enabled":{"description":"enable PayEx Google Pay payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.payex.googlepay.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.payex.googlepay.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.payex.googlepay.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.googlepay.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.payex.googlepay.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.payex.googlepay.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payex.googlepay.payability_disabled_reasons","typeLabel":"object[]"}},"type":"object","uniqueKey":"configuration.payex.googlepay","typeLabel":"object"}},"uniqueKey":"configuration.payex","typeLabel":"object"},"vipps":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable vipps payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.vipps.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.vipps.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.vipps.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.vipps.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.vipps.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.vipps.payability_disabled_reasons","typeLabel":"object[]"},"dynamic_descriptor":{"type":"string","maxLength":100,"description":"A short reference / descriptor that can be displayed to\nthe end user\n","uniqueKey":"configuration.vipps.dynamic_descriptor","typeLabel":"string"}},"uniqueKey":"configuration.vipps","typeLabel":"object"},"collector":{"type":"object","description":"Collector configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","enum":["payment_type"],"type":"string","uniqueKey":"configuration.collector.type","typeLabel":"enum\u003cstring>"},"dynamic_descriptor":{"type":"string","maxLength":40,"description":"A textual description max 40 characters of the purchase.\n","uniqueKey":"configuration.collector.dynamic_descriptor","typeLabel":"string"},"invoice":{"type":"object","description":"Invoice / Part Payment","required":["enabled"],"properties":{"enabled":{"description":"enable Collector Bank Invoice Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.collector.invoice.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.collector.invoice.type","typeLabel":"enum\u003cstring>"},"countries":{"type":"array","items":{"type":"string","format":"iso-3166-1","uniqueKey":"configuration.collector.invoice.countries.items.[INDEX]","typeLabel":"string\u003ciso-3166-1>"},"uniqueKey":"configuration.collector.invoice.countries","typeLabel":"string\u003ciso-3166-1>[]"},"options":{"type":"object","properties":{"enable_on_hold":{"description":"Create the collector transaction with status `ON_HOLD` and let\nthe Collector callback update the transaction state from `ON_HOLD`\nto `AUTHORIZED` or `FAILED`.\n\nA callback will be sent to the `callback_url` when the transaction\nchanges state from `ON_HOLD` to any new state.\n\nThis will override the payment option `enable_on_hold` and gateway config `options.enable_on_hold`-setting.\n","type":"boolean","uniqueKey":"configuration.collector.invoice.options.enable_on_hold","typeLabel":"boolean"}},"uniqueKey":"configuration.collector.invoice.options","typeLabel":"object"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.collector.invoice.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.collector.invoice.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.invoice.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.collector.invoice","typeLabel":"object"},"invoice_b2b":{"type":"object","description":"Invoice / Part Payment","required":["enabled"],"properties":{"enabled":{"description":"enable Collector Bank Invoice Payment B2B","type":"boolean","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.collector.invoice_b2b.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.collector.invoice_b2b.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice_b2b.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice_b2b.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.collector.invoice_b2b.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.invoice_b2b.payability_disabled_reasons","typeLabel":"object[]"},"countries":{"type":"array","items":{"type":"string","format":"iso-3166-1","uniqueKey":"configuration.collector.invoice_b2b.countries.items.[INDEX]","typeLabel":"string\u003ciso-3166-1>"},"uniqueKey":"configuration.collector.invoice_b2b.countries","typeLabel":"string\u003ciso-3166-1>[]"},"options":{"type":"object","properties":{"disable_collector_b2b_address_enforcement":{"type":"boolean","default":false,"description":"For `collector.invoice_b2b`. By default, the shipping_address B2B payments will be restricted to\nthe registered addresses of a company.\n\nSetting this on the session will override the `collector_b2b_address_enforcement` in `payment_options`\non the checkout configuration.\n","uniqueKey":"configuration.collector.invoice_b2b.options.disable_collector_b2b_address_enforcement","typeLabel":"boolean"},"enable_on_hold":{"description":"Create the collector transaction with status `ON_HOLD` and let\nthe Collector callback update the transaction state from `ON_HOLD`\nto `AUTHORIZED` or `FAILED`.\n\nA callback will be sent to the `callback_url` when the transaction\nchanges state from `ON_HOLD` to any new state.\n\nThis will override the gateway's `options.enable_on_hold`-setting.\n","type":"boolean","uniqueKey":"configuration.collector.invoice_b2b.options.enable_on_hold","typeLabel":"boolean"}},"uniqueKey":"configuration.collector.invoice_b2b.options","typeLabel":"object"}},"uniqueKey":"configuration.collector.invoice_b2b","typeLabel":"object"},"invoice_b2b_preapproved":{"type":"object","description":"Invoice for pre-approved B2B-customers","required":["enabled"],"properties":{"enabled":{"description":"enable Collector Bank Invoice Payment B2B","type":"boolean","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.collector.invoice_b2b_preapproved.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.collector.invoice_b2b_preapproved.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice_b2b_preapproved.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.invoice_b2b_preapproved.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.payability_disabled_reasons","typeLabel":"object[]"},"countries":{"type":"array","items":{"type":"string","format":"iso-3166-1","uniqueKey":"configuration.collector.invoice_b2b_preapproved.countries.items.[INDEX]","typeLabel":"string\u003ciso-3166-1>"},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.countries","typeLabel":"string\u003ciso-3166-1>[]"},"accounts":{"description":"All Collector B2B accounts configured for the customer's phone number at the merchant.\n","type":"array","items":{"type":"object","properties":{"billing_address":{"type":"object","required":["business_name","organization_number","address_line","postal_code","postal_place","country","phone_number","email"],"properties":{"business_name":{"type":"string","description":"ACME Inc","maxLength":50,"isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.business_name","typeLabel":"string"},"organization_number":{"minLength":9,"maxLength":12,"type":"string","description":"The organization number of the customer. For Norway, the length is 9. For Sweden, it's either 10 or 12 digits.\n","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.organization_number","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","maxLength":50,"isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.address_line","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","maxLength":50,"isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","maxLength":50,"isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.postal_place","typeLabel":"string"},"country":{"type":"string","format":"iso3166-alpha2","description":"Country of the location","example":"NO","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","pattern":"^\\+?\\d{5,15}$","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.phone_number","typeLabel":"string"},"email":{"type":"string","maxLength":100,"description":"The email address of a person or an organisation\n","isRequired":true,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.email","typeLabel":"string"},"address_line_2":{"type":"string","description":"More details about address.","maxLength":50,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","description":"CO-Address if applicable.","maxLength":50,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.co_address","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference","maxLength":50,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","maxLength":64,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.cost_center","typeLabel":"string"},"first_name":{"type":"string","example":"John","maxLength":50,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","maxLength":50,"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.last_name","typeLabel":"string"},"address_id":{"type":"string","example":"address_1","description":"The unique identification of the address from the available addresses for the business\n","uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address.address_id","typeLabel":"string"}},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].billing_address","typeLabel":"object"},"company_id":{"type":"string","description":"Token to represent the company","uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX].company_id","typeLabel":"string"}},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.invoice_b2b_preapproved.accounts","typeLabel":"object[]"}},"uniqueKey":"configuration.collector.invoice_b2b_preapproved","typeLabel":"object"},"finance":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Collector Bank Finance Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.collector.finance.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.collector.finance.type","typeLabel":"enum\u003cstring>"},"countries":{"type":"array","items":{"type":"string","format":"iso-3166-1","uniqueKey":"configuration.collector.finance.countries.items.[INDEX]","typeLabel":"string\u003ciso-3166-1>"},"uniqueKey":"configuration.collector.finance.countries","typeLabel":"string\u003ciso-3166-1>[]"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.collector.finance.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.finance.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.finance.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.collector.finance.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.finance.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.collector.finance","typeLabel":"object"},"installment":{"type":"object","description":"Fixed Part Payment","required":["enabled"],"properties":{"enabled":{"description":"enable Collector Bank Installment Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.collector.installment.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"default":"payment_product_type","uniqueKey":"configuration.collector.installment.type","typeLabel":"enum\u003cstring>"},"countries":{"type":"array","items":{"type":"string","format":"iso-3166-1","uniqueKey":"configuration.collector.installment.countries.items.[INDEX]","typeLabel":"string\u003ciso-3166-1>"},"uniqueKey":"configuration.collector.installment.countries","typeLabel":"string\u003ciso-3166-1>[]"},"options":{"type":"object","properties":{"enable_on_hold":{"description":"Create the collector transaction with status `ON_HOLD` and let\nthe Collector callback update the transaction state from `ON_HOLD`\nto `AUTHORIZED` or `FAILED`.\n\nA callback will be sent to the `callback_url` when the transaction\nchanges state from `ON_HOLD` to any new state.\n\nThis will override the gateway's `options.enable_on_hold`-setting.\n","type":"boolean","uniqueKey":"configuration.collector.installment.options.enable_on_hold","typeLabel":"boolean"}},"uniqueKey":"configuration.collector.installment.options","typeLabel":"object"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.collector.installment.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.installment.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.collector.installment.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.collector.installment.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.collector.installment.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.collector.installment","typeLabel":"object"}},"uniqueKey":"configuration.collector","typeLabel":"object"},"klarna":{"type":"object","description":"Klarna configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.klarna.type","typeLabel":"enum\u003cstring>"},"klarna":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Klarna Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.klarna.klarna.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.klarna.klarna.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.klarna.klarna.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.klarna.klarna.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.klarna.klarna.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.klarna.klarna.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.klarna.klarna.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.klarna.klarna","typeLabel":"object"},"billie":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Klarna B2B Payment with Billie","type":"boolean","isRequired":true,"uniqueKey":"configuration.klarna.billie.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.klarna.billie.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.klarna.billie.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.klarna.billie.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.klarna.billie.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.klarna.billie.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.klarna.billie.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.klarna.billie","typeLabel":"object"}},"uniqueKey":"configuration.klarna","typeLabel":"object"},"kravia":{"type":"object","description":"Kravia configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.kravia.type","typeLabel":"enum\u003cstring>"},"invoice_b2b":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Kravia Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.kravia.invoice_b2b.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.kravia.invoice_b2b.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.kravia.invoice_b2b.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2b.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2b.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.kravia.invoice_b2b.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.kravia.invoice_b2b.payability_disabled_reasons","typeLabel":"object[]"},"days_until_due":{"type":"integer","description":"Default: `14`\nThe number of days until the invoice is due.\n","minimum":0,"maximum":365,"format":"date","uniqueKey":"configuration.kravia.invoice_b2b.days_until_due","typeLabel":"integer\u003cdate>"},"require_identity_verification":{"type":"boolean","default":true,"description":"Whether identity verification is required, before allowing\npayments.\nDefaults to true, it will require the customer to verify themselves\nbefore making a payment via methods like BankID, if false no verification\nwill be required.\n","uniqueKey":"configuration.kravia.invoice_b2b.require_identity_verification","typeLabel":"boolean"},"invoice_channel":{"type":"string","description":"Invoice channel to use for delivering the invoice.\n","default":"kravia","enum":["merchant","kravia"],"uniqueKey":"configuration.kravia.invoice_b2b.invoice_channel","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.kravia.invoice_b2b","typeLabel":"object"},"invoice_b2b_grouped":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Kravia grouped invoices","type":"boolean","isRequired":true,"uniqueKey":"configuration.kravia.invoice_b2b_grouped.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.kravia.invoice_b2b_grouped.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.kravia.invoice_b2b_grouped.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2b_grouped.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2b_grouped.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.kravia.invoice_b2b_grouped.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.kravia.invoice_b2b_grouped.payability_disabled_reasons","typeLabel":"object[]"},"invoice_schedule":{"type":"object","properties":{"interval":{"description":"The interval at which the invoice should be issued. The invoice\nwill be issued on the first day of the interval.\n","type":"string","enum":["monthly","quarterly"],"uniqueKey":"configuration.kravia.invoice_b2b_grouped.invoice_schedule.interval","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.kravia.invoice_b2b_grouped.invoice_schedule","typeLabel":"object"},"days_until_due":{"type":"number","format":"int32","description":"Default: `14`\nThe number of days until the invoice is due.\n","minimum":0,"maximum":365,"uniqueKey":"configuration.kravia.invoice_b2b_grouped.days_until_due","typeLabel":"number\u003cint32>"},"require_identity_verification":{"type":"boolean","default":true,"description":"Whether identity verification is required, before allowing\npayments.\nDefaults to true, it will require the customer to verify themselves\nbefore making a payment via methods like BankID, if false no verification\nwill be required.\n","uniqueKey":"configuration.kravia.invoice_b2b_grouped.require_identity_verification","typeLabel":"boolean"},"invoice_channel":{"type":"string","description":"Invoice channel to use for delivering the invoice.\n","default":"kravia","enum":["merchant","kravia"],"uniqueKey":"configuration.kravia.invoice_b2b_grouped.invoice_channel","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.kravia.invoice_b2b_grouped","typeLabel":"object"},"invoice_b2c":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Kravia B2C invoice","type":"boolean","isRequired":true,"uniqueKey":"configuration.kravia.invoice_b2c.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.kravia.invoice_b2c.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.kravia.invoice_b2c.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2c.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.kravia.invoice_b2c.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.kravia.invoice_b2c.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.kravia.invoice_b2c.payability_disabled_reasons","typeLabel":"object[]"},"days_until_due":{"type":"integer","description":"Default: `14`\nThe number of days until the invoice is due.\n","minimum":0,"maximum":365,"format":"date","uniqueKey":"configuration.kravia.invoice_b2c.days_until_due","typeLabel":"integer\u003cdate>"},"invoice_channel":{"type":"string","description":"Invoice channel to use for delivering the invoice.\n","default":"kravia","enum":["merchant","kravia"],"uniqueKey":"configuration.kravia.invoice_b2c.invoice_channel","typeLabel":"enum\u003cstring>"},"require_identity_verification":{"type":"boolean","default":true,"description":"Whether identity verification is required, before allowing\npayments.\nDefaults to true, it will require the customer to verify themselves\nbefore making a payment via methods like BankID, if false no verification\nwill be required. In b2c cases this is only available when the merchant will\ndistribute the invoice themselves.\n","uniqueKey":"configuration.kravia.invoice_b2c.require_identity_verification","typeLabel":"boolean"}},"uniqueKey":"configuration.kravia.invoice_b2c","typeLabel":"object"}},"uniqueKey":"configuration.kravia","typeLabel":"object"},"two":{"type":"object","description":"Two configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.two.type","typeLabel":"enum\u003cstring>"},"invoice_b2b":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Two Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.two.invoice_b2b.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.two.invoice_b2b.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.two.invoice_b2b.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.two.invoice_b2b.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.two.invoice_b2b.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.two.invoice_b2b.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.two.invoice_b2b.payability_disabled_reasons","typeLabel":"object[]"},"duration_days":{"type":"integer","description":"The number of days until the invoice is due.","enum":[14,30],"uniqueKey":"configuration.two.invoice_b2b.duration_days","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"configuration.two.invoice_b2b","typeLabel":"object"}},"uniqueKey":"configuration.two","typeLabel":"object"},"walley":{"type":"object","description":"Walley configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.walley.type","typeLabel":"enum\u003cstring>"},"checkout_b2b":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"Enable Walley Checkout for businesses","type":"boolean","isRequired":true,"uniqueKey":"configuration.walley.checkout_b2b.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.walley.checkout_b2b.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.walley.checkout_b2b.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.walley.checkout_b2b.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.walley.checkout_b2b.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.walley.checkout_b2b.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.walley.checkout_b2b.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.walley.checkout_b2b","typeLabel":"object"},"checkout_b2c":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"Enable Walley Checkout for consumers","type":"boolean","isRequired":true,"uniqueKey":"configuration.walley.checkout_b2c.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.walley.checkout_b2c.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.walley.checkout_b2c.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.walley.checkout_b2c.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.walley.checkout_b2c.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.walley.checkout_b2c.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.walley.checkout_b2c.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.walley.checkout_b2c","typeLabel":"object"}},"uniqueKey":"configuration.walley","typeLabel":"object"},"santander":{"type":"object","properties":{"type":{"description":"Denotes what kind of config parameter this is","enum":["payment_type"],"type":"string","uniqueKey":"configuration.santander.type","typeLabel":"enum\u003cstring>"},"debit_account":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Santander Finance Debit Account","type":"boolean","isRequired":true,"uniqueKey":"configuration.santander.debit_account.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","enum":["payment_product_type"],"type":"string","uniqueKey":"configuration.santander.debit_account.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.santander.debit_account.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.santander.debit_account.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.santander.debit_account.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.santander.debit_account.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.santander.debit_account.payability_disabled_reasons","typeLabel":"object[]"},"branding_name":{"type":"string","description":"The name of the chain","uniqueKey":"configuration.santander.debit_account.branding_name","typeLabel":"string"},"accounts":{"description":"Debit accounts belonging to the customer's phone number","type":"array","items":{"type":"object","properties":{"account_number_token":{"type":"string","description":"Token to represent the account number","uniqueKey":"configuration.santander.debit_account.accounts.items.[INDEX].account_number_token","typeLabel":"string"},"masked_account_number":{"type":"string","description":"Representation of the account number for display purposes","uniqueKey":"configuration.santander.debit_account.accounts.items.[INDEX].masked_account_number","typeLabel":"string"}},"uniqueKey":"configuration.santander.debit_account.accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.santander.debit_account.accounts","typeLabel":"object[]"}},"uniqueKey":"configuration.santander.debit_account","typeLabel":"object"}},"uniqueKey":"configuration.santander","typeLabel":"object"},"seitatech":{"type":"object","description":"Seitatech configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is\n","type":"string","enum":["payment_type"],"uniqueKey":"configuration.seitatech.type","typeLabel":"enum\u003cstring>"},"in_person":{"type":"object","description":"Enabling `in_person` via Seitatech requires `order.store.id`, `order.store.terminal_id` and `order.store.payout_destination_id` to be set. The terminal must be registered via the management API with a store and payout destination.\n\nAdd a `publish` configuration with `channel: push` and `type: terminal` to initiate the payment on the terminal. The payment is also initiated on the terminal without a `publish` configuration when `seitatech.in_person` is the only enabled payment type.\n\nSet `configuration.channel` to `in_store` on all in-person payments so the transaction is recorded as an in-store payment.\n\nUse callbacks and webhooks to receive notification when the in-person payment is completed.\n","required":["enabled"],"properties":{"enabled":{"description":"enable in person payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.seitatech.in_person.enabled","typeLabel":"boolean"},"type":{"type":"string","description":"\\ Denotes what kind of config parameter this is","enum":["payment_product_type"],"uniqueKey":"configuration.seitatech.in_person.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.seitatech.in_person.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.seitatech.in_person.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.seitatech.in_person.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.seitatech.in_person.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.seitatech.in_person.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.seitatech.in_person","typeLabel":"object"}},"uniqueKey":"configuration.seitatech","typeLabel":"object"},"swish":{"type":"object","description":"Swish configuration","properties":{"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_type"],"uniqueKey":"configuration.swish.type","typeLabel":"enum\u003cstring>"},"swish":{"type":"object","required":["enabled"],"properties":{"enabled":{"description":"enable Swish Payment","type":"boolean","isRequired":true,"uniqueKey":"configuration.swish.swish.enabled","typeLabel":"boolean"},"type":{"description":"Denotes what kind of config parameter this is","type":"string","enum":["payment_product_type"],"uniqueKey":"configuration.swish.swish.type","typeLabel":"enum\u003cstring>"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.swish.swish.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.swish.swish.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.swish.swish.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.swish.swish.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.swish.swish.payability_disabled_reasons","typeLabel":"object[]"},"payout_enabled":{"description":"Flag to check if Dintero handles payout for this payment product","type":"boolean","uniqueKey":"configuration.swish.swish.payout_enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.swish.swish","typeLabel":"object"}},"uniqueKey":"configuration.swish","typeLabel":"object"},"payout":{"type":"object","description":"Configure how the payout is handled for the order.\n","properties":{"dynamic_payout_destination_ids":{"type":"array","description":"Use the order store id to control what `payout_destination_id` should be used\n\nA session created with the option set must have a store id that resolves to a payout_destination_id or have payout_destination_id set\n\nA session where both `order.store.id` and `order.payout_destination_id` will not be updated with match from `dynamic_payout_destination` if `overwrite_payout_destination_id` is not set to `true`\n\n- **`order_store_id`**: May specific store id to specifc payout destination id\n- **`order_store_id_as_order_payout_destination_id`**: Use store id as payout destination id\n","minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["order_store_id","order_store_id_as_order_payout_destination_id"],"isRequired":true,"uniqueKey":"configuration.payout.dynamic_payout_destination_ids.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"order_store_id":{"type":"string","description":"Required if type is `order_store_id`","example":"STORE_123","uniqueKey":"configuration.payout.dynamic_payout_destination_ids.items.[INDEX].order_store_id","typeLabel":"string"},"order_payout_destination_id":{"type":"string","description":"Required if type is `order_store_id`","example":"PD_123","uniqueKey":"configuration.payout.dynamic_payout_destination_ids.items.[INDEX].order_payout_destination_id","typeLabel":"string"},"overwrite_payout_destination_id":{"description":"Only applicable when type is `order_store_id`.\n\nOverwrite existing order payout_destination_id\n","type":"boolean","default":false,"uniqueKey":"configuration.payout.dynamic_payout_destination_ids.items.[INDEX].overwrite_payout_destination_id","typeLabel":"boolean"}},"uniqueKey":"configuration.payout.dynamic_payout_destination_ids.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payout.dynamic_payout_destination_ids","typeLabel":"object[]"},"tip_split":{"type":"object","description":"Specify how tips are split between payout destinations.\n\nWhen the payment method adds an order item with `type: tip`, e.g. payment terminal, the item's `splits` and `fee_split` are calculated from this configuration.\n\nIf not set, tips are split proportionally across the split destinations of the other order items, weighted by each destination's split amount.\n","example":{"destinations":[{"payout_destination_id":"seller-1","percentage":70},{"payout_destination_id":"seller-2","percentage":30}],"fee_split":{"type":"equal_fee_only","destinations":["seller-3"]}},"required":["destinations"],"properties":{"destinations":{"type":"array","description":"Payout destinations that will receive the tips along with the percentage split. The sum of all percentages must equal 100.\n","minItems":1,"items":{"type":"object","required":["payout_destination_id","percentage"],"properties":{"payout_destination_id":{"type":"string","description":"The payout destination id that will receive the tips.\n","maxLength":40,"example":"seller-1","isRequired":true,"uniqueKey":"configuration.payout.tip_split.destinations.items.[INDEX].payout_destination_id","typeLabel":"string"},"percentage":{"type":"integer","minimum":1,"maximum":100,"example":70,"description":"The percentage of the tips that will be sent to the payout destination.\n","isRequired":true,"uniqueKey":"configuration.payout.tip_split.destinations.items.[INDEX].percentage","typeLabel":"integer"}},"uniqueKey":"configuration.payout.tip_split.destinations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configuration.payout.tip_split.destinations","typeLabel":"object[]"},"fee_split":{"type":"object","description":"Specify how fees are handled with splits. The default behaviour is to share\nthe fees proportional with all splits destinations\n","required":["type"],"properties":{"type":{"type":"string","description":"- **`proportional`**: Fees are shared proportionally across `destinations`, weighted by each destination's split amount. Every destination must also be included in `splits`.\n- **`equal_fee_only`**: Fees are shared equally across `destinations`. These destinations must not be included in `splits` and receive no income from the order - they only accumulate fee debt.\n","enum":["proportional","equal_fee_only"],"isRequired":true,"uniqueKey":"configuration.payout.tip_split.fee_split.type","typeLabel":"enum\u003cstring>"},"destinations":{"type":"array","description":"Seller ids that will be debited for the payment fees.\n\n- When `type` is `proportional`, all destinations must also be included in the list of `splits`.\n- When `type` is `equal_fee_only`, destinations must not be included in `splits`. The fee is divided equally between them, and they receive no income from the order - only fee debt.\n","minItems":1,"items":{"type":"string","maxLength":40,"uniqueKey":"configuration.payout.tip_split.fee_split.destinations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"configuration.payout.tip_split.fee_split.destinations","typeLabel":"string[]"}},"uniqueKey":"configuration.payout.tip_split.fee_split","typeLabel":"object"}},"uniqueKey":"configuration.payout.tip_split","typeLabel":"object"},"payment_products":{"type":"array","readOnly":true,"description":"The payment products where payout is enabled\n","minItems":1,"items":{"type":"object","required":["payment_product"],"properties":{"payment_product":{"type":"string","description":"Payment product","enum":["bambora","collector","payex","klarna","swish","dintero_psp","kravia","seitatech"],"isRequired":true,"uniqueKey":"configuration.payout.payment_products.items.[INDEX].payment_product","typeLabel":"enum\u003cstring>"}},"uniqueKey":"configuration.payout.payment_products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.payout.payment_products","typeLabel":"object[]"}},"uniqueKey":"configuration.payout","typeLabel":"object"},"allow_express_wallet_payment":{"type":"boolean","description":"When enabled, wallet payments (like Apple Pay and Google Pay)\ncan be used in their express mode, allowing customers to complete\npurchases with a single tap, bypassing the standard checkout flow.\n","default":false,"example":false,"uniqueKey":"configuration.allow_express_wallet_payment","typeLabel":"boolean"},"age_verification":{"type":"object","description":"Configure age verification for a given payment session. When enabled, the\ncustomer must complete age verification before completing checkout.\n","required":["enabled","minimum_age_required"],"properties":{"enabled":{"type":"boolean","description":"Use this flag to enable or disable age verification for a given payment session.\n","isRequired":true,"uniqueKey":"configuration.age_verification.enabled","typeLabel":"boolean"},"minimum_age_required":{"type":"integer","description":"The minimum age required to complete the payment session.\n","example":18,"isRequired":true,"uniqueKey":"configuration.age_verification.minimum_age_required","typeLabel":"integer"}},"uniqueKey":"configuration.age_verification","typeLabel":"object"},"discounts":{"type":"object","description":"Configuration for discounts calculations\n","properties":{"type":{"type":"string","readOnly":true,"enum":["discounts"],"uniqueKey":"configuration.discounts.type","typeLabel":"enum\u003cstring>"},"express_discount_codes":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The discounts will be given by the configured express callback url.\n\nThe callback URL will be invoked when the session is updated\nwith a discount code, and the response used to update the discounts\non the order items and the shipping options.\n","isRequired":true,"uniqueKey":"configuration.discounts.express_discount_codes.enabled","typeLabel":"boolean"},"payability":{"type":"string","description":"Determines if the payment_product_type is currently available for payment\n\n`disabled_by_gateway`: The payment product type is disabled due to the payment gateway being unavailable.\n`disabled_by_order_amount`: The payment product type is disabled due to the order amount being outside the allowed range.\n`disabled_by_validation`: The payment product type is disabled due to validation errors.\n","enum":["payable","disabled_by_gateway","disabled_by_order_amount","disabled_by_validation"],"uniqueKey":"configuration.discounts.express_discount_codes.payability","typeLabel":"enum\u003cstring>"},"payability_disabled_reasons":{"type":"array","description":"Reason for when `payability` is not `payable`, this field can describe why the payment product type is disabled.","readOnly":true,"items":{"type":"object","properties":{"code":{"type":"string","description":"Code describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.discounts.express_discount_codes.payability_disabled_reasons.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Message describing the reason for the payment product type payability in the session.","uniqueKey":"configuration.discounts.express_discount_codes.payability_disabled_reasons.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"configuration.discounts.express_discount_codes.payability_disabled_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"configuration.discounts.express_discount_codes.payability_disabled_reasons","typeLabel":"object[]"}},"uniqueKey":"configuration.discounts.express_discount_codes","typeLabel":"object"},"order":{"type":"object","description":"Configure discounts calculation on the session order.\n","required":["enabled"],"properties":{"enabled":{"description":"Enable discount calculation on order\nitems eligible for discount\n\n- A session that has the `customer.customer_id` set will have\n its discounts calculated when the session is created.\n\n- A session with no customer_id will only have the discounts\n calculated when the customer is identified by the checkout\n page.\n\n- The autorized amount will be the net amount from the\n original session amount specified when the session was\n created.\n","type":"boolean","default":false,"isRequired":true,"uniqueKey":"configuration.discounts.order.enabled","typeLabel":"boolean"}},"uniqueKey":"configuration.discounts.order","typeLabel":"object"}},"uniqueKey":"configuration.discounts","typeLabel":"object"},"theme":{"type":"object","description":"Customize the appearance of the checkout.\n","properties":{"backdrop":{"type":"string","description":"Color on backdrop shown in desktop mode\n\nColor, supported formats are\n- hex: `#ff0000`\n- rgb: `rgb(255,0,0)`\n- rgba: `rgba(255,0,0,0.5)`\n","uniqueKey":"configuration.theme.backdrop","typeLabel":"string"},"primary":{"type":"string","description":"Primary color used on pay button and other buttons.\n\nColor, supported formats are\n- hex: `#ff0000`\n- rgb: `rgb(255,0,0)`\n- rgba: `rgba(255,0,0,0.5)`\n","uniqueKey":"configuration.theme.primary","typeLabel":"string"},"cardRadius":{"type":"string","description":"Radius on card element in the checkout.\n","uniqueKey":"configuration.theme.cardRadius","typeLabel":"string"},"buttonRadius":{"type":"string","description":"Radius on buttons in the checkout.\n","uniqueKey":"configuration.theme.buttonRadius","typeLabel":"string"}},"uniqueKey":"configuration.theme","typeLabel":"object"},"countries":{"description":"Country preferences\n","type":"object","properties":{"preferred_country":{"description":"Country to use as default in address and phone country code\n","type":"string","format":"iso3166-alpha2","uniqueKey":"configuration.countries.preferred_country","typeLabel":"string\u003ciso3166-alpha2>"},"allow_countries":{"description":"List of countries where the customer is allowed to set their address.\nIf empty, all countries are allowed, except for the ones in `deny_countries`.\n\nA country can not be in both `allow_countries` and `deny_countries`.\n","type":"array","items":{"type":"string","format":"iso3166-alpha2","uniqueKey":"configuration.countries.allow_countries.items.[INDEX]","typeLabel":"string\u003ciso3166-alpha2>"},"uniqueKey":"configuration.countries.allow_countries","typeLabel":"string\u003ciso3166-alpha2>[]"},"deny_countries":{"description":"List of countries where the customer is not allowed to set their address.\n\nA country can not be in both `allow_countries` and `deny_countries`.\n","type":"array","items":{"type":"string","format":"iso3166-alpha2","uniqueKey":"configuration.countries.deny_countries.items.[INDEX]","typeLabel":"string\u003ciso3166-alpha2>"},"uniqueKey":"configuration.countries.deny_countries","typeLabel":"string\u003ciso3166-alpha2>[]"}},"uniqueKey":"configuration.countries","typeLabel":"object"},"default_customer_type":{"description":"Customer type to use as default for the customer.\n","type":"string","enum":["b2c","b2b"],"uniqueKey":"configuration.default_customer_type","typeLabel":"enum\u003cstring>"},"allow_different_billing_shipping_address":{"description":"Allow that the shipping and billing address can be different.\n\nAn array of strings, the values `b2c` and `b2b` can be used to\nlimit the what types of customer that are allowed to submit different\naddresses for shipping and billing.\n\nBy default we limit the shipping and billing addresses to be equal for\nboth B2C and B2B customers.\n","type":"array","default":[],"items":{"type":"string","enum":["b2c","b2b"],"uniqueKey":"configuration.allow_different_billing_shipping_address.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"configuration.allow_different_billing_shipping_address","typeLabel":"enum\u003cstring>[]"},"merchant":{"type":"object","properties":{"id":{"type":"string","example":null,"uniqueKey":"configuration.merchant.id","typeLabel":"string"},"logo_url":{"type":"string","format":"uri","uniqueKey":"configuration.merchant.logo_url","typeLabel":"string\u003curi>"},"name":{"type":"string","example":"TKP tech AS","uniqueKey":"configuration.merchant.name","typeLabel":"string"},"country":{"type":"string","example":"NO","uniqueKey":"configuration.merchant.country","typeLabel":"string"}},"uniqueKey":"configuration.merchant","typeLabel":"object"}},"isRequired":true,"uniqueKey":"configuration","typeLabel":"object"},"id":{"type":"string","description":"An ID that uniquely identifies the resource\n","uniqueKey":"id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the resource was created\n","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"customer":{"type":"object","properties":{"customer_id":{"type":"string","description":"Customer id\n","uniqueKey":"customer.customer_id","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","description":"Customer email address\n","uniqueKey":"customer.email","typeLabel":"string"},"phone_number":{"type":"string","example":"+4799999999","description":"Customer phone number, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","uniqueKey":"customer.phone_number","typeLabel":"string"},"my_dintero":{"type":"object","description":"Options for myDintero\n","required":["actions","terms"],"properties":{"actions":{"description":"Actions to perform on the customer\n","type":"array","items":{"type":"string","enum":["create_user","skip"],"uniqueKey":"customer.my_dintero.actions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"customer.my_dintero.actions","typeLabel":"enum\u003cstring>[]"},"terms":{"required":["id","url"],"description":"Terms and conditions accepted\n","type":"object","properties":{"id":{"description":"id of the myDintero terms and conditions\n","type":"string","format":"uuid","isRequired":true,"uniqueKey":"customer.my_dintero.terms.id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","pattern":"https?://*","example":"https://example.com/toc","description":"Url to the terms and conditions accepted by the customer\n","isRequired":true,"uniqueKey":"customer.my_dintero.terms.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"customer.my_dintero.terms","typeLabel":"object"}},"uniqueKey":"customer.my_dintero","typeLabel":"object"},"gift_cards":{"type":"object","properties":{"dintero.wallets":{"type":"array","description":"Preload checkout with Wallets cards and let the customer\nuse it during checkout by providing PIN to activate the\ncard (e.g. use Wallets card as giftcard)\n\n- The `dintero.wallets` must be enabled in the session\n configuration to activate the use of the provided gift card\n tokens\n","maxItems":1,"items":{"type":"object","required":["card_id"],"properties":{"card_id":{"type":"string","isRequired":true,"uniqueKey":"customer.gift_cards.dintero\\.wallets.items.[INDEX].card_id","typeLabel":"string"},"masked_card_token":{"type":"string","uniqueKey":"customer.gift_cards.dintero\\.wallets.items.[INDEX].masked_card_token","typeLabel":"string"}},"uniqueKey":"customer.gift_cards.dintero\\.wallets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer.gift_cards.dintero\\.wallets","typeLabel":"object[]"}},"uniqueKey":"customer.gift_cards","typeLabel":"object"},"tokens":{"type":"object","properties":{"payex.creditcard":{"type":"object","properties":{"payment_token_id":{"type":"string","description":"Id included if the payex.creditcard was created with\npayment_token set.\n","readOnly":true,"example":"2134a260d196b1d65e59b259dc43f619d7f0f3c6","uniqueKey":"customer.tokens.payex\\.creditcard.payment_token_id","typeLabel":"string"}},"uniqueKey":"customer.tokens.payex\\.creditcard","typeLabel":"object"},"bambora.creditcard":{"type":"object","properties":{"payment_token_id":{"type":"string","description":"Id included if the bambora.creditcard was created with\npayment_token set.\n","readOnly":true,"example":"2134a260d196b1d65e59b259dc43f619d7f0f3c6","uniqueKey":"customer.tokens.bambora\\.creditcard.payment_token_id","typeLabel":"string"}},"uniqueKey":"customer.tokens.bambora\\.creditcard","typeLabel":"object"},"dintero_psp.creditcard":{"type":"object","properties":{"payment_token_id":{"type":"string","description":"Id included if the dintero_psp.creditcard was created with\npayment_token set.\n","readOnly":true,"example":"2134a260d196b1d65e59b259dc43f619d7f0f3c6","uniqueKey":"customer.tokens.dintero_psp\\.creditcard.payment_token_id","typeLabel":"string"}},"uniqueKey":"customer.tokens.dintero_psp\\.creditcard","typeLabel":"object"}},"uniqueKey":"customer.tokens","typeLabel":"object"}},"uniqueKey":"customer","typeLabel":"object"},"expires_at":{"type":"string","format":"date-time","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"checkboxes":{"type":"array","description":"Configuration for checkboxes that should be part of the checkout\n","items":{"type":"object","required":["id","label"],"properties":{"id":{"type":"string","description":"ID to assign to the checkbox so you can reference it later\n","isRequired":true,"uniqueKey":"checkboxes.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","description":"Label that should be visible next to the checkbox\n","minLength":2,"maxLength":99,"isRequired":true,"uniqueKey":"checkboxes.items.[INDEX].label","typeLabel":"string"},"checked":{"type":"boolean","description":"If the checkbox should be checked by default or not\n","uniqueKey":"checkboxes.items.[INDEX].checked","typeLabel":"boolean"},"required":{"type":"boolean","description":"If the checkbox should be required or not\n","uniqueKey":"checkboxes.items.[INDEX].required","typeLabel":"boolean"},"link":{"type":"object","required":["url","text"],"properties":{"url":{"type":"string","description":"Link URL","isRequired":true,"uniqueKey":"checkboxes.items.[INDEX].link.url","typeLabel":"string"},"text":{"type":"string","description":"Link text","example":"Terms for checkbox action","isRequired":true,"uniqueKey":"checkboxes.items.[INDEX].link.text","typeLabel":"string"}},"uniqueKey":"checkboxes.items.[INDEX].link","typeLabel":"object"}},"uniqueKey":"checkboxes.items.[INDEX]","typeLabel":"object"},"maxItems":2,"uniqueKey":"checkboxes","typeLabel":"object[]"},"express":{"type":"object","description":"### Present only for _Express Checkout_ sessions.\n\nAn _Express Checkout_ session is a session where the end user will submit a\nshipping address and then select a shipping option before the before a\npayment method is selected and the payment is initiated.\n\nEndpoints used in the _Express Checkout_ flow.\n1. [Set shipping address](/checkout-api/view/checkout_sid_json_order_shipping_address_put)\n2. [Set shipping option](/checkout-api/view/checkout_sid_json_order_items_shipping_option_put)\n","required":["shipping_options"],"properties":{"shipping_options":{"type":"array","items":{"type":"object","description":"A shipping option\n","required":["id","line_id","amount","operator","title"],"properties":{"id":{"type":"string","description":"Id of this shipping option product.\n\nThe express checkout will group all products with the same id. Used for\ngrouping delivery to the same address at different time slots, or for\ngrouping deliveries to different pick up points.\n","example":"bring-pick-up-00001","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].id","typeLabel":"string"},"line_id":{"type":"string","description":"Unique id of the specific configuration of this shipping product\n","example":"bring-pick-up-00001-location-0a1f6b","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].line_id","typeLabel":"string"},"amount":{"type":"integer","description":"The monetary amount of the shipping option, including VAT and discounts.\n\nIn smallest unit for the currency, e.g. cents\n","example":3900,"isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].amount","typeLabel":"integer"},"title":{"type":"string","description":"A shipping option title. Eg. \"Standard\"\n","example":"Standard","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].title","typeLabel":"string"},"operator":{"type":"string","description":"Name of company that provides shipping service\n","example":"Bring","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].operator","typeLabel":"string"},"countries":{"type":"array","items":{"type":"string","format":"iso3166-alpha2","example":"NO","uniqueKey":"express.shipping_options.items.[INDEX].countries.items.[INDEX]","typeLabel":"string\u003ciso3166-alpha2>"},"description":"Countries where this shipping option can be used","uniqueKey":"express.shipping_options.items.[INDEX].countries","typeLabel":"string\u003ciso3166-alpha2>[]"},"vat_amount":{"type":"integer","description":"The VAT of the `amount` parameter. Only\nused for display purposes.\n","example":975,"uniqueKey":"express.shipping_options.items.[INDEX].vat_amount","typeLabel":"integer"},"vat":{"type":"number","description":"The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2.\n","example":25,"uniqueKey":"express.shipping_options.items.[INDEX].vat","typeLabel":"number"},"description":{"type":"string","description":"A short description of the shipping option product\n","example":"Pick up at your nearest postal office","uniqueKey":"express.shipping_options.items.[INDEX].description","typeLabel":"string"},"delivery_method":{"type":"string","enum":["delivery","pick_up","unspecified","none"],"example":"pick_up","uniqueKey":"express.shipping_options.items.[INDEX].delivery_method","typeLabel":"enum\u003cstring>"},"operator_product_id":{"type":"string","description":"The operators own id for this shipping product\n","example":"pick-up-00001-location-0a1f6b","uniqueKey":"express.shipping_options.items.[INDEX].operator_product_id","typeLabel":"string"},"eta":{"type":"object","description":"Estimated time of arrival","properties":{"working_days":{"type":"array","items":{"type":"number","minimum":0,"uniqueKey":"express.shipping_options.items.[INDEX].eta.working_days.items.[INDEX]","typeLabel":"number"},"description":"The expected range of days until the relative time is reached.\nA range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days.\n","maxItems":2,"minItems":2,"example":[1,2],"uniqueKey":"express.shipping_options.items.[INDEX].eta.working_days","typeLabel":"number[]"},"shipping_day_of_week":{"type":"number","description":"The day of the week the relative time for shipping is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","maximum":7,"minimum":1,"example":3,"uniqueKey":"express.shipping_options.items.[INDEX].eta.shipping_day_of_week","typeLabel":"number"},"arrival_day_of_week":{"type":"number","description":"The day of the week the relative time for arrival is on.\n1 is Monday, 2 is Tuesday, ..., 7 is Sunday.\n","maximum":7,"minimum":1,"example":3,"uniqueKey":"express.shipping_options.items.[INDEX].eta.arrival_day_of_week","typeLabel":"number"},"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"express.shipping_options.items.[INDEX].eta.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"express.shipping_options.items.[INDEX].eta.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"express.shipping_options.items.[INDEX].eta","typeLabel":"object"},"time_slot":{"type":"object","description":"A specified time for delivery to customer","properties":{"starts_at":{"type":"string","format":"date-time","example":"2020-10-14T19:00:00Z","uniqueKey":"express.shipping_options.items.[INDEX].time_slot.starts_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","example":"2020-10-14T20:00:00Z","uniqueKey":"express.shipping_options.items.[INDEX].time_slot.ends_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"express.shipping_options.items.[INDEX].time_slot","typeLabel":"object"},"pick_up_address":{"type":"object","description":"Additional information about the shipping address","properties":{"first_name":{"type":"string","example":"John","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.last_name","typeLabel":"string"},"address_line":{"type":"string","description":"Gaustadalleen 21","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.address_line","typeLabel":"string"},"address_line_2":{"type":"string","description":"PB 123","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.address_line_2","typeLabel":"string"},"co_address":{"type":"string","example":"Land Lord","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.co_address","typeLabel":"string"},"business_name":{"type":"string","description":"Name of the company","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.business_name","typeLabel":"string"},"postal_code":{"type":"string","description":"The zip code / postal code of the address.","example":"0349","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.postal_code","typeLabel":"string"},"postal_place":{"type":"string","description":"The name of the postal code","example":"Oslo","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.postal_place","typeLabel":"string"},"country":{"type":"string","description":"Country of the location","format":"iso3166-alpha2","example":"NO","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.country","typeLabel":"string\u003ciso3166-alpha2>"},"phone_number":{"type":"string","description":"mobile number of a person / company, ITU/E.123 format with\ninternational prefix (+PPNNNNNNNNN...)\n","pattern":"^\\+?\\d{5,15}$","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.phone_number","typeLabel":"string"},"email":{"type":"string","description":"The email address of a person or an organization\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.email","typeLabel":"string"},"latitude":{"type":"number","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.longitude","typeLabel":"number"},"comment":{"type":"string","description":"Comment about the address\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.comment","typeLabel":"string"},"organization_number":{"type":"string","description":"The organization number of the customer.\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.organization_number","typeLabel":"string"},"organization_type":{"type":"string","description":"Type indicating what kind of organization it is.\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.organization_type","typeLabel":"string"},"customer_reference":{"type":"string","description":"The customer's reference\n\n#### Kravia\nWhen Kravia is enabled, `billing_address.customer_reference` must\nbe at most 30 characters.\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.customer_reference","typeLabel":"string"},"cost_center":{"type":"string","description":"For companies that needs to specify a cost center.","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.cost_center","typeLabel":"string"},"website_url":{"type":"string","description":"The website URL of the customer.\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.website_url","typeLabel":"string"},"opening_hours":{"type":"object","properties":{"open_now":{"type":"boolean","description":"Indicates if the location is open now.\n","example":true,"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.open_now","typeLabel":"boolean"},"periods":{"type":"array","items":{"type":"object","description":"A period of time when the opening hours are valid.\n","properties":{"opens_at":{"type":"string","format":"time","example":"08:00","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].opens_at","typeLabel":"string\u003ctime>"},"closes_at":{"type":"string","format":"time","example":"16:00","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].closes_at","typeLabel":"string\u003ctime>"},"day_of_week":{"type":"number","description":"The day of the week when the opening hours are valid.\n","example":1,"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX].day_of_week","typeLabel":"number"}},"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.periods","typeLabel":"object[]"},"timezone":{"type":"string","description":"The timezone of the location.\n","example":"Europe/Oslo","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours.timezone","typeLabel":"string"}},"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.opening_hours","typeLabel":"object"},"distance":{"type":"number","description":"Distance in kilometers from the shipping_address.\n","uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address.distance","typeLabel":"number"}},"uniqueKey":"express.shipping_options.items.[INDEX].pick_up_address","typeLabel":"object"},"metadata":{"type":"object","description":"Additional metadata about the shipping_option","maxProperties":20,"example":{"operator_dest":"XAB1239","number_x":1921},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"express.shipping_options.items.[INDEX].metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"express.shipping_options.items.[INDEX].metadata.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"express.shipping_options.items.[INDEX].metadata.additionalProperties","typeLabel":"string | number"},"uniqueKey":"express.shipping_options.items.[INDEX].metadata","typeLabel":"object"},"environmental_data":{"type":"object","description":"Environmental data about the shipping option\n","required":["description"],"properties":{"description":{"type":"string","description":"A short description of the environmental data, something like\n- \"Fossil free\",\n- \"Carbon neutral\"\n- \"Low emissions\"\n- \"Renewable Energy Sourced\"\n- \"Eco-certified Fleet\"\n","example":"Fossil free","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string","description":"Give context to the value field. Example:\n- \"CO2 emissions\"\n- \"Energy consumption\"\n- \"Carbon footprint\"\n- \"Carbon offset\"\n- \"Trees planted\"\n- \"Renewable energy percentage\"\n","maxLength":50,"example":"Carbon offset","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data.details.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","maxLength":50,"example":"1KG CO2","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data.details.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data.details","typeLabel":"object[]"}},"uniqueKey":"express.shipping_options.items.[INDEX].environmental_data","typeLabel":"object"},"thumbnail_url":{"type":"string","description":"URL to a thumbnail of the shipping option. Will be displayed when\nredirecting to the session.\nRecommended limitations for the image:\n - all images should preferrably have the same dimensions\n - max file size should be less than 2MB\n","format":"uri","uniqueKey":"express.shipping_options.items.[INDEX].thumbnail_url","typeLabel":"string\u003curi>"},"pay_in_store":{"description":"Enable pay in-store during pick-up. The amount to be paid will be zero.\nRequires that the payment method `dintero.zero` is enabled\n","type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["full"],"isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].pay_in_store.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"express.shipping_options.items.[INDEX].pay_in_store","typeLabel":"object"},"fee_split":{"type":"object","description":"Specify how fees are handled with splits. The default behaviour is to share\nthe fees proportional with all splits destinations\n","required":["type"],"properties":{"type":{"type":"string","description":"- **`proportional`**: Fees are shared proportionally across `destinations`, weighted by each destination's split amount. Every destination must also be included in `splits`.\n- **`equal_fee_only`**: Fees are shared equally across `destinations`. These destinations must not be included in `splits` and receive no income from the order - they only accumulate fee debt.\n","enum":["proportional","equal_fee_only"],"isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].fee_split.type","typeLabel":"enum\u003cstring>"},"destinations":{"type":"array","description":"Seller ids that will be debited for the payment fees.\n\n- When `type` is `proportional`, all destinations must also be included in the list of `splits`.\n- When `type` is `equal_fee_only`, destinations must not be included in `splits`. The fee is divided equally between them, and they receive no income from the order - only fee debt.\n","minItems":1,"items":{"type":"string","maxLength":40,"uniqueKey":"express.shipping_options.items.[INDEX].fee_split.destinations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"express.shipping_options.items.[INDEX].fee_split.destinations","typeLabel":"string[]"}},"uniqueKey":"express.shipping_options.items.[INDEX].fee_split","typeLabel":"object"},"splits":{"type":"array","description":"An array of objects specifying how the amount should be split between\nsellers when using Dintero Payout\n\nSpecify an empty array if the splits will be provided during capture.\n`auto_capture` cannot be enabled when splits are defined as empty array.\n","items":{"type":"object","required":["payout_destination_id","amount"],"properties":{"payout_destination_id":{"type":"string","maxLength":40,"example":"seller-1","description":"An id that identifies the seller\n\nNote: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations\n","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].splits.items.[INDEX].payout_destination_id","typeLabel":"string"},"amount":{"type":"integer","format":"int32","example":29700,"minimum":0,"description":"The split amount in smallest unit for the currency, e.g. cents.\n","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].splits.items.[INDEX].amount","typeLabel":"integer\u003cint32>"}},"uniqueKey":"express.shipping_options.items.[INDEX].splits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"express.shipping_options.items.[INDEX].splits","typeLabel":"object[]"},"shipment_id":{"type":"string","description":"For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`.\nIn order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment.","uniqueKey":"express.shipping_options.items.[INDEX].shipment_id","typeLabel":"string"},"shipment_items":{"type":"array","description":"An array of objects specifying what items will be delivered by this shipment. Should\nonly be specified when an order has multiple shipments so the checkout knows what\nitems will be shipped by the shipping options.\n\nIf there are multiple shipments the session (and resulting transaction) will have a\nsingle top-level shipping object that contains multiple `shipments` for the order.\n","items":{"type":"object","required":["line_id"],"properties":{"line_id":{"type":"string","example":"line-id-1","description":"The line_id or an item in order.items\n","isRequired":true,"uniqueKey":"express.shipping_options.items.[INDEX].shipment_items.items.[INDEX].line_id","typeLabel":"string"},"quantity":{"type":"number","description":"The quantity of the product in the item line.\n","uniqueKey":"express.shipping_options.items.[INDEX].shipment_items.items.[INDEX].quantity","typeLabel":"number"}},"uniqueKey":"express.shipping_options.items.[INDEX].shipment_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"express.shipping_options.items.[INDEX].shipment_items","typeLabel":"object[]"}},"uniqueKey":"express.shipping_options.items.[INDEX]","typeLabel":"object"},"description":"Shipping options that will be presented to the end user after the\nend user has submitted a shipping address.\n\nTo dynamically update the shipping_options when the _`order.shipping_address`_ is\nchanged by the end user in the checkout, use the\n_`url.shipping_address_callback_url`_.\n\n If the merchant is not able to ship the order to the end users shipping address, use an empty array.\n\n If there is only one option, a free delivery, the order still has to contain one option with a _`price.amount`_ of 0.\n","isRequired":true,"uniqueKey":"express.shipping_options","typeLabel":"object[]"},"shipping_mode":{"type":"string","enum":["shipping_required","shipping_not_required"],"default":"shipping_required","uniqueKey":"express.shipping_mode","typeLabel":"enum\u003cstring>"},"discount_codes":{"description":"Enable discount codes for Express Checkout\n","properties":{"max_count":{"type":"number","description":"Limit how many discount codes can be added by the customer\n","uniqueKey":"express.discount_codes.max_count","typeLabel":"number"},"callback_url":{"type":"string","format":"uri","pattern":"https?://*","example":"https://example.com/order/00128110/discount_codes_updated","description":"URL that Checkout will POST to when the user has submitted/changed\nthe discount codes for an express session.\n\nDintero will not attempt a retry after a failed delivery attempt.\nFollowing situations is considered as failed delivery\n\n- HTTP status codes that are not 200.\n- A request timeout (60 seconds)\n- Any connection error such as connection timeout, bad certificate, etc\n\nThe response from the callback will be used to update the order amount,\nitems discount_lines and shipping options.\n\nSee [POST example/discount_codes_callback_url](/api-reference/example-session-callbacks/example_discount_codes_callback_url)\nfor details about the request and response.\n","uniqueKey":"express.discount_codes.callback_url","typeLabel":"string\u003curi>"}},"type":"object","uniqueKey":"express.discount_codes","typeLabel":"object"},"shipping_address_callback_url":{"type":"string","format":"uri","pattern":"https?://*","example":"https://example.com/order/00128110/address_updated","description":"URL that Checkout will POST to when the end user has submitted/changed\na shipping address for an express-session.\n\nDintero will not attempt a retry after a failed delivery attempt.\nFollowing situations is considered as failed delivery\n\n- HTTP status codes that are not 200.\n- A request timeout (60 seconds)\n- Any connection error such as connection timeout, bad certificate, etc\n\nThe response from the callback will be used to update the shipping options.\n\nSee [POST example/shipping_address_callback_url](/api-reference/example-session-callbacks/example_shipping_address_callback_url)\nfor details about the request and response.\n","uniqueKey":"express.shipping_address_callback_url","typeLabel":"string\u003curi>"},"customer_types":{"type":"array","description":"Limit the lind of customers that can be submitted via the address form in the express checkout.\n","default":["b2c","b2b"],"items":{"type":"string","enum":["b2c","b2b"],"uniqueKey":"express.customer_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"express.customer_types","typeLabel":"enum\u003cstring>[]"},"default_different_billing_shipping_address":{"description":"Configure the default behavior for how Checkout presents the shipping and billing addresses.\n\nIf `[]`, Checkout defaults to assuming the shipping and billing addresses are the same.\n\nIf `[\"b2b\"]`, Checkout defaults to assuming different addresses for B2B only.\n\nIf `[\"b2c\"]`, Checkout defaults to assuming different addresses for B2C only.\n\nIf `[\"b2b\", \"b2c\"]`, Checkout defaults to assuming different addresses for all customer types.\n\nIf omitted, Checkout defaults to the same behaviour as setting `[]`.\n\nThis will only have an effect if `allow_different_billing_shipping_address` is set.\n","type":"array","default":[],"items":{"type":"string","enum":["b2c","b2b"],"uniqueKey":"express.default_different_billing_shipping_address.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"express.default_different_billing_shipping_address","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"express","typeLabel":"object"},"metadata":{"type":"object","description":"metadata about the session\n","properties":{"session:profile_id":{"type":"string","description":"Profile Id used when session was created","uniqueKey":"metadata.session:profile_id","typeLabel":"string"}},"uniqueKey":"metadata","typeLabel":"object"},"operations":{"description":"Set of operation available, which operation available will\ndepend on the current state of the session.\n","type":"array","items":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method to use when performing the operation\n","enum":["POST","GET"],"uniqueKey":"operations.items.[INDEX].method","typeLabel":"enum\u003cstring>"},"href":{"type":"string","example":"https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/payex.creditcard","description":"The target URI to perform the operation against.\n","uniqueKey":"operations.items.[INDEX].href","typeLabel":"string"},"rel":{"type":"string","enum":["view-collector-installment","view-collector-invoice","view-collector-invoice-b2b","view-collector-invoice-b2b-preapproved","view-payex-creditcard","view-payex-mobilepay","view-payex-swish"],"description":"The name of the relation the operation has to the current resource\n\n- `view-payex-creditcard`: Contains the href that is used to\n get the URL for the JavaScript that is used to embed the\n credit card UI directly on the Checkout site.\n- `view-payex-swish`: Contains the href that is used to\n get the URL for the JavaScript that is used to embed the\n Swish UI directly on the Checkout site.\n- `view-collector-installment`: Contains the href that is used\n to get the producsts available for the collector installment\n","uniqueKey":"operations.items.[INDEX].rel","typeLabel":"enum\u003cstring>"},"content_type":{"type":"string","description":"The Content-Type to used when performing the operation.\n","example":"application/json","uniqueKey":"operations.items.[INDEX].content_type","typeLabel":"string"}},"uniqueKey":"operations.items.[INDEX]","typeLabel":"object"},"example":[{"method":"POST","href":"https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/payex.creditcard","rel":"view-payex-creditcard","content_type":"application/json"},{"method":"POST","href":"https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/collector.installment","rel":"view-collector-installment","content_type":"application/json"}],"uniqueKey":"operations","typeLabel":"object[]"},"version":{"type":"string","example":"22596363b3de40b06f981fb85d82312e8c0ed511","description":"String that represents the state of the session.\n","uniqueKey":"version","typeLabel":"string"},"data_visibility":{"type":"string","enum":["full","masked"],"uniqueKey":"data_visibility","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"url":{"return_url":"https://example.com/accept","callback_url":"https://example.com/callback?method=GET","merchant_terms_url":"https://example.com/terms.html"},"order":{"amount":72200,"currency":"NOK","merchant_reference":"\u003cstring>","vat_amount":13660,"merchant_reference_2":"\u003cstring>","event_reference":"\u003cstring>","shipping_address":{"first_name":"John","last_name":"Doe","address_line":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"Land Lord","business_name":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","latitude":123,"longitude":123,"comment":"\u003cstring>","organization_number":"\u003cstring>","organization_type":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>"},"billing_address":{"first_name":"John","last_name":"Doe","address_line":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"Land Lord","business_name":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","latitude":123,"longitude":123,"comment":"\u003cstring>","organization_number":"\u003cstring>","organization_type":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>"},"partial_payment":false,"items":[{"amount":2000,"quantity":2,"line_id":"1","description":"Forsvinnignspølse","vat":20,"id":"10"},{"amount":6600,"quantity":2,"line_id":"2","description":"Vissvossafår på neppebrød","vat":20,"id":"6","eligible_for_discount":true,"is_changed":true,"gross_amount":10000,"discount_lines":[{"amount":4400,"discount_type":"customer","discount_id":"ed960ace-eb16-4e2e-ae52-b27647ccae8d","description":"Vossafestpris","line_id":1}]},{"amount":59700,"quantity":3,"line_id":"3","description":"Luftboller","vat":20,"id":"1"}],"gross_amount":123,"is_changed":true,"shipping_option":{"id":"bring-pick-up-00001","line_id":"bring-pick-up-00001-location-0a1f6b","amount":3900,"title":"Standard","operator":"Bring","countries":["NO"],"vat_amount":975,"vat":25,"description":"Pick up at your nearest postal office","delivery_method":"pick_up","operator_product_id":"pick-up-00001-location-0a1f6b","eta":{"working_days":[1,2],"shipping_day_of_week":3,"arrival_day_of_week":3,"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"time_slot":{"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"pick_up_address":{"first_name":"John","last_name":"Doe","address_line":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"Land Lord","business_name":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","latitude":123,"longitude":123,"comment":"\u003cstring>","organization_number":"\u003cstring>","organization_type":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>","website_url":"\u003cstring>","opening_hours":{"open_now":true,"periods":[{"opens_at":"08:00","closes_at":"16:00","day_of_week":1}],"timezone":"Europe/Oslo"},"distance":123},"metadata":{"operator_dest":"XAB1239","number_x":1921},"environmental_data":{"description":"Fossil free","details":[{"label":"Carbon offset","value":"1KG CO2"}]},"thumbnail_url":"\u003cstring>","pay_in_store":{"type":"full"},"fee_split":{"type":"proportional","destinations":["\u003cstring>"]},"splits":[{"payout_destination_id":"seller-1","amount":29700}],"shipments":[{"id":"bring-pick-up-00001","line_id":"bring-pick-up-00001-location-0a1f6b","amount":3900,"title":"Standard","operator":"Bring","countries":["NO"],"vat_amount":975,"vat":25,"description":"Pick up at your nearest postal office","delivery_method":"pick_up","operator_product_id":"pick-up-00001-location-0a1f6b","eta":{"working_days":[1,2],"shipping_day_of_week":3,"arrival_day_of_week":3,"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"time_slot":{"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"pick_up_address":{"first_name":"John","last_name":"Doe","address_line":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"Land Lord","business_name":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","latitude":123,"longitude":123,"comment":"\u003cstring>","organization_number":"\u003cstring>","organization_type":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>","website_url":"\u003cstring>","opening_hours":{"open_now":true,"periods":[{"opens_at":"08:00","closes_at":"16:00","day_of_week":1}],"timezone":"Europe/Oslo"},"distance":123},"metadata":{"operator_dest":"XAB1239","number_x":1921},"environmental_data":{"description":"Fossil free","details":[{"label":"Carbon offset","value":"1KG CO2"}]},"thumbnail_url":"\u003cstring>","pay_in_store":{"type":"full"},"fee_split":{"type":"proportional","destinations":["\u003cstring>"]},"splits":[{"payout_destination_id":"seller-1","amount":29700}],"shipment_id":"\u003cstring>","shipment_items":[{"line_id":"line-id-1","quantity":123}]}]},"store":{"id":"sc029","name":"SC Oslo","business_name":"SC Oslo AS","address":{"address_line":"Sommerkroveien 34","postal_place":"Oslo","country":"NO","address_line_2":"PB 123","postal_code":"0349"},"chain":"SuperChain","email":"contact@superchain.com","gln":"5790001398644","organization_number":"123456789MVA","phone_number":"+4738260107","mcc":"5814","bax":"102603","terminal_id":"T0292","payout_destination_id":"seller-1"},"discount_lines":[{"amount":4400,"percentage":44,"discount_type":"customer","discount_id":"766da0ef-9283-42bd-b012-0582344ec53c","description":"\u003cstring>","line_id":1}],"discount_codes":["SUMMER20"],"gift_cards":[{"type":"dintero.wallets","card_id":"\u003cstring>","amount":123,"masked_card_token":"\u003cstring>"}],"emd":{"event":[{"event_name":"Michael Jackson","event_company":"Diamond Events","genre_of_event":"Pop","start_time":"2023-08-16T15:00:00Z","end_time":"2023-08-16T16:00:00Z","ticket_delivery_method":"email","ticket_delivery_recipient":"recipient@mail.com","arena_name":"Oslo Spektrum","arena_location":{"city":"Oslo","country":"NO","street_address":"Sonja Henies plass 2","postal_code":"0185"},"access_controlled_venue":true,"affiliate_name":"Klarna affiliate"}],"subscription":{"subscription":{"subscription_name":"Contact lenses","start_time":"2023-08-16T15:00:00Z","end_time":"2023-09-16T15:00:00Z","auto_renewal_of_subscription":true,"affiliate_name":"Klarna affiliate"},"customer_account_info":{"unique_account_identifier":"Adam Adamsson","account_registration_date":"2023-08-16T15:00:00Z","account_last_modified":"2023-10-16T15:00:00Z"}},"travel":{"air_reservation_details":{"itinerary":[{"departure":"OSL","arrival":"MUC","carrier":"LH","departure_date":"2023-08-16T15:00:00Z","ticket_delivery_method":"phone","ticket_delivery_recipient":"97712123","departure_city":"Oslo","arrival_city":"Munich","segment_price":200000,"passenger_id":[1],"class":"First Class"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"passengers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"affiliate_name":"Klarna affiliate"},"bus_reservation_details":{"itinerary":[{"departure_city":"Oslo","arrival_city":"Munich","carrier":"Big Bus Travels Ltd.","departure_date":"2023-08-16T15:00:00Z","ticket_delivery_method":"phone","ticket_delivery_recipient":"97712123","segment_price":200000,"passenger_id":[1],"class":"First Class"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"passengers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"affiliate_name":"Klarna affiliate"},"train_reservation_details":{"itinerary":[{"departure_city":"Oslo","arrival_city":"Munich","carrier":"Big Train Travels Ltd.","departure_date":"2023-08-16T15:00:00Z","ticket_delivery_method":"phone","ticket_delivery_recipient":"97712123","passenger_id":[1],"segment_price":200000,"class":"First Class"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"passengers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"affiliate_name":"Klarna affiliate"},"ferry_reservation_details":{"itinerary":[{"departure_city":"Oslo","arrival_city":"Munich","carrier":"Big Ferry Travels Ltd.","departure_date":"2023-08-16T15:00:00Z","ticket_delivery_method":"phone","ticket_delivery_recipient":"97712123","segment_price":200000,"passenger_id":[1],"class":"First Class"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"passengers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"affiliate_name":"Klarna affiliate"},"hotel_reservation_details":{"itinerary":[{"start_time":"2023-08-16T15:00:00Z","end_time":"2023-08-20T15:00:00Z","number_of_rooms":2,"passenger_id":[1],"ticket_delivery_method":"phone","ticket_delivery_recipient":"97712123","hotel_price":200000,"hotel_name":"Premium Hotel","address":{"city":"Oslo","country":"NO","street_address":"Karl Johans gt. 31","postal_code":"0159"},"class":"First Class"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"passengers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"affiliate_name":"Klarna affiliate"},"car_rental_reservation_details":{"itinerary":[{"rental_company":"Premium Cars","start_time":"2023-08-16T15:00:00Z","end_time":"2023-08-20T15:00:00Z","drivers_id":[1],"pick_up_location":{"city":"Oslo","country":"NO","street_address":"Karl Johans gt. 31","postal_code":"0159"},"drop_off_location":{"city":"Oslo","country":"NO","street_address":"Karl Johans gt. 31","postal_code":"0159"},"car_price":500000,"class":"Premium Cars Premium Class"}],"drivers":[{"first_name":"Paul","last_name":"Lamb","id":1,"title":"mr"}],"pnr":"VH67899","insurance":[{"insurance_company":"Oopsie Insurance Ltd.","insurance_type":"travel","insurance_price":50000}],"affiliate_name":"Klarna affiliate"}},"marketplace_order":{"seller_info":{"sub_merchant_id":"Marketbrick Ltd.","product_category":"Phones","account_registration_date":"2023-08-16T15:00:00Z","account_last_modified":{"password":"2023-08-17T15:00:00Z","email":"2023-08-17T15:00:00Z","listing":"2023-08-17T15:00:00Z","login":"2023-08-17T15:00:00Z","address":"2023-08-17T15:00:00Z"},"number_of_trades":23,"unique_account_identifier_seller":{"email":"\u003cstring>","phone_number":"97712123","other":"\u003cstring>"},"product_name":"iPhone 14 Pro Max","seller_rating":5,"volume_of_trades":230},"winner_info":{"account_registration_date":"2023-08-16T15:00:00Z","account_last_modified":{"password":"2023-08-17T15:00:00Z","email":"2023-08-17T15:00:00Z","listing":"2023-08-17T15:00:00Z","login":"2023-08-17T15:00:00Z","address":"2023-08-17T15:00:00Z"},"number_of_trades":23,"unique_account_identifier_winner":{"email":"\u003cstring>","phone_number":"97712123","other":"\u003cstring>"},"volume_of_trades":230}}},"payout_destination_id":"\u003cstring>"},"configuration":{"auto_capture":true,"channel":"ecommerce","publish":[{"channel":"sms","type":"checkout-link","id":"\u003cstring>","status":"sent"}],"active_payment_types":{"enabled":true},"default_payment_type":"bambora.applepay","bambora":{"type":"payment_type","applepay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"creditcard":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"generate_payment_token":false},"googlepay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"mobilepay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"vipps":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"dintero":{"type":"payment_type","wallets":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"zero":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"external":{"enabled":true,"display":{"payment_method_label":"\u003cstring>","button_label":"\u003cstring>","content":{"title":"\u003cstring>","description":"\u003cstring>"},"terms":[{"ref":"\u003cstring>","label":"\u003cstring>","href":"\u003cstring>"}]},"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"dintero_psp":{"type":"payment_type","creditcard":{"enabled":true,"type":"payment_product_type","card_brands":["visa"],"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"generate_payment_token":false,"token_supported_auth_methods":["PASSKEY","3DS"],"sca_policy":{"network_exemptions":{"low_value":true,"low_risk":true},"liability_rules":[{"type":"amount_lte","limit":[{"amount":50000,"currency":"NOK"}],"issuer_countries":["NO","SE","DK"],"enabled":true}]},"generate_payment_token_config":{"save_card_checkbox":"opt_in"}},"vipps":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"sca_policy":{"network_exemptions":{"low_value":true,"low_risk":true},"liability_rules":[{"type":"amount_lte","limit":[{"amount":50000,"currency":"NOK"}],"issuer_countries":["NO","SE","DK"],"enabled":true}]}},"applepay":{"enabled":true,"type":"payment_product_type","card_brands":["visa"],"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"generate_payment_token":false,"sca_policy":{"network_exemptions":{"low_value":true,"low_risk":true},"liability_rules":[{"type":"amount_lte","limit":[{"amount":50000,"currency":"NOK"}],"issuer_countries":["NO","SE","DK"],"enabled":true}]},"details":{"domain_names":["example.dintero.com"],"token_event_notification_url":"\u003cstring>"}},"googlepay":{"enabled":true,"type":"payment_product_type","card_brands":["visa"],"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"sca_policy":{"network_exemptions":{"low_value":true,"low_risk":true},"liability_rules":[{"type":"amount_lte","limit":[{"amount":50000,"currency":"NOK"}],"issuer_countries":["NO","SE","DK"],"enabled":true}]},"generate_payment_token":false},"clicktopay":{"enabled":true,"type":"payment_product_type","card_brands":["visa"],"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"generate_payment_token":false,"sca_policy":{"network_exemptions":{"low_value":true,"low_risk":true},"liability_rules":[{"type":"amount_lte","limit":[{"amount":50000,"currency":"NOK"}],"issuer_countries":["NO","SE","DK"],"enabled":true}]}}},"instabank":{"finance":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"product":{"product_code":"630","minimum_monthly_balance_rate":"1.67","origination_fee":9500,"notification_fee":3900,"loan_example":{"amount":2500000,"years":1,"total_amount":2772300,"cost":272300,"effective_annual_interest_rate":"21.38"},"annual_interest_rate":"0.0","effective_annual_interest_rate":"0.0","minimum_amount":20000,"branding_image_url":"\u003cstring>"}},"invoice":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"require_applicant":true,"product":{"product_code":"632","due_in_days":10,"invoice_fee":9500,"require_applicant_amount":7500000,"minimum_amount":20000,"branding_image_url":"\u003cstring>"}},"installment":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"products":[{"product_code":"633","credit_time":36,"origination_fee":9500,"notification_fee":3900,"annual_interest_rate":"0.0","minimum_amount":20000,"effective_annual_interest_rate":"54.69","total_amount":309400,"monthly_amount":100000,"first_monthly_amount":109500,"require_applicant_amount":2500000,"loan_example":{"amount":2500000,"years":1,"total_amount":2772300,"cost":272300,"effective_annual_interest_rate":"21.38"},"branding_image_url":"\u003cstring>"}]},"postponement":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"products":[{"product_code":"633","postponement_months":36,"origination_fee":9500,"annual_interest_rate":"0.0","minimum_amount":20000,"notification_fee":3900,"effective_annual_interest_rate":"54.69","total_amount":309400,"require_applicant_amount":2500000,"loan_example":{"amount":2500000,"years":1,"total_amount":2772300,"cost":272300,"effective_annual_interest_rate":"21.38"},"branding_image_url":"\u003cstring>"}]}},"netaxept":{"type":"payment_type","creditcard":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"terminal":{"terminal":"/Terminal/default.aspx","terminal_single_page":true,"terminal_design":"\u003cstring>","terminal_layout":"\u003cstring>"}}},"payex":{"dynamic_descriptor":"\u003cstring>","swish":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"creditcard":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"generate_payment_token":false,"generate_recurrence_token":false,"no_cvc":true},"mobilepay":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"vipps":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"applepay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"clicktopay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"googlepay":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"vipps":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"dynamic_descriptor":"\u003cstring>"},"collector":{"type":"payment_type","dynamic_descriptor":"\u003cstring>","invoice":{"enabled":true,"type":"payment_product_type","countries":["\u003cstring>"],"options":{"enable_on_hold":true},"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"invoice_b2b":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"countries":["\u003cstring>"],"options":{"disable_collector_b2b_address_enforcement":false,"enable_on_hold":true}},"invoice_b2b_preapproved":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"countries":["\u003cstring>"],"accounts":[{"billing_address":{"business_name":"\u003cstring>","organization_number":"\u003cstring>","address_line":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>","first_name":"John","last_name":"Doe","address_id":"address_1"},"company_id":"\u003cstring>"}]},"finance":{"enabled":true,"type":"payment_product_type","countries":["\u003cstring>"],"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"installment":{"enabled":true,"type":"payment_product_type","countries":["\u003cstring>"],"options":{"enable_on_hold":true},"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"klarna":{"type":"payment_type","klarna":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"billie":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"kravia":{"type":"payment_type","invoice_b2b":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"days_until_due":182,"require_identity_verification":true,"invoice_channel":"kravia"},"invoice_b2b_grouped":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"invoice_schedule":{"interval":"monthly"},"days_until_due":182.5,"require_identity_verification":true,"invoice_channel":"kravia"},"invoice_b2c":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"days_until_due":182,"invoice_channel":"kravia","require_identity_verification":true}},"two":{"type":"payment_type","invoice_b2b":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"duration_days":14}},"walley":{"type":"payment_type","checkout_b2b":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"checkout_b2c":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"santander":{"type":"payment_type","debit_account":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"branding_name":"\u003cstring>","accounts":[{"account_number_token":"\u003cstring>","masked_account_number":"\u003cstring>"}]}},"seitatech":{"type":"payment_type","in_person":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]}},"swish":{"type":"payment_type","swish":{"enabled":true,"type":"payment_product_type","payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"payout_enabled":true}},"payout":{"dynamic_payout_destination_ids":[{"type":"order_store_id","order_store_id":"STORE_123","order_payout_destination_id":"PD_123","overwrite_payout_destination_id":false}],"tip_split":{"destinations":[{"payout_destination_id":"seller-1","percentage":70},{"payout_destination_id":"seller-2","percentage":30}],"fee_split":{"type":"equal_fee_only","destinations":["seller-3"]}},"payment_products":[{"payment_product":"bambora"}]},"allow_express_wallet_payment":false,"age_verification":{"enabled":true,"minimum_age_required":18},"discounts":{"type":"discounts","express_discount_codes":{"enabled":true,"payability":"payable","payability_disabled_reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}]},"order":{"enabled":false}},"theme":{"backdrop":"\u003cstring>","primary":"\u003cstring>","cardRadius":"\u003cstring>","buttonRadius":"\u003cstring>"},"countries":{"preferred_country":"\u003cstring>","allow_countries":["\u003cstring>"],"deny_countries":["\u003cstring>"]},"default_customer_type":"b2c","allow_different_billing_shipping_address":[],"merchant":{"id":null,"logo_url":"\u003cstring>","name":"TKP tech AS","country":"NO"}},"id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","customer":{"customer_id":"\u003cstring>","email":"john.doe@example.com","phone_number":"+4799999999","my_dintero":{"actions":["create_user"],"terms":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","url":"https://example.com/toc"}},"gift_cards":{"dintero.wallets":[{"card_id":"\u003cstring>","masked_card_token":"\u003cstring>"}]},"tokens":{"payex.creditcard":{"payment_token_id":"2134a260d196b1d65e59b259dc43f619d7f0f3c6"},"bambora.creditcard":{"payment_token_id":"2134a260d196b1d65e59b259dc43f619d7f0f3c6"},"dintero_psp.creditcard":{"payment_token_id":"2134a260d196b1d65e59b259dc43f619d7f0f3c6"}}},"expires_at":"2023-11-07T05:31:56Z","checkboxes":[{"id":"\u003cstring>","label":"\u003cstring>","checked":true,"required":true,"link":{"url":"\u003cstring>","text":"Terms for checkbox action"}}],"express":{"shipping_options":[{"id":"bring-pick-up-00001","line_id":"bring-pick-up-00001-location-0a1f6b","amount":3900,"title":"Standard","operator":"Bring","countries":["NO"],"vat_amount":975,"vat":25,"description":"Pick up at your nearest postal office","delivery_method":"pick_up","operator_product_id":"pick-up-00001-location-0a1f6b","eta":{"working_days":[1,2],"shipping_day_of_week":3,"arrival_day_of_week":3,"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"time_slot":{"starts_at":"2020-10-14T19:00:00Z","ends_at":"2020-10-14T20:00:00Z"},"pick_up_address":{"first_name":"John","last_name":"Doe","address_line":"\u003cstring>","address_line_2":"\u003cstring>","co_address":"Land Lord","business_name":"\u003cstring>","postal_code":"0349","postal_place":"Oslo","country":"NO","phone_number":"\u003cstring>","email":"\u003cstring>","latitude":123,"longitude":123,"comment":"\u003cstring>","organization_number":"\u003cstring>","organization_type":"\u003cstring>","customer_reference":"\u003cstring>","cost_center":"\u003cstring>","website_url":"\u003cstring>","opening_hours":{"open_now":true,"periods":[{"opens_at":"08:00","closes_at":"16:00","day_of_week":1}],"timezone":"Europe/Oslo"},"distance":123},"metadata":{"operator_dest":"XAB1239","number_x":1921},"environmental_data":{"description":"Fossil free","details":[{"label":"Carbon offset","value":"1KG CO2"}]},"thumbnail_url":"\u003cstring>","pay_in_store":{"type":"full"},"fee_split":{"type":"proportional","destinations":["\u003cstring>"]},"splits":[{"payout_destination_id":"seller-1","amount":29700}],"shipment_id":"\u003cstring>","shipment_items":[{"line_id":"line-id-1","quantity":123}]}],"shipping_mode":"shipping_required","discount_codes":{"max_count":123,"callback_url":"https://example.com/order/00128110/discount_codes_updated"},"shipping_address_callback_url":"https://example.com/order/00128110/address_updated","customer_types":["b2c","b2b"],"default_different_billing_shipping_address":[]},"metadata":{"session:profile_id":"\u003cstring>"},"operations":[{"method":"POST","href":"https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/payex.creditcard","rel":"view-payex-creditcard","content_type":"application/json"},{"method":"POST","href":"https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/collector.installment","rel":"view-collector-installment","content_type":"application/json"}],"version":"22596363b3de40b06f981fb85d82312e8c0ed511","data_visibility":"full"}}},"exampleType":"generated"}},"exampleType":"generated"},"b81cb56c-983a-41b8-a63e-eeca70c4430d":{"description":"No discounts","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"c6a0f754-9a71-4f46-ac88-468663cc9192":{"description":"Resource was not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The human readable description of the error/warning","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"The code used to identify the error/warning","uniqueKey":"error.code","typeLabel":"string"},"errors":{"type":"array","description":"The nested error(s) encountered during validation","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"802ffeb0-6d7f-443f-aed4-daa7188c9baa":{"description":"Precondition failed","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The human readable description of the error/warning","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"The code used to identify the error/warning","uniqueKey":"error.code","typeLabel":"string"},"errors":{"type":"array","description":"The nested error(s) encountered during validation","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"fceacff4-5edb-4fdd-abd1-d7e0f9b8f9d6":{"description":"Unexpected Error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The human readable description of the error/warning","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"The code used to identify the error/warning","uniqueKey":"error.code","typeLabel":"string"},"errors":{"type":"array","description":"The nested error(s) encountered during validation","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"24a0cbf3-ae62-426f-9fc5-c08574a6062f":{"url":"https://checkout.dintero.com/v1"}}},"originalFileLocation":"mintlify-docs/openapi/spec-checkout.yaml"},"subdomain":"dintero-c3a7bfec","siteName":"Dintero Documentation","title":"Set Express Checkout discount codes - Dintero Documentation","contextualStarterQuestions":[{"_id":"6aea1dcfd2b7d1adb9c24644","deploymentId":"69d66e893989d4678a7dfb08","questionText":"How do I set discount codes?","status":"active","generatedBy":"contextual","path":"checkout-api/view/checkout_sid_json_order_discount_codes_put","createdAt":"2026-11-03T17:45:51.616Z","updatedAt":"2026-11-03T17:45:51.616Z","__v":0},{"_id":"6aea1dcfd2b7d1adb9c24646","deploymentId":"69d66e893989d4678a7dfb08","questionText":"How are shipping options updated?","status":"active","generatedBy":"contextual","path":"checkout-api/view/checkout_sid_json_order_discount_codes_put","createdAt":"2026-11-03T17:45:51.616Z","updatedAt":"2026-11-03T17:45:51.616Z","__v":0},{"_id":"6aea1dcfd2b7d1adb9c24645","deploymentId":"69d66e893989d4678a7dfb08","questionText":"What triggers the callback URL?","status":"active","generatedBy":"contextual","path":"checkout-api/view/checkout_sid_json_order_discount_codes_put","createdAt":"2026-11-03T17:45:51.616Z","updatedAt":"2026-11-03T17:45:51.616Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"checkout-api/view/checkout_sid_json_order_discount_codes_put.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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=\"Changes the order.discount_codes submitted by end user in the Express Checkout flow. If the _express.discount_codes_callback_url_ is set, the session will be updated with discount on the order and the shipping options.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dintero Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set Express Checkout discount codes - Dintero Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes the order.discount_codes submitted by end user in the Express Checkout flow. If the _express.discount_codes_callback_url_ is set, the session will be updated with discount on the order and the shipping options.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dintero Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dintero-c3a7bfec.mintlify.site/_mintlify/api/og/v2?division=view\u0026amp;title=Set+Express+Checkout+discount+codes\u0026amp;description=Changes+the+%60order.discount_codes%60+submitted+by+end+user+in+the+Express+Checkout+flow.%0A%0AIf+the+_%60express.discount_codes_callback_url%60_+is+set%2C+the+session+will+\u0026amp;theme=32b11d411eb265d03df273ed\u0026amp;signature=5fc4111a7a85a66a2434365ef6fb668fbecb20e3ca39d55b6f6fa06f5baeab36\">\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=\"Set Express Checkout discount codes - Dintero Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes the order.discount_codes submitted by end user in the Express Checkout flow. If the _express.discount_codes_callback_url_ is set, the session will be updated with discount on the order and the shipping options.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dintero-c3a7bfec.mintlify.site/_mintlify/api/og/v2?division=view\u0026amp;title=Set+Express+Checkout+discount+codes\u0026amp;description=Changes+the+%60order.discount_codes%60+submitted+by+end+user+in+the+Express+Checkout+flow.%0A%0AIf+the+_%60express.discount_codes_callback_url%60_+is+set%2C+the+session+will+\u0026amp;theme=32b11d411eb265d03df273ed\u0026amp;signature=5fc4111a7a85a66a2434365ef6fb668fbecb20e3ca39d55b6f6fa06f5baeab36\">\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/dintero-c3a7bfec/NThyLjsK6njIMKyp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dintero Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0000FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/checkout-api/view/checkout_sid_json_order_discount_codes_put.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dintero.com/#organization\",\"name\":\"Dintero Documentation\",\"url\":\"https://docs.dintero.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dintero-c3a7bfec/D0VX9t09zInvinnk/mintlify-docs/images/light.svg?fit=max\u0026auto=format\u0026n=D0VX9t09zInvinnk\u0026q=85\u0026s=b4717f47bb69fef03f724e6356c03726\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dintero.com#website\",\"name\":\"Dintero Documentation\",\"url\":\"https://docs.dintero.com\",\"publisher\":{\"@id\":\"https://docs.dintero.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put#webpage\",\"url\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put\",\"name\":\"Set Express Checkout discount codes\",\"description\":\"Changes the order.discount_codes submitted by end user in the Express Checkout flow. If the _express.discount_codes_callback_url_ is set, the session will be updated with discount on the order and the shipping options.\",\"isPartOf\":{\"@id\":\"https://docs.dintero.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkout API\",\"item\":\"https://docs.dintero.com/checkout-api/session/checkout_session_profile_post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"view\",\"item\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_html_get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set Express Checkout discount codes\",\"item\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put#apireference\",\"headline\":\"Set Express Checkout discount codes\",\"name\":\"Set Express Checkout discount codes\",\"description\":\"Changes the order.discount_codes submitted by end user in the Express Checkout flow. If the _express.discount_codes_callback_url_ is set, the session will be updated with discount on the order and the shipping options.\",\"url\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dintero.com/checkout-api/view/checkout_sid_json_order_discount_codes_put#webpage\"},\"publisher\":{\"@id\":\"https://docs.dintero.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dintero.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dintero Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dintero Documentation","nav":{"global":null,"products":[{"product":"Payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/shopping-cart.svg","description":"Dintero Checkout and In-Person Payments","pages":[{"title":"Payments","href":"/docs"}]},{"product":"Loyalty \u0026 Virtual Cards","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/gift.svg","description":"Customer, discount, receipt, and gift card services","pages":[{"title":"Loyalty \u0026 Virtual Cards","href":"/docs/loyalty/getting-started"}]},{"product":"Order Management","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/cube.svg","description":"Create and manage orders, captures, refunds, and draft orders","pages":[{"title":"Order Management","href":"/docs/order-management/overview"}]},{"product":"Partners","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/hand.svg","description":"Partner management and API access","pages":[{"title":"Partners","href":"/docs/partners/partners"}]},{"product":"Plugins \u0026 Integrations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/puzzle.svg","description":"E-commerce plugins and POS integrations","pages":[{"title":"Plugins \u0026 Integrations","href":"/docs/integrations/plugins"}]},{"product":"API Specifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/code.svg","description":"All API Specifications","hidden":true,"dropdowns":[{"dropdown":"Apps Directory","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/view-grid.svg","groups":[{"group":"Apps Directory API","pages":[{"group":"apps","pages":[{"title":"Support app Event","description":"Check if the app is configured to support events posted\nto this resource.\n","deprecated":null,"version":null,"sidebarTitle":"Support app Event","openapi":"/mintlify-docs/openapi/spec-apps-directory.yaml get /accounts/{aid}/apps-directory/apps/{app_id}/{id}/{type}/{signature}","href":"/apps-directory-api/apps/api_apps_directory_app_id_type_sig_get"},{"title":"Send app Event","description":"Send data to be processed by the app. The operation is async.\n","deprecated":null,"version":null,"sidebarTitle":"Send app Event","openapi":"/mintlify-docs/openapi/spec-apps-directory.yaml post /accounts/{aid}/apps-directory/apps/{app_id}/{id}/{type}/{signature}","href":"/apps-directory-api/apps/api_apps_directory_app_id_type_sig_post"}]}]}]},{"dropdown":"Assets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/film.svg","groups":[{"group":"Assets API","pages":[{"group":"merchant-terms","pages":[{"title":"Sales terms","description":null,"deprecated":null,"version":null,"sidebarTitle":"Sales terms","openapi":"/mintlify-docs/openapi/spec-assets.yaml get /merchant/terms/sales_terms/{country}/{organization_number}/{data}","href":"/assets-api/merchant-terms/v1_assets_merchant_country_organization_terms_sales_get"}]}]}]},{"dropdown":"Audit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/clipboard-list.svg","groups":[{"group":"Audit API","pages":[{"group":"request-audit","pages":[{"title":"Get Audit Request Log","description":"**scopes**:\n - read:audit\n","deprecated":null,"version":null,"sidebarTitle":"Get Audit Request Log","openapi":"/mintlify-docs/openapi/spec-audit.yaml get /v1/accounts/{aid}/audit/logs","href":"/audit-api/request-audit/aid_audit_logs_get"}]}]}]},{"dropdown":"Billing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/currency-dollar.svg","groups":[{"group":"Billing API","pages":[{"group":"reports","pages":[{"title":"List costs","description":"Get the costs aggregated by periode\n\n*scopes*:\n - admin:billing\n - read:billing\n","deprecated":null,"version":null,"sidebarTitle":"List costs","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/billing/costs","href":"/billing-api/reports/aid_billing_cost_get"},{"title":"List reports","description":"Get billing reports\n\n*scopes*:\n - admin:billing\n - read:billing\n","deprecated":null,"version":null,"sidebarTitle":"List reports","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/billing/reports","href":"/billing-api/reports/aid_billing_reports_get"}]},{"group":"payout.rules","pages":[{"title":"List payout rules","description":"Get payout rules\n\n*scopes*:\n - admin:billing\n - read:billing\n","deprecated":null,"version":null,"sidebarTitle":"List payout rules","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/billing/payout-rules","href":"/billing-api/payoutrules/aid_billing_payout_rules_get"},{"title":"Create payout rule","description":"Create payout rules\n\n*scopes*:\n - admin:billing\n - write:billing\n","deprecated":null,"version":null,"sidebarTitle":"Create payout rule","openapi":"/mintlify-docs/openapi/spec-billing.yaml post /accounts/{aid}/billing/payout-rules","href":"/billing-api/payoutrules/aid_billing_payout_rules_post"},{"title":"Update payout rule","description":"Update payout with new destinations\n","deprecated":null,"version":null,"sidebarTitle":"Update payout rule","openapi":"/mintlify-docs/openapi/spec-billing.yaml put /accounts/{aid}/billing/payout-rules/{id}","href":"/billing-api/payoutrules/aid_billing_payout_rules_id_put"},{"title":"Remove payout rule","description":"Remove payout rule\n","deprecated":null,"version":null,"sidebarTitle":"Remove payout rule","openapi":"/mintlify-docs/openapi/spec-billing.yaml delete /accounts/{aid}/billing/payout-rules/{id}","href":"/billing-api/payoutrules/aid_billing_payout_rules_id_delete"}]},{"group":"subscriptions","pages":[{"title":"List subscription plans","description":"Get subscriptions\n\n- Supports filtering by dynamic `dimensions`.\n\n**filter by dimensions syntax:**\n- `dimension.{name}={value}` to filter by a specific value\n- `dimension.{name}=prefix:{value}` to filter by a specific value prefix\n- `dimension.{name}=val1,val2` comma separated value for OR logic\n- `dimension.{name}` (no value) to filter by presence of the dimension\n","deprecated":null,"version":null,"sidebarTitle":"List subscription plans","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/billing/subscriptions","href":"/billing-api/subscriptions/aid_billing_subscriptions_get"}]},{"group":"settlements","pages":[{"title":"List settlements","description":"List settlements\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"List settlements","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/settlements","href":"/billing-api/settlements/aid_settlements_list"},{"title":"Download attachment","description":"Download a settlement attachment\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Download attachment","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/settlements/{settlementid}/attachments/{attachmentid}","href":"/billing-api/settlements/settlement_attachment_download"},{"title":"Generate a test settlement report","description":"Generate a test settlement report. Only available in test.\n\n*scopes*:\n - admin:billing\n - admin:reports\n","deprecated":null,"version":null,"sidebarTitle":"Generate a test settlement report","openapi":"/mintlify-docs/openapi/spec-billing.yaml post /accounts/{aid}/settlements/reports/generate-test-report","href":"/billing-api/settlements/aid_settlement_generate_test_report"}]},{"group":"settlements.configuration","pages":[{"title":"List settlement report configurations","description":"List settlement report configurations\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"List settlement report configurations","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/settlements/reports/configuration","href":"/billing-api/settlementsconfiguration/aid_settlement_report_config_list"},{"title":"Create settlement report configurations","description":"Create settlement report configurations\n\n*scopes*:\n - admin:billing\n - admin:reports\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Create settlement report configurations","openapi":"/mintlify-docs/openapi/spec-billing.yaml post /accounts/{aid}/settlements/reports/configuration","href":"/billing-api/settlementsconfiguration/aid_settlement_report_config_create"},{"title":"Get settlement report configuration","description":"Get settlement report configuration\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Get settlement report configuration","openapi":"/mintlify-docs/openapi/spec-billing.yaml get /accounts/{aid}/settlements/reports/configuration/{id}","href":"/billing-api/settlementsconfiguration/aid_settlement_report_config_details"},{"title":"Update settlement report configuration","description":"Update settlement report configuration\n\n*scopes*:\n - admin:billing\n - write:billing\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Update settlement report configuration","openapi":"/mintlify-docs/openapi/spec-billing.yaml put /accounts/{aid}/settlements/reports/configuration/{id}","href":"/billing-api/settlementsconfiguration/aid_settlement_report_config_update"},{"title":"Delete settlement report configuration","description":"Delete settlement report configuration\n\n*scopes*:\n - admin:billing\n - write:billing\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Delete settlement report configuration","openapi":"/mintlify-docs/openapi/spec-billing.yaml delete /accounts/{aid}/settlements/reports/configuration/{id}","href":"/billing-api/settlementsconfiguration/aid_settlement_report_config_delete"}]}]}]},{"dropdown":"Checkout","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/shopping-cart.svg","groups":[{"group":"Checkout API","pages":[{"group":"session","pages":[{"title":"Create checkout session from profile","description":"Create a corresponding Checkout Session for an order placed in your system\nusing predefined session profile\n\n#### Session with Instabank\n\nNote that `items` is a required property when creating a session with\nInstabank configured.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create checkout session from profile","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions-profile","href":"/checkout-api/session/checkout_session_profile_post"},{"title":"List checkout sessions","description":"List all Checkout sessions\nscopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List checkout sessions","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions","href":"/checkout-api/session/checkout_sessions_get"},{"title":"Create a checkout session","description":"Create a corresponding Checkout Session for an order placed in your system\n\n#### Session with Instabank\n\nNote that `items` is a required property when creating a session with\nInstabank configured.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create a checkout session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions","href":"/checkout-api/session/checkout_session_post"},{"title":"Get checkout session details","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get checkout session details","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}","href":"/checkout-api/session/checkout_session_get"},{"title":"Update checkout session details","description":"Session must be locked for paying before updating.\n\n**Requirements**:\n- `order.shipping_option` must be included in `express_shipping_options` if both are set.\n- `order.amount` must be equal to the sum of `order.items` and `order.shipping_option`\n\nscopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update checkout session details","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /sessions/{session_id}","href":"/checkout-api/session/checkout_session_put"},{"title":"Cancel session","description":"\nCancel a session\n\nThe session transaction will be voided in case where it is\ninitialized or authorized.\n\nCancel is not allowed in case where the current transaction\nstate is not initialized or authorized.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Cancel session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/cancel","href":"/checkout-api/session/checkout_session_cancel_post"},{"title":"QR Code for a Session","description":"Generate a QR Code containing the URL for the Checkout Session.\nThe QR Code can be displayed in POS to enable Checkout payment.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"QR Code for a Session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/qr","href":"/checkout-api/session/qr_sessions_sid_post"},{"title":"Payment token session","description":"\nThis endpoint lets you create payment and recurrence tokens without reserving\nor charging any amount.\n\nThe URL returned by this endpoint opens a web site where the customer\ncan enter their payment details, e.g. card information.\n\nThe payment details will be validated and a transaction with a\npayment/recurrence token will be created on success containing the payment\ntoken created from the customer payment details.\n\n- [GET /v1/transactions/{id}?includes=card.payment_token](/api-reference/default/transactions_id_get)\n- [GET /v1/transactions/{id}?includes=card.recurrence_token](/api-reference/default/transactions_id_get)\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Payment token session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/payment-token","href":"/checkout-api/session/checkout_payment_token_session_post"}]},{"group":"payment","pages":[{"title":"Initiate a checkout payment","description":"For Express Checkout sessions, the _`order.shipping_address`_ must be set on\nthe session, and a _`order.items.shipping_option` item is required if the\nsession has either an _`express.shipping_address_callback_url`_ or the\nsession has at least one option in _`express.shipping_options`_.\n","deprecated":null,"version":null,"sidebarTitle":"Initiate a checkout payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/pay","href":"/checkout-api/payment/checkout_sid_pay_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/redirect/{redirect_ref}","href":"/checkout-api/payment/checkout_sid_redirect_get"},{"title":"Create and pay merchant initiated session","description":"For merchant initiated payments, where the customer is not involved.\n\nReceives a session and pays it with the given card token.\n\n> Merchant is resposible for managing their retry policy for payments\n> that fails, and not retry when payment fails with `DO_NOT_RETRY` error.\n>\n> 200 response will be returned when request fails due to authorization error. Transaction\n> will have status `FAILED` and error information can be found at `events.error`.\n>\n> Insufficient error handling will cause cards to be blocked\n> https://docs.dintero.com/docs/checkout/tokenization#do-not-try-again--excessive-reattempts\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create and pay merchant initiated session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/pay","href":"/checkout-api/payment/checkout_session_pay_post"}]},{"group":"view","pages":[{"title":"Get the Checkout page","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get the Checkout page","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}","href":"/checkout-api/view/checkout_sid_html_get"},{"title":"Get payment operations","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get payment operations","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /view/{session_id}/payments/{payment_product_type}","href":"/checkout-api/view/checkout_sid_payments_product_type_post"},{"title":"Start age verification","description":"Starts age verification for the session. The endpoint is returned as the\n`complete-age-verification` operation for every payment product type while\nage verification is required.\n\nSuccessful verification records an `AGE_VERIFICATION_COMPLETED` session event with\n`verified_identity.age_over`. The operation is then no longer returned.\n\nFailed verification redirects to the session URL with `merchant_reference`\n(when available) and one of these `error` codes:\n\n- `cancel`: The customer cancelled the verification\n- `authorization-failed`: Authorization with the identity provider failed\n- `failed`: The verification could not be completed\n- `age-requirement-not-met`: The customer did not meet the age requirement\n","deprecated":null,"version":null,"sidebarTitle":"Start age verification","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/age-verification","href":"/checkout-api/view/checkout_sid_age_verification_get"},{"title":"Get checkout details","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get checkout details","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/session","href":"/checkout-api/view/checkout_sid_json_get"},{"title":"Abandon a checkout payment","description":"Abandon a checkout payment before completing payment.\n","deprecated":null,"version":null,"sidebarTitle":"Abandon a checkout payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /view/{session_id}/session/abandon","href":"/checkout-api/view/view_sid_session_abandon_post"},{"title":"Lock a checkout session","description":"When locked, the session can not be paid.\nLocking the session is only available when express is enabled.\n","deprecated":null,"version":null,"sidebarTitle":"Lock a checkout session","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /view/{session_id}/session/lock","href":"/checkout-api/view/checkout_sid_lock"},{"title":"Set Express Checkout addresses and checkboxes","description":"Changes the `order.shipping_address` and `order.billing_address` submitted by end user in the Express Checkout flow.\n\nIf the _`express.shipping_address_callback_url`_ is set, the _`express.shipping_options`_\nin the response will be updated to show the available shipping options for\nthe updated address.\n\nAlso changes the checkboxes that are part of the session as they are\nchecked or unchecked by the end user in the Express Checkout flow.\n","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout addresses and checkboxes","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/addresses","href":"/checkout-api/view/checkout_sid_json_order_addresses_put"},{"title":"Set Express Checkout discount codes","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout discount codes","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/discount_codes","href":"/checkout-api/view/checkout_sid_json_order_discount_codes_put"},{"title":"Set gift card","description":"Change the active `gift_cards` for the session. Updating with empty gift cards\nremoves all gift cards from the session.\n","deprecated":null,"version":null,"sidebarTitle":"Set gift card","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/gift_cards","href":"/checkout-api/view/checkout_sid_json_order_gift_cards_put"},{"title":"Set Express Checkout shipping address","description":"**Deprecated** in favor of [PUT /v1/view/{session_id}/session/order/addresses](/checkout-api/view/checkout_sid_json_order_addresses_put)\n\nChanges the order.shipping_address, submitted by end user in the Express Checkout flow.\n\nIf the _`express.shipping_address_callback_url`_ is set, the _`express.shipping_options`_\nin the response will be updated to show the available shipping options for\nthe updated address.\n","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout shipping address","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/shipping_address","href":"/checkout-api/view/checkout_sid_json_order_shipping_address_put"},{"title":"Set Express Checkout shipping option","description":"Changes the selected shipping_option, submitted by end user in the Express Checkout flow.\n","deprecated":null,"version":null,"sidebarTitle":"Set Express Checkout shipping option","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /view/{session_id}/session/order/shipping_option","href":"/checkout-api/view/checkout_sid_json_order_items_shipping_option_put"},{"title":"Send a verification code to the customer","description":"Send a SMS with a payment verification code\n","deprecated":null,"version":null,"sidebarTitle":"Send a verification code to the customer","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /view/{session_id}/session/publish/scc","href":"/checkout-api/view/checkout_sid_send_scc"},{"title":"Add payment information","description":null,"deprecated":null,"version":null,"sidebarTitle":"Add payment information","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /view/{session_id}/session/events/payment_information","href":"/checkout-api/view/checkout_sid_events_pi_post"}]},{"group":"example-session-callbacks","pages":[{"title":"Discount codes Update","description":"This API endpoint on the merchant side allows Dintero to get\nshipping_options and order with discounts based on the provided\nsession that had its `order.discount_codes` updated.\n","deprecated":null,"version":null,"sidebarTitle":"Discount codes Update","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /examples/discount_code_callback_url","href":"/checkout-api/example-session-callbacks/example_discount_codes_callback_url"},{"title":"Session Callback","description":"This API endpoint on the merchant side allows Dintero to notify\nthe `session.url.callback_url` when the payment is completed\n\n> The `transaction_id` is optional if `report_error=true`\n","deprecated":null,"version":null,"sidebarTitle":"Session Callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /examples/session_url_callback","href":"/checkout-api/example-session-callbacks/example_session_get_callback_url"},{"title":"Session Callback","description":"This API endpoint on the merchant side allows Dintero to notify\nthe `session.url.callback_url` when the payment is completed\n> POST is only use if `callback_url` includes `method=POST` query parameter.\n\n> The `body` and `transaction_id` is optional if `report_error=true`\n","deprecated":null,"version":null,"sidebarTitle":"Session Callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /examples/session_url_callback","href":"/checkout-api/example-session-callbacks/example_session_post_callback_url"},{"title":"Address Update","description":"This API endpoint on the merchant side allows Dintero to get\nshipping options based on the provided session after an address\nupdate\n","deprecated":null,"version":null,"sidebarTitle":"Address Update","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /examples/shipping_address_callback_url","href":"/checkout-api/example-session-callbacks/example_shipping_address_callback_url"}]},{"group":"Transactions","pages":[{"title":"List all transactions","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List all transactions","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /transactions","href":"/checkout-api/transactions/transactions_get"},{"title":"Get a transaction","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get a transaction","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /transactions/{id}","href":"/checkout-api/transactions/transactions_id_get"},{"title":"Update a transaction","description":"scopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update a transaction","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /transactions/{id}","href":"/checkout-api/transactions/transactions_id_put"},{"title":"Capture a transaction","description":"Captures a transaction that was created with the Checkout\nendpoint with a `capture_now` value of `false`.\n\n#### Capture Instabank transaction\n\nNote that `items` is required when capturing a transaction\nwith `payment_product=instabank`. The items must include\nthe lines to Capture, with `line_id`, `quantity` and `amount`.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Capture a transaction","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /transactions/{id}/capture","href":"/checkout-api/transactions/transactions_id_capture_post"},{"title":"Update transaction authorization","description":"This endpoint is used to update an existing authorization:\n\n**Use cases:**\n\n1. **Extend authorization (Klarna)**\n - Provider: `klarna`\n - Purpose: Extend the lifetime of an existing authorization.\n - Required fields:\n - `reason` (string): The reason for the extension.\n - `reference` (string): A reference specified by the merchant to identify the transaction.\n\n2. **Update order amount (Klarna)**\n - Provider: `klarna`\n - Purpose: Update the authorized amount for an existing Klarna order.\n - Required fields:\n - `amount` (number): The new amount to authorize.\n - `items` (array): List of transaction items. Sum of item amounts must equal the updated transaction amount.\n - `description` (string): Optional description of the order.\n - `reason` (string): Optional reason for the update.\n - `reference` (string): Optional merchant reference to identify the transaction.\n\n3. **Update pre-authorization (Dintero PSP)**\n - Provider: `dintero_psp`\n - Purpose: Update the pre-authorized amount and/or finalize the authorization.\n - Required fields:\n - `amount` (number):\n The new amount to authorize.\n - If `final_authorization=false`, the new amount **must be greater than** the previous pre-authorized amount.\n - If `final_authorization=true`, the amount **may be increased, reduced, or unchanged**.\n - `final_authorization` (boolean):\n Indicates whether this is the final authorization step.\n - `true`: Finalizes the authorization and locks the transaction for further updates.\n - `false`: Keeps the pre-authorization open for future updates.\n - `reference` (string): Optional merchant reference to identify the transaction.\n - `items` (array): Optional list of transaction items to update. If the transaction already has items, this field is required. When present, sum of item amounts must equal the updated transaction amount.\n\n4. **Authorize external transaction (Dintero External)**\n - Provider: `dintero`\n - Purpose: Authorize a transaction currently on hold.\n - If `amount` or `items` are provided, the API will validate if the details are consistent with the order in the transaction.\n\n---\n**Notes:**\n- For Klarna:\n - If `amount` is **not provided**: Extend authorization flow is used (use case 1). Only `reason` and `reference` are relevant.\n - If `amount` **is provided**: Update order amount flow is used (use case 2). `amount` is required; `items` and `description` are optional.\n- For pre-authorization: Only `amount`, `final_authorization`, and `reference` are relevant.\n","deprecated":null,"version":null,"sidebarTitle":"Update transaction authorization","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /transactions/{id}/authorization","href":"/checkout-api/transactions/transaction_tid_extend_authorization_post"},{"title":"Refund transaction","description":"Once a transaction has been successfully captured,\na refund operation is available. Like other operations,\nrefund can be partial or total\n\n#### Refund Instabank transaction\n\nNote that `items` is required when refunding a transaction\nwith `payment_product=instabank`. The items must include the\nlines to Refund, with `line_id`, `quantity` and `amount`.\n\n#### Refund `seitatech.in_person` transaction\n\n`terminal_id` is required when refunding a `seitatech.in_person`\ntransaction. The cardholder must be present to approve the refund\non a terminal active on the same `payout_destination_id` as the\noriginal transaction.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Refund transaction","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /transactions/{id}/refund","href":"/checkout-api/transactions/transactions_id_refund_post"},{"title":"Void transaction","description":"At any moment before capture of a transaction, it is\npossible to cancel an authorization. This operation is\ncalled voiding and can be performed by doing a POST to\nthis endpoint\n\n#### Void on part capture\n\nVoid after a part capture will cancel the difference between\nthe capture amount and the authorization amount.\n\nVoid on part capture is only supported on following types:\n - `payex.creditcard`\n - `payex.mobilepay`\n - `payex.vipps`\n - `payex.applepay`\n - `payex.clicktopay`\n - `payex.googlepay`\n - `vipps`\n - `klarna.klarna`\n - `klarna.billie`\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Void transaction","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /transactions/{id}/void","href":"/checkout-api/transactions/transactions_id_void_post"},{"title":"Update transactions with settlements","description":"Add settlement events to list of transactions\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update transactions with settlements","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /transactions/events/settlements","href":"/checkout-api/transactions/transactions_events_settlements_post"}]},{"group":"Card Tokens","pages":[{"title":"Get card token","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get card token","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /card-tokens/{token_id}","href":"/checkout-api/card-tokens/card_tokens_token_id_get"},{"title":"Delete card token","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Delete card token","openapi":"/mintlify-docs/openapi/spec-checkout.yaml delete /card-tokens/{token_id}","href":"/checkout-api/card-tokens/card_tokens_token_id_delete"},{"title":"List card tokens","description":"Use query parameters to filter the search. \nTo list all Transactions related to a Card Token, use [GET /v1/transactions](/api-reference/transactions/transactions_get) with query `?search={token_id}`.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List card tokens","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /card-tokens","href":"/checkout-api/card-tokens/card_tokens_get"}]},{"group":"api-keys","pages":[{"title":"List api-keys","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List api-keys","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/api-keys","href":"/checkout-api/api-keys/admin_api_keys_get"},{"title":"Create api-key","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create api-key","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/api-keys","href":"/checkout-api/api-keys/admin_api_keys_post"},{"title":"Delete api-key","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Delete api-key","openapi":"/mintlify-docs/openapi/spec-checkout.yaml delete /admin/api-keys/{api_key_id}","href":"/checkout-api/api-keys/admin_parameters_api_key_delete"},{"title":"Rotate api-key","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Rotate api-key","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/api-keys/{api_key_id}/rotate-api-key","href":"/checkout-api/api-keys/admin_api_keys_api_key_id_rotate_post"}]},{"group":"merchant-certificates","pages":[{"title":"List payment keys","description":"Returns all payment keys/certificates for the account and provider.\nDefaults to `apple_pay` when `provider` is omitted.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List payment keys","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/merchant-certificates","href":"/checkout-api/merchant-certificates/admin_merchant_certificates_get"},{"title":"Generate payment key CSR","description":"Generates an ECC-P256 key pair in PSP and returns a Certificate\nSigning Request (CSR) in base64-encoded DER format. The certificate\nsubject is determined by PSP; submit the CSR to Apple to obtain a\nsigned certificate, then upload it via the certificate endpoint.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Generate payment key CSR","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/merchant-certificates","href":"/checkout-api/merchant-certificates/admin_merchant_certificates_post"},{"title":"Revoke a payment key","description":"Revokes a payment key/certificate in PSP. Revoked keys cannot be used\nfor Apple Pay payments. `key_id` alone identifies the key; no\nprovider is needed.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Revoke a payment key","openapi":"/mintlify-docs/openapi/spec-checkout.yaml delete /admin/merchant-certificates/{key_id}","href":"/checkout-api/merchant-certificates/admin_merchant_certificates_key_id_delete"},{"title":"Upload payment key certificate","description":"Uploads the Apple-signed certificate for a previously generated key.\nThe certificate must be in base64-encoded DER format. On success the\nkey transitions to active status and can be used for Apple Pay\npayments. `key_id` alone identifies the key; no provider is needed.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Upload payment key certificate","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/merchant-certificates/{key_id}/certificate","href":"/checkout-api/merchant-certificates/admin_merchant_certificates_key_id_certificate_post"}]},{"group":"checkout","pages":[{"title":"Get payment checkout configuration","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get payment checkout configuration","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/checkout","href":"/checkout-api/checkout/admin_checkout_id_get"},{"title":"Update payment checkout configuration","description":"scopes:\n- admin:checkout\n- write:checkout:/admin/checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update payment checkout configuration","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/checkout","href":"/checkout-api/checkout/admin_checkout_id_put"}]},{"group":"netaxept","pages":[{"title":"Redirect to Netaxept hosted payment window","description":null,"deprecated":null,"version":null,"sidebarTitle":"Redirect to Netaxept hosted payment window","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/netaxept","href":"/checkout-api/netaxept/checkout_sid_netaxept_html_get"},{"title":"Handle Netaxept callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Netaxept callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/gateways/netaxept/transaction/hooks","href":"/checkout-api/netaxept/checkout_netaxept_webhooks_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/netaxept/redirect/{redirect_ref}","href":"/checkout-api/netaxept/checkout_sid_netaxept_redirect_get"}]},{"group":"payex","pages":[{"title":"Get status of session PayEx payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get status of session PayEx payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/payex/{payment_id}/status","href":"/checkout-api/payex/checkout_sid_payex_payment_get"},{"title":"Handle Payex callback after a change or update","description":"Creates a transaction from the session with status determined\nby the payment status provided by Payex.\n","deprecated":null,"version":null,"sidebarTitle":"Handle Payex callback after a change or update","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/payex/callback/{payment_product_type}","href":"/checkout-api/payex/checkout_sid_callback_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/payex/redirect/{action}/{payment_product_type}","href":"/checkout-api/payex/checkout_sid_payex_redirect_get"}]},{"group":"swish","pages":[{"title":"Get status about the Swish session.","description":"Get status about the Swish session. Will check if the session contains a transaction_id,\nand if the transaction is paid with the given Swish payment_request_id.\n","deprecated":null,"version":null,"sidebarTitle":"Get status about the Swish session.","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/swish/{payment_request_id}/status","href":"/checkout-api/swish/checkout_sid_swish_get"},{"title":"Handle Swish payment callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Swish payment callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/gateways/swish/transaction/payment/{session_id}/{callback_ref}","href":"/checkout-api/swish/checkout_swish_payment_callback_post"},{"title":"Handle Swish refund callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Swish refund callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/gateways/swish/transaction/refund/{id}/{callback_ref}","href":"/checkout-api/swish/checkout_swish_refund_callback_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/swish/redirect/{redirect_ref}","href":"/checkout-api/swish/checkout_sid_swish_redirect_get"}]},{"group":"vipps","pages":[{"title":"Get the Vipps push notification page","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get the Vipps push notification page","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /view/{session_id}/vipps","href":"/checkout-api/vipps/checkout_sid_html_vipps_get"},{"title":"Handle Vipps callback after the payment request","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Vipps callback after the payment request","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/vipps/v2/payments/{order_id}","href":"/checkout-api/vipps/checkout_sid_vipps_payments_orderid_post"}]},{"group":"bambora-gateway","pages":[{"title":"Update Bambora gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Bambora gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/bambora","href":"/checkout-api/bambora-gateway/admin_checkout_id_gw_bambora_put"}]},{"group":"collector-gateway","pages":[{"title":"Create Collector credentials","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Create Collector credentials","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/collector/credentials","href":"/checkout-api/collector-gateway/admin_gateways_collector_credentials_put"},{"title":"Update overrides for Collector Gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update overrides for Collector Gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/collector/override","href":"/checkout-api/collector-gateway/admin_checkout_id_gw_override_collector_put"},{"title":"Update Collector gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Collector gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/collector","href":"/checkout-api/collector-gateway/admin_checkout_id_gw_collector_put"}]},{"group":"gateways","pages":[{"title":"Check gateway status","description":"verify the gateway configuration\n\nscopes:\n- admin:checkout\n- write:checkout:/admin/gateways\n","deprecated":null,"version":null,"sidebarTitle":"Check gateway status","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/gateways/{gateway}/status","href":"/checkout-api/gateways/admin_checkout_gw_type_status_post"},{"title":"process transaction event","description":"Handle async update of transaction.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"process transaction event","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/transaction/{intent}","href":"/checkout-api/gateways/events_transaction_post"},{"title":"process session event","description":"Handle async update of session.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"process session event","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/session/{intent}","href":"/checkout-api/gateways/events_session_post"}]},{"group":"instabank-gateway","pages":[{"title":"Update Instabank gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Instabank gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/instabank","href":"/checkout-api/instabank-gateway/admin_checkout_id_gw_instabank_put"}]},{"group":"klarna-gateway","pages":[{"title":"Create Klarna credentials","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Create Klarna credentials","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/klarna/credentials","href":"/checkout-api/klarna-gateway/admin_gateways_klarna_credentials_put"},{"title":"Update Klarna gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Klarna gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/klarna","href":"/checkout-api/klarna-gateway/admin_checkout_id_gw_klarna_put"}]},{"group":"netaxept-gateway","pages":[{"title":"Update overrides for Netaxept Gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update overrides for Netaxept Gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/netaxept/override","href":"/checkout-api/netaxept-gateway/admin_checkout_id_gw_override_netaxept_put"},{"title":"Update Netaxept gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Netaxept gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/netaxept","href":"/checkout-api/netaxept-gateway/admin_checkout_id_gw_netaxept_put"}]},{"group":"payex-gateway","pages":[{"title":"Create PayEx credentials","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Create PayEx credentials","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/payex/credentials","href":"/checkout-api/payex-gateway/admin_gateways_payex_credentials_put"},{"title":"Update overrides for PayEx Gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update overrides for PayEx Gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/payex/override","href":"/checkout-api/payex-gateway/admin_checkout_id_gw_override_payex_put"},{"title":"Update PayEx gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update PayEx gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/payex","href":"/checkout-api/payex-gateway/admin_checkout_id_gw_payex_put"}]},{"group":"santander-gateway","pages":[{"title":"Update store override for Santander gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update store override for Santander gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/santander/override","href":"/checkout-api/santander-gateway/admin_checkout_id_gw_override_santander_put"},{"title":"Update Santander gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Santander gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/santander","href":"/checkout-api/santander-gateway/admin_checkout_id_gw_santander_put"}]},{"group":"swish-gateway","pages":[{"title":"Update store override for Swish gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update store override for Swish gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/swish/override","href":"/checkout-api/swish-gateway/admin_checkout_id_gw_override_swish_put"},{"title":"Update Swish gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Swish gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/swish","href":"/checkout-api/swish-gateway/admin_checkout_id_gw_swish_put"}]},{"group":"vipps-gateway","pages":[{"title":"Update overrides for Vipps Gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update overrides for Vipps Gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/vipps/override","href":"/checkout-api/vipps-gateway/admin_checkout_id_gw_override_vipps_put"},{"title":"Update Vipps gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Vipps gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/vipps","href":"/checkout-api/vipps-gateway/admin_checkout_id_gw_vipps_put"}]},{"group":"dintero-psp-gateway","pages":[{"title":"Update Dintero PSP gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Dintero PSP gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/dintero_psp","href":"/checkout-api/dintero-psp-gateway/admin_checkout_id_gw_psp_put"}]},{"group":"kravia-gateway","pages":[{"title":"Update Kravia gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Kravia gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/kravia","href":"/checkout-api/kravia-gateway/admin_checkout_id_gw_kravia_put"}]},{"group":"two-gateway","pages":[{"title":"Update Two B2B gateway","description":"scopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update Two B2B gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/two","href":"/checkout-api/two-gateway/admin_checkout_id_gw_two_put"}]},{"group":"walley-gateway","pages":[{"title":"Create or update Walley gateway","description":"Create the Walley gateway configuration for the account, or replace the\nexisting configuration.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Create or update Walley gateway","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/gateways/walley","href":"/checkout-api/walley-gateway/admin_checkout_id_gw_walley_put"}]},{"group":"terminals","pages":[{"title":"List terminal operation results","description":"List administrative operations sent to any of the account's terminals,\nmost recently created first. Filter to a single terminal with\n`terminal_id`, or a single operation with `operation_id`.\n\nPoll this endpoint to see how a command finished: an operation is\ncreated as PENDING and reaches COMPLETED, FAILED or TIMEOUT once the\nterminal answers or the timeout window passes. The `result` of a\ncompleted operation is specific to the operation that was run.\n\nscopes:\n- admin:checkout\n- read:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"List terminal operation results","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/terminals/operations","href":"/checkout-api/terminals/admin_terminals_operations_get"},{"title":"Post terminal operation","description":"Send an administrative command to a payment terminal. These commands do not start a payment.\n\nThe response is returned immediately after the command is dispatched to the terminal, with status PENDING. The terminal's response is processed asynchronously. Use [GET /admin/terminals/operations](/api-reference/terminals/admin_terminals_operations_get) to see how the operation finished.\n\nWhile another operation of the same type is pending on the terminal, 409 is returned.\n\nEach operation also requires the terminal to be in a suitable status. The `operation` field below lists the status for each. The request is rejected with 400 when the status does not allow it.\n\nscopes:\n- admin:checkout\n- write:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"Post terminal operation","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/terminals/operations","href":"/checkout-api/terminals/admin_terminals_operations_post"},{"title":"List terminal activation tasks","description":"List activation tasks for a terminal, most recent first.\n\nscopes:\n- admin:checkout\n- read:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"List terminal activation tasks","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/terminals/{terminal_id}/activations","href":"/checkout-api/terminals/admin_terminals_terminal_id_activations_get"},{"title":"Trigger terminal activation","description":"Activate a terminal. Confirms the terminal is reachable and moves it\ninto an active, ready-to-use state. Call this once the terminal has\nbeen physically set up.\n\nscopes:\n- admin:checkout\n- write:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"Trigger terminal activation","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/terminals/{terminal_id}/activations","href":"/checkout-api/terminals/admin_terminals_terminal_id_activations_post"}]},{"group":"profiles","pages":[{"title":"Get session profile details","description":"scopes:\n- admin:checkout\n- write:checkout:/admin/session/profiles\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get session profile details","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/session/profiles/{profile_id}","href":"/checkout-api/profiles/admin_session_profile_details_get"},{"title":"Update session profile","description":"scopes:\n- admin:checkout\n- write:checkout:/admin/session/profiles\n","deprecated":null,"version":null,"sidebarTitle":"Update session profile","openapi":"/mintlify-docs/openapi/spec-checkout.yaml put /admin/session/profiles/{profile_id}","href":"/checkout-api/profiles/admin_session_profile_details_put"},{"title":"Delete session profile","description":"scopes:\n- admin:checkout\n- write:checkout:/admin/session/profiles\n","deprecated":null,"version":null,"sidebarTitle":"Delete session profile","openapi":"/mintlify-docs/openapi/spec-checkout.yaml delete /admin/session/profiles/{profile_id}","href":"/checkout-api/profiles/admin_session_profile_details_delete"},{"title":"List profiles","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List profiles","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/session/profiles","href":"/checkout-api/profiles/admin_session_profile_get"},{"title":"Create session profile","description":"scopes:\n- admin:checkout\n- write:checkout:/admin/session/profiles\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create session profile","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/session/profiles","href":"/checkout-api/profiles/admin_session_profile_post"}]},{"group":"secrets","pages":[{"title":"Get signature secret","description":"Get the current signature secret Dintero uses when create the\n`Dintero-Signature` header included in requests it sends to your\nendpoints.\n\nscopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get signature secret","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /admin/signature","href":"/checkout-api/secrets/admin_signature_get"},{"title":"Create signature secret","description":"Dintero can optionally sign all request it sends to your endpoints.\n\nWe do so by including a signature in the request `Dintero-Signature`\nheader. This allows you to verify that the request was done by\nDintero, not by a third party.\n\n*`v0-hmac-sha256`*\n\n```\n\u003ctimestamp>\\n\u003caccount_id>\\n\u003cmethod>\\n\u003chostname>\\n\u003cpathname>\\n\u003cquery>\n```\n\n```\nsecret: 123\ntimestamp: 1582236537\naccount_id: P00000000\nmethod: GET\nurl: https://example.com/callback?B=123\u0026A=992\n\nDintero-Signature: t=1582236537,\n v0-hmac-sha256=6bed2ab1b919d460ef7465a20dc6c97260dca73fab6647106ca525f0908df64a\n```\n\n> The timestamp (`t`) in the Dintero-Signature, is included in the signature payload to\n> mitigate `replay attach`. If your signature is valid but the timestamp is too old, you\n> can have your application reject the request. We recommend that your application have\n> a tolerance of five minutes between the timestamp and the current time.\n\n> *NOTE:* The query parameters must be sorted.\n\n> *NOTE:* The request body is not part of the `v0-hmac-sha256` signature.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create signature secret","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /admin/signature","href":"/checkout-api/secrets/admin_signature_post"}]},{"group":"Generate checkout image","pages":[{"title":"Get payment logos image","description":"Endpoint that returns an svg that can be used to show the world your payment options. [Go to the documentation for the checkout branding endpoints.](/docs/checkout/display-payment-logos)","deprecated":null,"version":null,"sidebarTitle":"Get payment logos image","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /branding/logos/{logos}/variant/{variant}/color/{color}/width/{width}/{template}","href":"/checkout-api/generate-checkout-image/branding_logoframe"},{"title":"Get checkout profile image","description":"Endpoint that returns an svg that can be used to show the world your payment options. [Go to the documentation for the checkout branding endpoints.](/docs/checkout/display-payment-logos)","deprecated":null,"version":null,"sidebarTitle":"Get checkout profile image","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /branding/profiles/{profile_id}/variant/{variant}/color/{color}/width/{width}/{template}","href":"/checkout-api/generate-checkout-image/branding_profile"}]},{"group":"collector","pages":[{"title":"Handle Collector Anti-fraud callback after an update","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Collector Anti-fraud callback after an update","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /callbacks/collector/antifraud","href":"/checkout-api/collector/checkout_sid_collector_callback_post"},{"title":"Handle authorization redirect from test IdP","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle authorization redirect from test IdP","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /events/gateways/collector/idp/signin/test","href":"/checkout-api/collector/checkout_collector_idp_signin_test_get"},{"title":"Handle authorization redirect from IdP","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle authorization redirect from IdP","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /events/gateways/collector/idp/signin","href":"/checkout-api/collector/checkout_collector_idp_signin_get"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/collector/redirect","href":"/checkout-api/collector/checkout_sid_collector_redirect_get"}]},{"group":"creditchecks","pages":[{"title":"Perform a credit check","description":"Perform a credit check\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Perform a credit check","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /creditchecks","href":"/checkout-api/creditchecks/creditchecks_post"}]},{"group":"vipps-epayment","pages":[{"title":"Handle Vipps callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Vipps callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/gateways/vipps/payment/hooks","href":"/checkout-api/vipps-epayment/checkout_vipps_webhooks_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/vipps/redirect/{redirect_ref}","href":"/checkout-api/vipps-epayment/checkout_sid_vipps_epayment_redirect_get"}]},{"group":"kravia","pages":[{"title":"Handle Kravia notifications","description":"This endpoint is used to handle notifications from Kravia payment gateway.\nKravia does not support dynamic webhook URLs per session, so the webhook URL is fixed.\n","deprecated":null,"version":null,"sidebarTitle":"Handle Kravia notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /events/gateways/kravia/notifications/{env}","href":"/checkout-api/kravia/checkout_kravia_notifications_post"}]},{"group":"identity","pages":[{"title":"Handle authorization redirect from IdP","description":"Generic endpoint for handling redirects from identity providers (IdP) after user authentication.\nCurrent IDP provider uses OAuth2 protocol, so the callback URL is static and should be registered with the IdP.\n","deprecated":null,"version":null,"sidebarTitle":"Handle authorization redirect from IdP","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /idp/{provider}/{env}/callback","href":"/checkout-api/identity/checkout_idp_verification_callback_get"}]},{"group":"bambora","pages":[{"title":"Handle Bambora callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Bambora callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/bambora/callback/{callback_ref}","href":"/checkout-api/bambora/checkout_bambora_callback_get"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/bambora/redirect/{redirect_ref}","href":"/checkout-api/bambora/checkout_sid_bambora_redirect_get"}]},{"group":"dintero","pages":[{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/dintero/redirect/{redirect_ref}","href":"/checkout-api/dintero/checkout_sid_dintero_redirect_get"}]},{"group":"dintero_psp","pages":[{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/dintero_psp/redirect/{redirect_ref}","href":"/checkout-api/dintero_psp/checkout_sid_dintero_psp_redirect_get"}]},{"group":"klarna","pages":[{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/klarna/redirect/{redirect_ref}","href":"/checkout-api/klarna/checkout_sid_klarna_redirect_get"},{"title":"Handle Klarna callback","description":"Handle authorization callback received from Klarna\n","deprecated":null,"version":null,"sidebarTitle":"Handle Klarna callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/klarna/callback/{callback_ref}","href":"/checkout-api/klarna/checkout_sid_klarna_callback_post"}]},{"group":"payex-v3","pages":[{"title":"Handle Payex callback after a change or update","description":"Creates a transaction from the session with status determined\nby the payment status provided by Payex.\n","deprecated":null,"version":null,"sidebarTitle":"Handle Payex callback after a change or update","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/payex-v3/callback/{callback_ref}","href":"/checkout-api/payex-v3/checkout_payex_v3_callback_post"},{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/payex-v3/redirect/{redirect_ref}","href":"/checkout-api/payex-v3/checkout_sid_payex_v3_redirect_get"}]},{"group":"santander","pages":[{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/santander/redirect","href":"/checkout-api/santander/checkout_sid_santander_redirect_get"}]},{"group":"two","pages":[{"title":"Handle redirect from payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle redirect from payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/two/redirect/{redirect_ref}","href":"/checkout-api/two/checkout_sid_two_redirect_get"},{"title":"Handle Two B2B callback","description":null,"deprecated":null,"version":null,"sidebarTitle":"Handle Two B2B callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/two/callback/{callback_ref}","href":"/checkout-api/two/checkout_two_callback_post"}]},{"group":"walley","pages":[{"title":"Cancel Walley payment","description":"Cancels the ongoing Walley payment, and redirects the end user back to the\nDintero Checkout page to retry the payment. The session isn't cancelled.\n\nThe request is authenticated with the `payment_ref`, which must match the\nactive Walley payment of the session.\n","deprecated":null,"version":null,"sidebarTitle":"Cancel Walley payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/walley/{payment_ref}/cancel","href":"/checkout-api/walley/checkout_sid_walley_cancel_get"},{"title":"Handle redirect from Walley payment","description":"Walley redirects the end user here when the Walley payment is completed.\nDintero fetches the payment from Walley to update the transaction, and\nthen redirects the end user to the return URL of the session.\n\nThe request is authenticated with the `payment_ref`, which must match the\nactive Walley payment of the session.\n","deprecated":null,"version":null,"sidebarTitle":"Handle redirect from Walley payment","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/walley/{payment_ref}/redirect","href":"/checkout-api/walley/checkout_sid_walley_redirect_get"},{"title":"Handle Walley notification","description":"Walley calls this endpoint when the Walley payment changes. Dintero then\nfetches the payment from Walley. Walley can call the endpoint more than\nonce for the same change.\n\nThe request is authenticated with the `payment_ref`, which must match the\nactive Walley payment of the session.\n","deprecated":null,"version":null,"sidebarTitle":"Handle Walley notification","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /sessions/{session_id}/walley/{payment_ref}/notification","href":"/checkout-api/walley/checkout_sid_walley_notification_get"},{"title":"Handle Walley callback","description":"Walley calls this endpoint for these callback types:\n\n- `ValidateOrder`: Checks that the session isn't paid or cancelled.\n Returns `200` with the `orderReference` if it can be paid, or `409` if\n it can't.\n- `PaymentFailed`: Not used. Returns `200`.\n\nAny other type returns `500`.\n\nThe request is authenticated with the `payment_ref`, which must match the\nactive Walley payment of the session. `body.checkoutId` must match the\nprivate ID of that Walley payment.\n","deprecated":null,"version":null,"sidebarTitle":"Handle Walley callback","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /sessions/{session_id}/walley/{payment_ref}/callback","href":"/checkout-api/walley/checkout_sid_walley_callback_post"}]},{"group":"files","pages":[{"title":"Get file","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get file","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /files/{fid}","href":"/checkout-api/files/files_fid_get"}]},{"group":"mtls-mastercard","pages":[{"title":"Mastercard card notifications","description":"Endpoint used by Mastercard for token notifications, via ALB mTLS\npassthrough.\n\nThe request is forwarded to Dintero PSP service after verifying mTLS\nclient certificate.\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard card notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /mtls/v1/checkout/mastercard/notifications/card","href":"/checkout-api/mtls-mastercard/mtls_mastercard_notifications_card_post"},{"title":"Mastercard DPA notifications","description":"Endpoint used by Mastercard for merchant DPA notifications, via ALB mTLS\npassthrough.\n\nPublishes the notification to auth service after verifying mTLS client certificate.\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard DPA notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /mtls/v1/checkout/mastercard/notifications/dpa","href":"/checkout-api/mtls-mastercard/mtls_mastercard_notifications_dpa_post"},{"title":"Mastercard Batch notifications","description":"Endpoint used by Mastercard for batch notification, via ALB mTLS\npassthrough.\n\nThe request is forwarded to Dintero PSP service after verifying mTLS\nclient certificate.\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard Batch notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /mtls/v1/checkout/mastercard/notifications/batch/enrollmentrecord","href":"/checkout-api/mtls-mastercard/mtls_mastercard_notifications_batch_enrollment_record_post"}]},{"group":"visa-notifications","pages":[{"title":"Visa token notifications","description":"Endpoint used by Visa for token notifications. The request is forwarded to Dintero PSP service.\n","deprecated":null,"version":null,"sidebarTitle":"Visa token notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml post /checkout/visa/notifications/token/{api_name}","href":"/checkout-api/visa-notifications/visa_notifications_token_post"}]},{"group":"apple pay notifications","pages":[{"title":"Apple Pay token notifications","description":"Endpoint used by Apple Pay for token notifications. The request is forwarded to Dintero PSP service.\n","deprecated":null,"version":null,"sidebarTitle":"Apple Pay token notifications","openapi":"/mintlify-docs/openapi/spec-checkout.yaml get /checkout/applepay/merchant/{merchant_id}/notification/merchantToken/{event_id}","href":"/checkout-api/apple-pay-notifications/apple_pay_notifications_token_get"}]}]}]},{"dropdown":"Core","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/cube.svg","groups":[{"group":"Core API","pages":[{"group":"password","pages":[{"title":"Change password","description":"Specify the email address of the user whose password you\nwould like to reset. If the call is successful, the user\nwill receive an email prompting them to change their password.\nThe caller must have scope `write:accounts:/auth/users` to perform a\nchange password request.\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Change password","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/change_password","href":"/core-api/password/aid_customers_change_password"},{"title":"Login with email/password","description":"Login a customer user, the caller must have scope\n`write:accounts:/auth/users`.\nIf MFA is enabled on account, use\n`write:accounts:/auth/users/no-mfa` to skip MFA.\nscopes:\n- write:accounts:/auth/users\n- write:accounts:/auth/users/no-mfa\n","deprecated":null,"version":null,"sidebarTitle":"Login with email/password","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/login","href":"/core-api/password/aid_customers_login_post"},{"title":"Login with MFA","description":"Initiate a Multi-Factor Authentication for a customer user, the caller must\nhave scope `write:accounts:/auth/users` to perform a login.\nPost the `ident_type`, along with the `ident` and `secret`.\nThe server will return a challenge response specifying the\n`challenge_type` that will have to be completed to when getting an access\ntoken from the `POST /v1/accounts/{oid}/auth/token` endpoint.\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Login with MFA","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/mfa_login","href":"/core-api/password/aid_customers_mfa_login_post"},{"title":"MFA recovery","description":"Initiate a Multi-Factor Authentication recovery login for a customer user\nthat has forgotten/lost their `secret`.\nSpecify the ident_type and the ident (email or phone_number) of the user. If\nthe call is successful, the user will get an email with an one time recovery\ncode that has to be submitted to the mfa_recovery endpoint.\nWhen a valid one time recovery has been posted the server response with a\nregular MFA challenge.\nOnce authenticated the password or pin can be changed by updating the\ncustomer.\nscopes:\n - write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"MFA recovery","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/mfa_login_recovery","href":"/core-api/password/aid_customers_mfa_login_initiate_recovery_post"}]},{"group":"company","pages":[{"title":"Get departments","description":"List all departments register by company customers\n\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Get departments","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/company/departments","href":"/core-api/company/aid_company_departments_get"}]},{"group":"settings","pages":[{"title":"Customers settings","description":"Get customers settings\n\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customers settings","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/settings","href":"/core-api/settings/aid_customers_atributes_get"},{"title":"Update settings","description":"Update customers settings\n\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update settings","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/customers/settings","href":"/core-api/settings/aid_customers_atributes_put"}]},{"group":"tags","pages":[{"title":"Tags collection","description":"Get all customer tags (also known as groups).\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Tags collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/tags","href":"/core-api/tags/aid_customers_tags_get"},{"title":"Create new Tag","description":"Create a tag\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Tag","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/tags","href":"/core-api/tags/aid_customers_tags_post"},{"title":"Delete Tag","description":"Delete a tag.\nA deleted tag is removed from customer tags\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete Tag","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/customers/tags/{tag_id}","href":"/core-api/tags/aid_customers_tags_tid_delete"},{"title":"Tag collection","description":"Get tags for a customer\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Tag collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/users/{customer_id}/tags","href":"/core-api/tags/aid_customers_cid_tags_get"},{"title":"Update Customer Tags","description":"Update Customer Tags\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update Customer Tags","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/customers/users/{customer_id}/tags","href":"/core-api/tags/aid_customers_cid_tags_put"}]},{"group":"terms","pages":[{"title":"Terms collection","description":"Get all customer terms and conditions\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Terms collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/terms","href":"/core-api/terms/aid_customers_terms_get"},{"title":"Create new Terms","description":"Create customer terms and conditions\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Terms","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/terms","href":"/core-api/terms/aid_customers_terms_post"},{"title":"Terms details","description":"Get single terms and conditions\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Terms details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/terms/{tid}","href":"/core-api/terms/aid_customers_terms_tid_post"},{"title":"Delete Term","description":"Delete the customer term\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete Term","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/customers/terms/{tid}","href":"/core-api/terms/aid_customers_terms_tid_delete"}]},{"group":"tokens","pages":[{"title":"Get token events","description":"Get the token events\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Get token events","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/tokens/events","href":"/core-api/tokens/aid_customers_tokens_events_get"},{"title":"Find / Add token events","description":"Find details about a token, inclusive details about\nany customer the token belongs to and any token events recorded\nInclude event in the request to update the status of the token\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Find / Add token events","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/tokens/events","href":"/core-api/tokens/aid_customers_tokens_events_post"},{"title":"Delete token events","description":"Delete the connection between token (type/value) and\nlist of events.\nInclude an event in the request to store the reason\nfor the request\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete token events","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/customers/tokens/events","href":"/core-api/tokens/aid_customers_tokens_events_delete"},{"title":"Token collections","description":"Get all tokens for a Customer\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Token collections","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/users/{customer_id}/tokens","href":"/core-api/tokens/aid_customers_cid_tokens_get"},{"title":"Create new Token","description":"Create a new customer token\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/users/{customer_id}/tokens","href":"/core-api/tokens/aid_customers_cid_tokens_post"},{"title":"Delete customer token","description":"Delete Token\n\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer token","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/customers/users/{customer_id}/tokens/{tid}","href":"/core-api/tokens/aid_customers_cid_tokens_tid_delete"}]},{"group":"users","pages":[{"title":"Customer collection","description":"Get all customers, limited by parameters. The result will\nmatch all parameters with `AND`.\nSearch is done by prefix match, and `+` in phone_number/email\nmust be URL encoded, (+4799999999 => %2B4799999999)\n\nUsers with type `contact` are by default excluded from the result,\nuse `type=contact` or `type=any` to include contact users\n\nThe response from a request that match contact users will include the\nusers that are linked from the contact\n\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customer collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/users","href":"/core-api/users/aid_customers_get"},{"title":"Create new Customer","description":"Create a new customer, `customer_id`, `email` and `phone_number` must\nbe unique if specified.\nscopes:\n- admin:customers\n- write:customers\n- create:customers:/users\n","deprecated":null,"version":null,"sidebarTitle":"Create new Customer","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/users","href":"/core-api/users/aid_customers_post"},{"title":"User exist","description":"Check if there is users that match the parameters. The result will\nmatch all parameters with `AND`.\nThis endpoint must be enabled from [PUT /customers/settings](/customers-api/settings/aid_customers_atributes_put)\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"User exist","openapi":"/mintlify-docs/openapi/spec-core.yaml head /accounts/{aid}/customers/users","href":"/core-api/users/aid_customers_head"},{"title":"Customer details","description":"Customer details\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n- user:customers:/customer/details\n","deprecated":null,"version":null,"sidebarTitle":"Customer details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/users/{customer_id}","href":"/core-api/users/aid_customers_cid_get"},{"title":"Update Customer","description":"Update customer properties, properties not included in the body\nwill remain unchanged.\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update Customer","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/customers/users/{customer_id}","href":"/core-api/users/aid_customers_cid_put"},{"title":"Delete customer","description":"Delete single customer\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/customers/users/{customer_id}","href":"/core-api/users/aid_customers_cid_delete"},{"title":"Change customer_id","description":"Update customer_id for an customer\n**warning**: Any external resources \"owned\" by the user, i.e\nreceipts, discounts etc. will not be updated with the new\ncustomer_id.\nA new metadata property `dintero_change_customer_id_{timestamp}.{hash}`\nwill be added everytime the customer_id is changed\nFollowing data will be included in the metadata property\n - created_at\n - created_by\n - old\n - new\nscopes:\n- admin:customers\n- admin:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Change customer_id","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/users/{customer_id}/change_customer_id","href":"/core-api/users/aid_customers_cid_change_customer_id_post"}]},{"group":"communication","pages":[{"title":"Customer email/phone_number Status","description":"Get the status of customer email / phone_number communication\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customer email/phone_number Status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/customers/users/{customer_id}/communication","href":"/core-api/communication/aid_customers_cid_verify_get"},{"title":"Verify Customer email/phone_number","description":"Verify customer email/phone_number field. Consist of\nto steps:\n - send verification code to the customer (sms or email)\n - verify the email/phone_number by posting verification code sent to customer\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Verify Customer email/phone_number","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/customers/users/{customer_id}/communication/{operation}/{field}","href":"/core-api/communication/aid_customers_cid_verify_post"}]},{"group":"locations","pages":[{"title":"Locations collection","description":"Get all sales locations, the starting_after have to be set to location_id\nscopes:\n- admin:locations\n- read:locations\n","deprecated":null,"version":null,"sidebarTitle":"Locations collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/locations","href":"/core-api/locations/aid_locations_get"},{"title":"Create new sales location","description":"Create a sales location\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Create new sales location","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/locations","href":"/core-api/locations/aid_location_post"},{"title":"Location details","description":"Get single sales location\nscopes:\n- admin:locations\n- read:locations\n","deprecated":null,"version":null,"sidebarTitle":"Location details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/locations/{lid}","href":"/core-api/locations/aid_locations_lid_get"},{"title":"Update Sales location","description":"Update location properties\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Update Sales location","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/locations/{lid}","href":"/core-api/locations/aid_location_lid_put"},{"title":"Delete location","description":"Delete single location\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Delete location","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/locations/{lid}","href":"/core-api/locations/aid_location_lid_delete"}]},{"group":"organizations","pages":[{"title":"Search external organization registry","description":"Proxy queries to the Norwegian or Danish organization registry.\n\nPlease note that the only supported countries currently are \"no\" (Norway)\nand \"dk\" (Denmark).\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Search external organization registry","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/search/external/organizations/{country}","href":"/core-api/organizations/aid_search_external_organizations_country"},{"title":"Get addresses for organization number from external organization registry","description":"scopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Get addresses for organization number from external organization registry","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/search/external/organizations/{country}/{organization_number}","href":"/core-api/organizations/aid_get_external_organizations"}]},{"group":"addresses","pages":[{"title":"Search external postal place","description":"Get postal place by country and postal code.\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Search external postal place","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/search/external/postal_place/{country}/{postal_code}","href":"/core-api/addresses/aid_search_external_postal_place"},{"title":"Validate address","description":"Validate the given address and return close matching alternative\nsuggestions if the provided address was most likely wrong.\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Validate address","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/search/external/address/{country}/validate","href":"/core-api/addresses/aid_search_external_validate_address"}]},{"group":"rules automations","pages":[{"title":"Automation collection","description":"Get available automations for the account\n\nscopes:\n- admin:automations\n- read:automations\n","deprecated":null,"version":null,"sidebarTitle":"Automation collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/automations/rules","href":"/core-api/rules-automations/aid_automations_rules_get"},{"title":"Create new automation","description":"Create a discount automation to apply on events received.\n\n\nA automation can be used to automate the task of\ngiving discount to customers. The customer found in\nthe event will receive the discount.\n\n###\nWelcome discount: give discount to new user\n\n {\n \"requirement\": {\n \"events\": [\"customer_add\"],\n \"automation_from\": \"2018-05-07T08:54:31Z\",\n \"automation_to\": \"2018-06-07T08:54:31Z\"\n },\n \"actions\": [\n {\n \"type\": \"discount\",\n \"id\": \"cae3e485-0e15-4afa-bc66-472f843efb84\"\n }\n ]\n }\n\n###\nPurchase discount: give discount on first purchase at store\n\n {\n \"name\": \"purchase at store sc029\",\n \"requirement\": {\n \"events\": [\"receipt_add\"],\n \"automation_from\": \"2018-05-07T08:54:31Z\",\n \"automation_to\": \"2018-06-07T08:54:31Z\",\n \"filters\": {\n \"$.store.id\": [\"sc029\"]\n }\n },\n \"actions\": [\n {\n \"type\": \"discount\",\n \"id\": \"cae3e485-0e15-4afa-bc66-472f843efb84\"\n }\n ],\n \"limitation\": {\n \"automation_repeat\": 1\n }\n }\n\nscopes:\n- admin:automations\n- write:automations\n","deprecated":null,"version":null,"sidebarTitle":"Create new automation","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/automations/rules","href":"/core-api/rules-automations/aid_automations_rules_post"},{"title":"Automation details","description":"Get details about an automations\n\nscopes:\n- admin:automations\n- read:automations\n","deprecated":null,"version":null,"sidebarTitle":"Automation details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/automations/rules/{arid}","href":"/core-api/rules-automations/aid_automations_rules_rid_get"},{"title":"Delete automation","description":"Delete an automation rule.\n\nscopes:\n- admin:automations\n- write:automations\n","deprecated":null,"version":null,"sidebarTitle":"Delete automation","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/automations/rules/{arid}","href":"/core-api/rules-automations/aid_automations_rules_rid_delete"}]},{"group":"use discounts","pages":[{"title":"Post receipt for discount","description":"Find discounts available for the receipt\n\n### Active discounts\n\n- `customer_id` will be used to find active discounts for the purchase.\n- `customer.token` will be used to resolve `customer_id` if no `customer_id` is provided.\n- No discounts will be given if the token does not resolve to any customer_id.\n- A receipt with no `customer_id` and no `customer.token` will only be applicable for\n active discounts given to **`/`**\n ([see](/discounts-api/rules-customers/aid_discounts_did_customers_post))\n\n### Requirement of the receipt\n\n - all items must have `eligible_for_discount` set to enable for discount\n - all items must have a positive `gross_amount` to qualify for discount\n - a `net` base discount reward requires the receipt to include existing\n discounts as discount_lines (on item) in order to calculate net\n\nA receipt that qualified for discount will have the `is_change`\nproperty set to true. Any items that has received a discount will be\nflagged by `is_change` and have one or more new entries to its\ndiscount_lines.\n\nThe receipt `discounts` list will be populated with all discounts the\nreceipt is qualified to receive\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Post receipt for discount","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/available_for_receipt","href":"/core-api/use-discounts/aid_discounts_available_for_receipt_post"},{"title":"Claim collections","description":"Get all claims, limited by parameters. The result will\nmatch all parameters with `AND`\n\nscopes:\n- admin:discounts\n- read:discounts\n- read:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Claim collections","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/available_for_receipt/claims","href":"/core-api/use-discounts/aid_discounts_available_for_receipt_get_claims"},{"title":"Claim discounts","description":"Claim discount rewards, checks will be done to ensure that all\ndiscount limitation are uphold\n\nNote, only the following discount limitation will affect\nthe success of a claim\n\n - discount_reward_usage\n - discount_repeat_usage\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Claim discounts","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/available_for_receipt/claims","href":"/core-api/use-discounts/aid_discounts_available_for_receipt_post_claim"},{"title":"Get claim","description":"Get details about a claim\n\nscopes:\n- admin:discounts\n- read:discounts\n- read:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/available_for_receipt/claims/{claim_id}","href":"/core-api/use-discounts/aid_discounts_available_for_receipt_get_claim"},{"title":"Delete claim","description":"Release claim on discounts, revert previously claimed discount\nand make them available for future purchase\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Delete claim","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/discounts/available_for_receipt/claims/{claim_id}","href":"/core-api/use-discounts/aid_discounts_available_for_receipt_delete_claim"},{"title":"Post event","description":"Send an Event to the service.\n\n- rules automations will receive the event and give\n its discount to the customer found in the event\n\n\n- Token received will be stored to support resolving\n customer from token when handling discounts available\n for receipt\n\n scopes:\n - admin:discounts\n - write:discounts\n - write:discounts:/events\n","deprecated":null,"version":null,"sidebarTitle":"Post event","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/events","href":"/core-api/use-discounts/aid_discounts_events_post"}]},{"group":"campaigns","pages":[{"title":"Campaigns collection","description":"List campaigns\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Campaigns collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/campaigns","href":"/core-api/campaigns/aid_discounts_campaigns_get"},{"title":"Create new campaign","description":"Create a new campaign to group discount rules\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Create new campaign","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/campaigns","href":"/core-api/campaigns/aid_discounts_campaigns_post"},{"title":"Campaign details","description":"Get more details about a campaign\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Campaign details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/core-api/campaigns/aid_discounts_campaigns_campaign_id_get"},{"title":"Update Campaign","description":"Update campaign details. Undeletes a deleted campaign.\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Campaign","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/core-api/campaigns/aid_discounts_campaigns_campaign_id_put"},{"title":"Delete campagn","description":"Delete a campagn.\n\nDeleting a campagn does not affect its discount rules. i.e. active\ncampagn rules will continue to be active after deleting the campagn\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete campagn","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/core-api/campaigns/aid_discounts_campaigns_campaign_id_delete"}]},{"group":"rules customers","pages":[{"title":"Get customer discount ref","description":"Get a customer discount ref.\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get customer discount ref","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/core-api/rules-customers/aid_discounts_customer_cid_get_ref_id"},{"title":"Update customer discount ref","description":"Add stamps and usage to a discount ref.\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update customer discount ref","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/core-api/rules-customers/aid_discounts_customer_cid_post_ref_id"},{"title":"Delete customer discount ref","description":"Delete a customer discount ref. The discount will no longer\nbe available on purchase ([Post receipt for discount](/discounts-api/use-discounts/aid_discounts_available_for_receipt_post))\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer discount ref","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/core-api/rules-customers/aid_discounts_customer_cid_delete_ref_id"},{"title":"Customer discounts collection","description":"Get all discounts available for a customer, result will exclude\nexpired and inactive discounts\n\n\nExpired discounts are:\n\n - discount used up (customer has allready used it) and there\n was a limitation on the discount that prevents more use.\n - discount requirement purchase periode is in the past\n - discount that has been deleted\n\nInactive discounts are:\n\n - discount with `active` property set to false.\n\nUse value of `ref_id` as parameter value of `starting_after`\n\nscopes:\n- admin:discounts\n- read:discounts\n- user:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Customer discounts collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/customers/{customer_id}/rules","href":"/core-api/rules-customers/aid_discounts_customer_cid_get"},{"title":"Get discount customers (refs)","description":"Get list of customers refs for a discount. A ref is an instant\nof discount given to a customer or `all customers`. See\n[Add customers](/discounts-api/rules-customers/aid_discounts_did_customers_post)\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get discount customers (refs)","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/rules/{did}/customers","href":"/core-api/rules-customers/aid_discounts_did_customers_get"},{"title":"Add customers","description":"Give the Discount to one or more customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Add customers","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/rules/{did}/customers","href":"/core-api/rules-customers/aid_discounts_did_customers_post"},{"title":"Remove customers","description":"Remove Discount from one or more customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Remove customers","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/discounts/rules/{did}/customers","href":"/core-api/rules-customers/aid_discounts_did_customers_delete"},{"title":"Get discount ref usages","description":"Get list of discount refs usages.\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get discount ref usages","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/rules/{did}/usages","href":"/core-api/rules-customers/aid_discounts_did_usages_get"}]},{"group":"rules","pages":[{"title":"Public Discount collection","description":"Get all discounts available for any customer given\ncurrent date, result will exclude expired and inactive\ndiscounts\n\nUse value of `ref_id` as parameter value of `starting_after`\n\nscopes:\n- admin:discounts\n- read:discounts\n- public:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Public Discount collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/public/rules","href":"/core-api/rules/aid_discounts_public_get"},{"title":"Discount collection","description":"List discounts available for the account\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Discount collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/rules","href":"/core-api/rules/aid_discounts_get"},{"title":"Create new discount","description":"Create a new discount for an account.\n\nA new discount will be **unavailable** for purchases\nuntil the discount is given to one or more customer.\n\nDiscount can be given to a customer by either adding\na automation to the discount that will grant the\ndiscount to the customer from events received or by\nadding customers to the discount.\n\nSee [Discount Examples](#section/Discount-Examples)\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Create new discount","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/discounts/rules","href":"/core-api/rules/aid_discounts_post"},{"title":"Discount details","description":"Get more details about a discount, includes statistics\nabout the discount\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Discount details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/discounts/rules/{did}","href":"/core-api/rules/aid_discounts_did_get"},{"title":"Update Discount","description":"Update discount details.\n\n\n**Caution**: Update of non-meta properties, properties that\nchanges requirement or limitation can create conflict with\nthe usage history of the discount.\n\nExample is to change requirement.item.items, such change would\nmean that purchases before the change would not be correctly\nrewarded given the new version of the discount.\n\nWe recommend to limit the update of a discount to meta only\nproperties if the discount has previously been used in a\npurchase.\n\nUpdate on requirement `purchase_to` is only supported when\nthe new value that is after current value.\n\n`purchase_from` can not be updated. Changing `purchase_to` or\n`limitation.dynamic_purchase_to_days` also updates the customer\ndiscounts already given, and is only supported with `mode=merge`.\n\n`reward` can be updated. The replace rules are described in the\n`reward` property of the request body.\n\n`requirement` and `limitation` keys are merged with the current\nvalues. Use `mode=replace` to replace the rule, for example to\nremove a key.\n\nThe discount `type` (receipt/item) is derived from the updated\n`requirement.item`.\n\nThe reward of a `discount_debit` discount can not be changed, and a\nreward can not be changed to `discount_debit`. Only `reward.base`\ncan be updated.\n\nUpdate `discount.active` to toggle if an discount is active\nand available for purchase.\n\nUpdate `discount.private` to toggle if an discount is included\nin public discount collection if given to all customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Discount","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/discounts/rules/{did}","href":"/core-api/rules/aid_discounts_did_put"},{"title":"Delete discount","description":"Delete a discount\n\n- Customer that has previously received the discount will not\n be able to use it on purchases.\n- rules automations belonging to the discount will be deleted\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete discount","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/discounts/rules/{did}","href":"/core-api/rules/aid_discounts_did_delete"}]},{"group":"account users","pages":[{"title":"Authenticated User","description":"Get public and private profile information when authenticated\nthrough Bearer auth\n\n> Use ID token as Bearer token if the user was authenticated\n> externally. The ID token must include a `email` claim that\n> identifies the account user.\n\nscopes:\n- openid\n- aws.cognito.signin.user.admin\n","deprecated":null,"version":null,"sidebarTitle":"Authenticated User","openapi":"/mintlify-docs/openapi/spec-core.yaml get /account/user","href":"/core-api/account-users/account_user_get"},{"title":"Configure SMS MFA","description":"Update the user SMS MFA configuration\n","deprecated":null,"version":null,"sidebarTitle":"Configure SMS MFA","openapi":"/mintlify-docs/openapi/spec-core.yaml put /account/user/mfa/sms","href":"/core-api/account-users/account_user_mfa_sms_put"},{"title":"Change User password","description":"Change the password for the account user\n\nscopes:\n- openid\n","deprecated":null,"version":null,"sidebarTitle":"Change User password","openapi":"/mintlify-docs/openapi/spec-core.yaml post /account/user/password","href":"/core-api/account-users/account_user_password_put"},{"title":"Users Collection","description":"Get list of all users with access to the account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Users Collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/management/users","href":"/core-api/account-users/aid_accounts_aid_mgmnt_users_get"},{"title":"Create User","description":"Create and grant user access to the account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create User","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/management/users","href":"/core-api/account-users/aid_accounts_aid_mgmnt_users_post"},{"title":"Update User","description":"Update user\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update User","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{oid}/management/users/{uid}","href":"/core-api/account-users/aid_accounts_aid_mgmnt_users_put"},{"title":"Delete User","description":"Delete a user from an account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete User","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{oid}/management/users/{uid}","href":"/core-api/account-users/aid_accounts_aid_mgmnt_users_delete"},{"title":"Get user activity log","description":"Get activities for User\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get user activity log","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/management/users/{uid}/activities","href":"/core-api/account-users/aid_accounts_aid_mgmnt_users_activities_get"}]},{"group":"challenge","pages":[{"title":"Challenge request","description":"Request a challenge for multi-factor authentication (MFA) based\non the challenge types supported by the user.\n\nThe challenge_type is how the user will get the challenge\nand prove possession. Supported challenge types include:\n\n - `oob`: for SMS messages or out-of-band (OOB)\n\nUse the response to request access token from the\n[auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) endpoint\nwith `grant_type=mfa_oob`\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/mfa\n","deprecated":null,"version":null,"sidebarTitle":"Challenge request","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/auth/mfa/challenge","href":"/core-api/challenge/aid_auth_mfa_challenge_post"},{"title":"Recovery","description":"Request a recovery for user with multi-factor\nauthentication (MFA) enabled.\n\nA recovery is done with two out-of-band (OOB) challenges\nover different channels.\n\nUse the response to request access token from the\n[auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) endpoint\nwith `grant_type=mfa_oob`.\n\nA `403 status` with `mfa_required` error will be returned on success,\nuse the response to request a new challenge from the\n[auth/mfa/challenge](/management-auth-api/challenge/aid_auth_mfa_challenge_post) endpoint.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/mfa\n","deprecated":null,"version":null,"sidebarTitle":"Recovery","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/auth/mfa/recovery","href":"/core-api/challenge/aid_auth_mfa_recovery_post"}]},{"group":"auth users","pages":[{"title":"Create User","description":"Create a new user\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Create User","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/auth/users","href":"/core-api/auth-users/aid_auth_users_post"},{"title":"Update user","description":"Update existing user with new password\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Update user","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/auth/users/{username}","href":"/core-api/auth-users/aid_auth_users_username_put"},{"title":"Delete user","description":"Delete existing user\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Delete user","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/auth/users/{username}","href":"/core-api/auth-users/aid_auth_users_username_delete"},{"title":"Change username","description":"Update existing users username\n\nscopes:\n- admin:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Change username","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/auth/users/{username}/change_username","href":"/core-api/auth-users/aid_auth_users_username_change_username_post"}]},{"group":"account-assets","pages":[{"title":"Create asset upload url","description":"Create an upload URL that can be used to transfere the asset\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/assets\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create asset upload url","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/assets","href":"/core-api/account-assets/aid_account_assets_post"}]},{"group":"account-settings","pages":[{"title":"Get Account settings","description":"Get details about the account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Account settings","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings","href":"/core-api/account-settings/aid_account_aid_get"},{"title":"Update Account Settings","description":"Update account settings\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Account Settings","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings","href":"/core-api/account-settings/aid_account_settings_put"}]},{"group":"approvals","pages":[{"title":"List payment approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List payment approvals","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/approvals/payments","href":"/core-api/approvals/aid_management_settings_approvals_payment_get"},{"title":"New payment approval","description":"Initiate an application for using Dintero payments . The application\nwill contain a link to an URL where the signatory of the account will need\nto finish submission of the case contract and sign it. Dintero will perform\na KYC, AML and bank ownership check before the application\n`case_status`will be updated to `ACTIVE`. Once the application is approved\nwe will set up your account for using Dintero payments. Note that not all\npayment methods are available in all countries, and that for some payments\nmethods some processing time must be expected before you can start accepting\npayments.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"New payment approval","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/approvals/payments","href":"/core-api/approvals/aid_management_settings_approvals_payment_post"},{"title":"List seller approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List seller approvals","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/core-api/approvals/aid_management_settings_approvals_payout_destinations_get"},{"title":"New seller approval","description":"Initiate an application for a new seller for Dintero Payout with\nsplit-payment. The application will contain a link to an URL where the\nsignatory of the seller will need to finish submission of the\ncase contract and sign it. Dintero will perform a KYC, AML and bank ownership\ncheck on the seller before the application `case_status`will be\nupdated to `ACTIVE`. Once the application is approved, the payout\ndestination will be added automatically to the Dintero Payout service.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n\n---\n For testing purposes it is possible to auto-approve or decline a new seller by adding one of the following values to `payout_destination_description`:\n\n - \"AUTO_APPROVE\": Approves the case automatically, the case status will be set to `ACTIVE`\n - \"AUTO_DECLINE\": Declines the case automatically, the case status will be set to `DECLINED`\n - \"AUTO_WAITING_FOR_SIGNATURE\": Leaves the signature check for the case, the case status will be set to `WAITING_FOR_SIGNATURE`\n\nNOTE: This behavior is only available in test mode, i.e. with an `aid` prefixed with \"T\".\n\n---\n Dintero admins (access tokens with the `admin:dintero` scope) can replace Dintero's standard terms for sellers with links to custom agreements by supplying `custom_agreements`. A case created with `custom_agreements` is always reviewed manually, it is never approved automatically.\n","deprecated":null,"version":null,"sidebarTitle":"New seller approval","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/core-api/approvals/aid_management_settings_approvals_payout_destinations_post"}]},{"group":"account-cdd","pages":[{"title":"Get list of due diligence cases","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get list of due diligence cases","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/cdd/cases","href":"/core-api/account-cdd/aid_management_settings_cdd_cases_get"},{"title":"Create a due diligence case","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create a due diligence case","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/cdd/cases","href":"/core-api/account-cdd/aid_management_settings_cdd_cases_post"},{"title":"Post updated case","description":"Performs a GET on CDD Service to get the updated case (ignores body).\n","deprecated":null,"version":null,"sidebarTitle":"Post updated case","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/cdd/cases/{id}/callback","href":"/core-api/account-cdd/aid_management_settings_cdd_cases_callback"}]},{"group":"account-connections","pages":[{"title":"Get Mastercard 3D-Secure signup status","description":"Check status for enrolling the merchant into 3D-Secure for Mastercard\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Get Mastercard 3D-Secure signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/mastercard-3ds","href":"/core-api/account-connections/aid_account_settings_connections_mastercard_3ds_get"},{"title":"Mastercard 3D-Secure signup","description":"Enrol the merchant into 3D-Secure for Mastercard\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard 3D-Secure signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/mastercard-3ds","href":"/core-api/account-connections/aid_account_settings_connections_mastercard_3ds_post"},{"title":"Bambora PayFac signup","description":"Initialize Bambora PayFac signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Bambora PayFac signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/bambora-payfac","href":"/core-api/account-connections/aid_account_settings_connections_bambora_payfac_post"},{"title":"Get Bambora signup status","description":"Get details about the Bambora configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Bambora signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/bambora","href":"/core-api/account-connections/aid_account_settings_connections_bambora_get"},{"title":"Bambora signup","description":"**DEPRECATED** \n\nOld signup for bambora. Please use Bambora Direct or Bambora Payfac for new signups.\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Bambora signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/bambora","href":"/core-api/account-connections/aid_account_settings_connections_bambora_post"},{"title":"Bambora Callback","description":"Handle callback from Bambora signup\n\nCompletes the Bambora signup, enables Bambora for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/bambora\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Bambora Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/bambora/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_bambora_callback_post"},{"title":"Get Collector Bank signup status","description":"Get details about the Collector Bank configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Collector Bank signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/collector","href":"/core-api/account-connections/aid_account_settings_connections_collector_get"},{"title":"Collector Bank signup","description":"Initialize Collector Bank signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Collector Bank signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/collector","href":"/core-api/account-connections/aid_account_settings_connections_collector_post"},{"title":"Collector Bank Callback","description":"Handle callback from Collector Bank signup\n\nCompletes the Collector Bank signup, enables Collector Bank for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/collector\n- write:accounts\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Collector Bank Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/collector/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_collector_callback_post"},{"title":"Get Common signup status","description":"Get details about the Common configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Common signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/common","href":"/core-api/account-connections/aid_account_settings_connections_common_get"},{"title":"Common signup","description":"Initialize Common signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Common signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/common","href":"/core-api/account-connections/aid_account_settings_connections_common_post"},{"title":"Get link to the Common signup object with sensitive signup data","description":"Endpoint used by the Dintero Onboarding Team, get link to the common\nconfiguration signup object.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Get link to the Common signup object with sensitive signup data","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/common/signup","href":"/core-api/account-connections/aid_account_settings_connections_common_signup_url_post"},{"title":"Get Instabank signup status","description":"Get details about the Instabank\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Instabank signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/instabank","href":"/core-api/account-connections/aid_account_settings_connections_instabank_get"},{"title":"Instabank signup","description":"Initialize Instabank signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Instabank signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/instabank","href":"/core-api/account-connections/aid_account_settings_connections_instabank_post"},{"title":"Instabank Callback","description":"Handle callback from Instabank signup\n\nCompletes the Instabank signup, enables Instabank for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/instabank\n","deprecated":null,"version":null,"sidebarTitle":"Instabank Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/instabank/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_instabank_callback_post"},{"title":"Get Klarna signup status","description":"Get details about the Klarna configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Klarna signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/klarna","href":"/core-api/account-connections/aid_account_settings_connections_klarna_get"},{"title":"Klarna signup","description":"Initialize Klarna signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Klarna signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/klarna","href":"/core-api/account-connections/aid_account_settings_connections_klarna_post"},{"title":"Get PayEx signup status","description":"Get details about the Vipps\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get PayEx signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/payex/{payment_product_type}","href":"/core-api/account-connections/aid_account_settings_connections_payex_get"},{"title":"PayEx signup","description":"Initialize PayEx signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"PayEx signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/payex/{payment_product_type}","href":"/core-api/account-connections/aid_account_settings_connections_payex_post"},{"title":"PayEx Callback","description":"Handle callback from PayEx signup\n\nCompletes the PayEx signup, enables PayEx for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/payex\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"PayEx Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/payex/{payment_product_type}/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_payex_callback_post"},{"title":"PayEx overrides","description":"Add PayEx overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"PayEx overrides","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings/connections/payex/overrides","href":"/core-api/account-connections/aid_account_settings_connections_payex_overrides_put"},{"title":"Santander overrides","description":"Add Santander overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Santander overrides","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings/connections/santander/overrides","href":"/core-api/account-connections/aid_account_settings_connections_santander_overrides_put"},{"title":"Get Swish signup status","description":"Get details about the Swish configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Swish signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/swish","href":"/core-api/account-connections/aid_account_settings_connections_swish_get"},{"title":"Swish signup","description":"Initialize Swish signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Swish signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/swish","href":"/core-api/account-connections/aid_account_settings_connections_swish_post"},{"title":"Swish Callback","description":"Handle callback from Swish signup\n\nCompletes the Swish signup, enables Swish for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/swish\n","deprecated":null,"version":null,"sidebarTitle":"Swish Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/swish/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_swish_callback_post"},{"title":"Swish overrides","description":"Add Swish overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Swish overrides","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings/connections/swish/overrides","href":"/core-api/account-connections/aid_account_settings_connections_swish_overrides_put"},{"title":"Get Vipps signup status","description":"Get details about the Vipps\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Vipps signup status","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/management/settings/connections/vipps","href":"/core-api/account-connections/aid_account_settings_connections_vipps_get"},{"title":"Vipps signup","description":"Reinitialize Vipps signup if connection is not enabled.\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Vipps signup","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings/connections/vipps","href":"/core-api/account-connections/aid_account_settings_connections_vipps_put"},{"title":"Vipps signup","description":"Initialize Vipps signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Vipps signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/vipps","href":"/core-api/account-connections/aid_account_settings_connections_vipps_post"},{"title":"Vipps Callback","description":"Handle callback from Vipps signup\n\nCompletes the Vipps signup, enables Vipps for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/vipps\n","deprecated":null,"version":null,"sidebarTitle":"Vipps Callback","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/management/settings/connections/vipps/{callback_reference}","href":"/core-api/account-connections/aid_account_settings_connections_vipps_callback_post"},{"title":"Vipps overrides","description":"Add Vipps overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Vipps overrides","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/management/settings/connections/vipps/overrides","href":"/core-api/account-connections/aid_account_settings_connections_vipps_overrides_put"}]},{"group":"authenticate","pages":[{"title":"Authorize Passwordless link","description":"This endpoint is used to authorize Passwordless link sent to user\nby email/sms.\n\nA valid request will redirect to\nThis is the OAuth 2.0 grant that Client-side web apps\nutilize in order to access an API.\n","deprecated":null,"version":null,"sidebarTitle":"Authorize Passwordless link","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/authorize","href":"/core-api/authenticate/aid_auths_oauth_authorize_post"},{"title":"Authorize with OIDC","description":null,"deprecated":null,"version":null,"sidebarTitle":"Authorize with OIDC","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/oidc/authorize","href":"/core-api/authenticate/aid_auths_oidc_authorize_get"},{"title":"Token verified by OIDC","description":"Use this endpoint to obtains an access token by presenting its authorization\ngrant\n\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Token verified by OIDC","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/oidc/token","href":"/core-api/authenticate/aid_auths_oidc_token_post"},{"title":"Passwordless","description":"Passwordless connections do not require the user to\nremember a password. Instead, another mechanism is used\nto prove identity, such as a one-time code sent through\nemail or SMS, every time the account user logs in.\n\n- The client_id/audience must have a grant with type\n `authorization_code` to allow sending verification-code\n- This endpoint is designed to be called from the client-side\n and is subjected to rate limits\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/passwordless\n- write:accounts:/auth/passwordless-sms\n- write:accounts:/auth/passwordless-email\n","deprecated":null,"version":null,"sidebarTitle":"Passwordless","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/passwordless","href":"/core-api/authenticate/aid_auth_account_passwordless_post"},{"title":"Passwordless Code","description":"Passwordless connections do not require the user to\nremember a password. Instead, another mechanism is used\nto prove identity, such as a one-time code sent through\nemail or SMS, every time the account user logs in.\n\nUse this endpoint to generate a one-time verification-code that can\nbe sent to the user.\n\nThe client_id/audience must have a grant with type\n`authorization_code` to allow creating a verification-code\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/passwordless/code\n","deprecated":null,"version":null,"sidebarTitle":"Passwordless Code","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/passwordless/code","href":"/core-api/authenticate/aid_auth_passwordless_post"},{"title":"Redirect with ID token","description":"Use this endpoint to redirect to an URL with a\nID token added.\n","deprecated":null,"version":null,"sidebarTitle":"Redirect with ID token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/redirect","href":"/core-api/authenticate/aid_auths_oauth_redirect_post"},{"title":"Revoke Token","description":"Use this endpoint to invalidate a Refresh Token if it has been compromised.\n\nscopes:\n- admin:accounts\n- write:accounts\n- create:accounts:auth:refresh_token\n","deprecated":null,"version":null,"sidebarTitle":"Revoke Token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/revoke","href":"/core-api/authenticate/aid_auths_oauth_revoke_post"},{"title":"Get Token","description":"Use this endpoint to directly request an access_token\n\n### Client Access Token\nUse HTTP Basic authentication scheme for\nauthenticating grant_type `client_credentials`, use\nclient_id/client_secret as user/password.\n\n### Code/Password Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `authorization_code` or `password`, where the\nBearer value must be a JWT toke with access to the token\nendpoint.\n\n### Account User Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `account_user_token`, where the Bearer value\nmust be a account user JWT token.\n\n> Use ID token as Bearer toke if the user was authenticated\n> externally. The ID must include a `email` claim that\n> identifies the account user.\n\n### Refresh Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `refresh_token` where the Bearer value **must**\nbe an Access Token for the clients that was used to create\nthe Refresh Token.\n\n### Multi-factor authentication (MFA)\n\nWhen a request is made to the endpoint to get an access token,\nnormally you either get an error, or you get an access token.\nHowever, when the MFA is enabled, the endpoint may return a new\nerror with `error.code: mfa_required`.\n\nWhen an `mfa_required` error is returned, the client must perform\na `challenge`. This is done by sending a request to the\n[auth/mfa/challenge](/management-auth-api/challenge/aid_auth_mfa_challenge_post) endpoint\n\nTo verify MFA using an OOB challenge, the client must make a request to\nthis endpoint with `grant_type=mfa-oob`. Include the `oob_code` you\nreceived from the challenge response, as well as the `mfa_token` you\nreceived as part of mfa_required error.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n- write:accounts:/auth/users/no-mfa\n","deprecated":null,"version":null,"sidebarTitle":"Get Token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/token","href":"/core-api/authenticate/aid_auths_oauth_token_post"},{"title":"Exchange Token","description":"Use this endpoint to exchange access_token to a sub-account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Exchange Token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{partner_id}/auth/exchange_token","href":"/core-api/authenticate/aid_auths_oauth_exchange_token_post"}]},{"group":"grants","pages":[{"title":"Client grants collection","description":"Manage your Client Grants (also called Client Credentials Grants).\nUsing Client Grants, your Client can request an access token using\nits credentials (a Client ID and a Client Secret).\nThe access token then represents your Client during API calls.\n\nUse the Grant type to limit how the grant can be used when requesting\nan access token. A Grant with type `password` can only be used when\nrequesting an access token with grant_type set to `password`.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Client grants collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/client-grants","href":"/core-api/grants/aid_auths_client_grants_get"},{"title":"Create client grant","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create client grant","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/client-grants","href":"/core-api/grants/aid_auths_client_grants_post"},{"title":"Delete client grant","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete client grant","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{oid}/auth/client-grants/{id}","href":"/core-api/grants/aid_auths_client_grants_id_delete"},{"title":"Update client grant","description":"Update the client grant with the given id.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update client grant","openapi":"/mintlify-docs/openapi/spec-core.yaml patch /accounts/{oid}/auth/client-grants/{id}","href":"/core-api/grants/aid_auths_client_grants_id_patch"}]},{"group":"clients","pages":[{"title":"Clients collection","description":"Retrieve a list of all client applications\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Clients collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/clients","href":"/core-api/clients/aid_auth_clients_get"},{"title":"Create Client","description":"Creates a new client application.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create Client","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/clients","href":"/core-api/clients/aid_auth_clients_post"},{"title":"Get Client","description":"Retrieves a client by its id.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Client","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/clients/{id}","href":"/core-api/clients/aid_auths_clients_id_get"},{"title":"Delete Client","description":"Deletes a client and all its related assets\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete Client","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{oid}/auth/clients/{id}","href":"/core-api/clients/aid_auths_clients_id_delete"},{"title":"Update Client","description":"Update client details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Client","openapi":"/mintlify-docs/openapi/spec-core.yaml patch /accounts/{oid}/auth/clients/{id}","href":"/core-api/clients/aid_auths_clients_id_patch"},{"title":"Rotate a client secret.","description":"Rotate a client secret.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Rotate a client secret.","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/clients/{id}/rotate-secret","href":"/core-api/clients/aid_auths_clients_id_rotate_post"}]},{"group":"keys","pages":[{"title":"Get public keys","description":"Retrieve the JSON Web Key Set (JWKS) that can be used\nto validate `access_token`\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get public keys","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/keys","href":"/core-api/keys/aid_auths_keys_get"}]},{"group":"roles","pages":[{"title":"Roles collection","description":"Retrieve filtered list of roles that can be assigned to users.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Roles collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/roles","href":"/core-api/roles/aid_auths_roles_get"},{"title":"Create a role","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create a role","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/auth/roles","href":"/core-api/roles/aid_auths_roles_post"},{"title":"Get role","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get role","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/auth/roles/{role_id}","href":"/core-api/roles/aid_auths_roles_id_get"},{"title":"Update role","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update role","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{oid}/auth/roles/{role_id}","href":"/core-api/roles/aid_auths_roles_id_put"},{"title":"Delete role","description":"scopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete role","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{oid}/auth/roles/{role_id}","href":"/core-api/roles/aid_auths_roles_id_delete"}]},{"group":"accounts","pages":[{"title":"Accounts collection","description":"Get list of accounts filtered by the partner account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Accounts collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/management/accounts","href":"/core-api/accounts/aid_mgmnt_accounts_get"},{"title":"Create Account","description":"Create an account from an partner account\n\nscopes:\n- admin:accounts\n- write:accounts\n- public:accounts\n\nIn order to create an account with `livemode` correctly enabled, the following fields must be set in the body request:\n - `company.business_name`\n - `company.organization_number`\n - `company.address.address_line`\n - `company.address.postal_place`\n - `company.address.country`\n - `company.website`\n - `billing.business_name`\n - `billing.organization_number`\n - `billing.address.address_line`\n - `billing.address.postal_place`\n - `billing.address.country`\n\nThis allows the account to proceed with KYC in Backoffice.\n","deprecated":null,"version":null,"sidebarTitle":"Create Account","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/management/accounts","href":"/core-api/accounts/aid_mgmnt_accounts_post"},{"title":"Get Account","description":"Get account details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Account","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/management/accounts/{aid}","href":"/core-api/accounts/aid_accounts_aid_get"},{"title":"Update Account","description":"Update an account\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Account","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{oid}/management/accounts/{aid}","href":"/core-api/accounts/aid_accounts_aid_put"},{"title":"Delete Account","description":"Delete an account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete Account","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{oid}/management/accounts/{aid}","href":"/core-api/accounts/aid_mgmnt_accounts_aid_delete"},{"title":"Update connection status","description":"Update an account connection with new status and add an event\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update connection status","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/management/accounts/{aid}/connections/{connection}/events","href":"/core-api/accounts/aid_accounts_aid_connections_events_post"},{"title":"Account events","description":"Get list of account events\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Account events","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/management/accounts/{aid}/events","href":"/core-api/accounts/aid_mgmnt_accounts_events_get"},{"title":"Create Account Event","description":"Create an account event\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create Account Event","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/management/accounts/{aid}/events","href":"/core-api/accounts/aid_mgmnt_accounts_events_post"},{"title":"Partner onboarding link","description":"Partner onboarding link\n\nscopes:\n- admin:dintero\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Partner onboarding link","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/management/accounts/{aid}/partner_onboarding_link","href":"/core-api/accounts/aid_accounts_aid_partner_onboarding_link_post"}]},{"group":"account-fraud-search","pages":[{"title":"MATCH register search","description":"Search the MATCH register for any potential matches related to fraud for the account\n\nscopes:\n- read:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"MATCH register search","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/compliance-search/match","href":"/core-api/account-fraud-search/accounts_aid_search_match_post"},{"title":"Add a terminated merchant to MATCH","description":"Add a terminated merchant to Mastercard MATCH\n\nscopes:\n- write:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"Add a terminated merchant to MATCH","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/compliance-search/match/terminate","href":"/core-api/account-fraud-search/accounts_aid_search_match_terminate_merchant_post"},{"title":"Get MATCH register search","description":"Get result of a MATCH inquiry by the inquiry reference number (IRN)\n\nscopes:\n- read:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"Get MATCH register search","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/compliance-search/match/{irn}","href":"/core-api/account-fraud-search/accounts_aid_search_match_get"},{"title":"VMSS register search","description":"Search the Visa Merchant Screening Service register for any potential matches related to fraud for the account\n\nscopes:\n- read:accounts:/vmss\n","deprecated":null,"version":null,"sidebarTitle":"VMSS register search","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/compliance-search/vmss","href":"/core-api/account-fraud-search/accounts_aid_search_vmss_post"},{"title":"Add a terminated merchant to VMSS","description":"Add a terminated to Visa Merchant Screening Service\n\nscopes:\n- write:accounts:/vmss\n","deprecated":null,"version":null,"sidebarTitle":"Add a terminated merchant to VMSS","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/compliance-search/vmss/terminate","href":"/core-api/account-fraud-search/accounts_aid_search_vmss_terminate_merchant_post"}]},{"group":"account-onboarding","pages":[{"title":"Signup to Dintero Account","description":"Initiate a signup for Dintero Account\n\n- An email verification request will be sent to the applicant,\n that contains a code that must be sent to\n [POST /account/{oid}/signup/verify](/management-auth-api/account-onboarding/accounts_oid_signup_verify_post)\n\n- A welcome email will be sent after verification of the applicant email\n is completed. The email contains links to Backoffice\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Signup to Dintero Account","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/signup","href":"/core-api/account-onboarding/accounts_oid_signup_post"},{"title":"Verify signup","description":"Complete the signup for a Dintero Account by sending the verification code\nsent to the applicant\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Verify signup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/signup/verify","href":"/core-api/account-onboarding/accounts_oid_signup_verify_post"}]},{"group":"account-onboarding-prefill","pages":[{"title":"Pre-fill a sign up for a new Dintero Account","description":"Pre-fill a sign up form for a new Dintero Account\n\n- An email verification request will be sent to the applicant,\n that contains a link where the merchant can accept the terms and create a new account.\n\n [POST /account/{oid}/signup/prefill/{prefill_id}](/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_accept_post)\n\n- An email will be sent after accepting the terms. The email contains a link to the Backoffice as well as a password\n\nscopes:\n- create:applicant\n","deprecated":null,"version":null,"sidebarTitle":"Pre-fill a sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/signup/prefill","href":"/core-api/account-onboarding-prefill/accounts_oid_signup_prefill_post"},{"title":"Get pending pre-filled sign up for a new Dintero Account","description":"Get a prefilled a sign up form for a new Dintero Account by id, not yet\naccepted by the applicant.\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Get pending pre-filled sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{oid}/signup/prefill/{prefill_id}","href":"/core-api/account-onboarding-prefill/accounts_oid_signup_prefill_get"},{"title":"Accept pre-filled sign up for a new Dintero Account","description":"Accept a prefilled sign up form for a new Dintero Account\n\n- An email will be sent after accepting the terms if no auhtorize query is included.\n The email contains a link to the Backoffice as well as a password\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Accept pre-filled sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{oid}/signup/prefill/{prefill_id}","href":"/core-api/account-onboarding-prefill/accounts_oid_signup_prefill_accept_post"}]},{"group":"catalogs","pages":[{"title":"Catalogs collection","description":"Get catalogs from account based on query parameters\n\nscopes:\n - admin:products\n - write:products\n - read:products\n","deprecated":null,"version":null,"sidebarTitle":"Catalogs collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/products/catalogs","href":"/core-api/catalogs/aid_catalogs_get"},{"title":"Create new catalog","description":"Create a new product catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Create new catalog","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/products/catalogs","href":"/core-api/catalogs/aid_catalogs_post"},{"title":"Update catalog","description":"Update an existing catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Update catalog","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/products/catalogs/{catalog_id}","href":"/core-api/catalogs/aid_catalogs_put"},{"title":"Delete catalog","description":"Delete catalog and all corresponding products\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Delete catalog","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/products/catalogs/{catalog_id}","href":"/core-api/catalogs/aid_catalogs_delete"}]},{"group":"products","pages":[{"title":"Products collection","description":"Get products in a catalog based on query parameters\n\nscopes:\n - admin:products\n - write:products\n - read:products\n","deprecated":null,"version":null,"sidebarTitle":"Products collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/products/catalogs/{catalog_id}/products","href":"/core-api/products/aid_products_get"},{"title":"Create new product","description":"Create a new product\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Create new product","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/products/catalogs/{catalog_id}/products","href":"/core-api/products/aid_products_post"},{"title":"Update product","description":"Update an existing product\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Update product","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/products/catalogs/{catalog_id}/products/{product_id}","href":"/core-api/products/aid_products_put"},{"title":"Delete product","description":"Delete product in a given catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Delete product","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/products/catalogs/{catalog_id}/products/{product_id}","href":"/core-api/products/aid_catalog_id_product_delete"}]},{"group":"groups","pages":[{"title":"Group collection","description":"Lists all groups\n","deprecated":null,"version":null,"sidebarTitle":"Group collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/products/groups","href":"/core-api/groups/aid_group_get"},{"title":"Create new group","description":"Insert a new group\n","deprecated":null,"version":null,"sidebarTitle":"Create new group","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/products/groups","href":"/core-api/groups/aid_group_post"},{"title":"Update group","description":"Update an existing group\n","deprecated":null,"version":null,"sidebarTitle":"Update group","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/products/groups/{group_id}","href":"/core-api/groups/aid_group_put"},{"title":"Delete group","description":"Delete an existing group\n","deprecated":null,"version":null,"sidebarTitle":"Delete group","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/products/groups/{group_id}","href":"/core-api/groups/aid_delete"}]},{"group":"tax","pages":[{"title":"Taxgroup collection","description":"Lists all taxgroups\n","deprecated":null,"version":null,"sidebarTitle":"Taxgroup collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/products/tax","href":"/core-api/tax/aid_tax_get"},{"title":"Create new taxgroup","description":"Insert a new taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Create new taxgroup","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/products/tax","href":"/core-api/tax/aid_tax_post"},{"title":"Update taxgroup","description":"Update an existing taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Update taxgroup","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/products/tax/{tax_id}","href":"/core-api/tax/aid_tax_put"},{"title":"Delete taxgroup","description":"Delete an existing taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Delete taxgroup","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/products/tax/{tax_id}","href":"/core-api/tax/aid_tax_delete"}]},{"group":"receipts","pages":[{"title":"Create new Receipts","description":"Post receipts\n\nscopes:\n- admin:receipts\n- write:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Create new Receipts","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/receipts","href":"/core-api/receipts/aid_receipts_post"},{"title":"Update receipt","description":"Update existing anonymous receipt.\n\n### Limitation\n\n- update of customer_id is only allowed if the current customer_id\n is null.\n- update of discounts is only allowed if current discounts value is\n null or empty\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Update receipt","openapi":"/mintlify-docs/openapi/spec-core.yaml put /accounts/{aid}/receipts/all/{receipt_id}","href":"/core-api/receipts/aid_receipts_update_put"},{"title":"Get receipt by token","description":"Get receipt from token. The token must be a signed JWT token\ncontaining the `customer_id` and `receipt_id` to fetch.\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n- public:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Get receipt by token","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/receipts/receipt-token","href":"/core-api/receipts/aid_receipts_receipt_token_get"},{"title":"Claim receipt by token","description":"Update `customer_id` on receipt identified by token. The token will be\ninvalid after the claim.\n\nscopes:\n- admin:receipts\n- write:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Claim receipt by token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/receipts/receipt-token","href":"/core-api/receipts/aid_receipts_receipt_token_post"},{"title":"Receipt search","description":"Get receipts matching receipt_id (POS id)\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Receipt search","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/receipts/search","href":"/core-api/receipts/aid_receipts_rid_get"}]},{"group":"segment","pages":[{"title":"Customer segmentation","description":"Segment customer by receipt data\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer segmentation","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/receipts/customer_segment","href":"/core-api/segment/aid_receipts_customer_segment_post"}]},{"group":"customer receipts","pages":[{"title":"Customer Receipts collection","description":"Get the receipts for a customer\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer Receipts collection","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/receipts/customers/{customer_id}","href":"/core-api/customer-receipts/aid_receipts_customers_cid_get"},{"title":"Customer receipt details","description":"Get a customer receipt\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer receipt details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/receipts/customers/{customer_id}/{receipt_id}","href":"/core-api/customer-receipts/aid_receipts_customers_cid_rid_get"},{"title":"Change customer_id","description":"Update customer_id for an receipt, i.e. move the receipt\nto a new customer\n\n> **warning**: The receipt will no longer be accessible\n> by the previous customer_id\n\nFollowing extra_info field will be added to the receipt\nwhen customer_id is changed using key\n\n - `dintero.receipts.change_customer_id.{timestamp}.{hash}`\n\nThe content of the extra_info will be a JSON string containing:\n\n - created_at\n - created_by\n - old\n - new\n\nscopes:\n- admin:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Change customer_id","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/receipts/customers/{customer_id}/{receipt_id}/change_customer_id","href":"/core-api/customer-receipts/aid_receipts_customers_cid_rid_change_customer_id_post"}]},{"group":"cards","pages":[{"title":"Get cards","description":"Get all cards for an account\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Get cards","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/wallets/cards","href":"/core-api/cards/aid_cards_get"},{"title":"Create a card","description":"Create a new card\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Create a card","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/cards","href":"/core-api/cards/aid_cards_post"},{"title":"Retrieve card by card ID","description":"Get all details about a card\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Retrieve card by card ID","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/wallets/cards/{card_id}","href":"/core-api/cards/aid_cards_cardid_get"},{"title":"Create a token for the card","description":"Create a temporary `token` (also referred as Card Code)\nfor the card, an temporary alias that must be used when\nwhen creating a drawdown transaction\n\nThe token can be stored in a barcode to allow use of virtuell card\nin purchase in POS or webstore\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Create a token for the card","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/cards/{card_id}/tokens","href":"/core-api/cards/aid_cards_cardid_token_post"},{"title":"Retrieve card by Token","description":"Get details about a card, including the current balance and available\nfunds. No details will be returned for expired tokens\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/info\n","deprecated":null,"version":null,"sidebarTitle":"Retrieve card by Token","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/info","href":"/core-api/cards/aid_cards_token_post"}]},{"group":"transactions","pages":[{"title":"List card transactions","description":"Retrieve a list of Card's Transaction based on card id\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"List card transactions","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/wallets/cards/{card_id}/transactions","href":"/core-api/transactions/aid_cards_cardid_transactions_tid_get"},{"title":"Create transaction","description":"Create a transaction against a Card using `token` or `card_id`.\nIf the Transactions is created as pending, the value will\nbe locked until it is either captured or voided. Transaction ID must\nbe used when capturing or voiding a transaction.\n\n> Using **`card_id`** or creating a **`fund`** transaction requires\n> authorization scope `admin:wallets` or `write:wallets`\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/transactions","href":"/core-api/transactions/aid_cards_transactions_post"},{"title":"Capture pending transaction","description":"Capture a pending Transaction, thereby collection the amount\nwithheld by the pending transaction.\n\nOption to specify an amount that should be captured. \nDefaults to capture the full transaction.\nWhen the amount specified is less than the reserved/pending, \nthe remaining amount will still be reserved/pending and can be captured later.\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Capture pending transaction","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/transactions/{transaction_id}/capture","href":"/core-api/transactions/aid_cards_cardid_transactions_capture_post"},{"title":"Void pending transaction","description":"Void a pending Transaction by unlocking the amount\nwithheld by the pending transaction\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Void pending transaction","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/wallets/transactions/{transaction_id}/void","href":"/core-api/transactions/aid_cards_cardid_transactions_void_post"}]},{"group":"customers","pages":[{"title":"List customer cards","description":"Get the cards active for a customer\n\nscopes:\n- admin:wallets\n- read:wallets\n- user:wallets\n","deprecated":null,"version":null,"sidebarTitle":"List customer cards","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/wallets/customers/{customer_id}/cards","href":"/core-api/customers/aid_customers_cid_cards_get"},{"title":"Get customer card details","description":"Get all details about a customer card \n\nscopes:\n- admin:wallets\n- read:wallets\n- user:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Get customer card details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/wallets/customers/{customer_id}/cards/{card_id}","href":"/core-api/customers/aid_customers_cid_card_cid_get"}]},{"group":"subscriptions","pages":[{"title":"List subscriptions","description":"Get a list of all subscriptions\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/hooks/subscriptions","href":"/core-api/subscriptions/aid_source_hooks_get"},{"title":"Create subscription","description":"\nWhen you create a new webhook, we'll send you a simple ping event to\nlet you know you've set up the webhook correctly.\nYou can trigger a ping again by calling the\n[ping endpoint](/webhooks-api/subscription-deliveries/aid_source_hooks_hid_ping_post).\n\n## Receiving Webhooks\n\nIn order for Dintero to send webhook payloads, your server needs to be\naccessible from the Internet. We also highly suggest using SSL\nso that we can send encrypted payloads over HTTPS.\n\n## Respond to a webhook\n\nYour webhook acknowledges that it received data by sending a 200 OK\nresponse. Any response outside of the 200 range will let Dintero\nknow that you did not receive your webhook, including 301 Redirect.\nDintero does not follow redirects for webhook notifications and will\nconsider a redirection as an error response.\n\nDintero has implemented a 60-second timeout period and a retry\nperiod for subscriptions. We wait 120 seconds for a response to\neach request, and if there isn't one or we get an error, we retry\nthe connection to a total of 5 times.\nA webhook will be deleted if there are consecutive failures for the\nexact same webhook. You should monitor the admin of your webhook\ntool for failing webhooks.\n\n### Webhooks Headers\n\nDintero will send along several HTTP headers to differentiate between\nevent types and payload identifiers.\n\n| Name | Description |\n|----------------|------------------------------------------------------|\n| event | The event type |\n| event-delivery | A guid to indentify the payload and event being sent |\n| event-signature| The value of this header is computed as the HMAC SHA1 hex digest of the body, using the secret config option as the key. |\n\nscopes:\n- admin:hooks\n- write:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/hooks/subscriptions","href":"/core-api/subscriptions/aid_source_hooks_post"},{"title":"Get subscription details","description":"Get subscription details\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Get subscription details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/hooks/subscriptions/{hid}","href":"/core-api/subscriptions/aid_source_hooks_hid_get"},{"title":"Delete Subscription","description":"Delete a webhook subscription\n\nNo more events will be sent to the webhook\n\nscopes:\n- admin:hooks\n- write:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Delete Subscription","openapi":"/mintlify-docs/openapi/spec-core.yaml delete /accounts/{aid}/hooks/subscriptions/{hid}","href":"/core-api/subscriptions/aid_source_hooks_hid_delete"}]},{"group":"subscription deliveries","pages":[{"title":"List subscription deliveries","description":"Get recent subscription deliveries\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"List subscription deliveries","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/hooks/subscriptions/{hid}/deliveries","href":"/core-api/subscription-deliveries/aid_source_hooks_hid_deliveries_get"},{"title":"Get delivery details","description":"Get subscription delivery details\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Get delivery details","openapi":"/mintlify-docs/openapi/spec-core.yaml get /accounts/{aid}/hooks/subscriptions/{hid}/deliveries/{delivery_id}","href":"/core-api/subscription-deliveries/aid_source_hooks_hid_deliveries_did_get"},{"title":"Subscription ping","description":"This will trigger a ping event to be sent to the subscription URL.\n\n### Ping Event Payload\n\n```http\nPOST /\nUser-Agent: Dintero-Hook/0c9ad03b\nContent-Type: application/json\nevent: ping\nevent-delivery: cfedde7e-b088-415e-ad5b-cbe54acbb6f9\n\n{\n \"created_at\": \"2017-12-06T15:36:43Z\",\n \"created_by\": \"1c92f7e1-2897-4d46-bdcc-c127a914fb4e\",\n \"id\": \"string\",\n \"updated_at\": \"2017-12-06T15:36:43Z\",\n \"active\": true,\n \"config\": {\n \"content_type\": \"application/json\",\n \"insecure_ssl\": 0,\n \"secret\": { ... }\n \"url\": \"string\"\n },\n \"events\": [\"receipt_add\"]\n}\n```\n","deprecated":null,"version":null,"sidebarTitle":"Subscription ping","openapi":"/mintlify-docs/openapi/spec-core.yaml post /accounts/{aid}/hooks/subscriptions/{hid}/ping","href":"/core-api/subscription-deliveries/aid_source_hooks_hid_ping_post"}]},{"group":"example-management-auth-events","pages":[{"title":"approval_payout_destination_update","description":"Event is pushed to subscribers when the `case_status`\nof a seller approval changes\n","deprecated":null,"version":null,"sidebarTitle":"approval_payout_destination_update","openapi":"/mintlify-docs/openapi/spec-core.yaml post /examples/approval_payout_destination_update","href":"/core-api/example-management-auth-events/example_approval_payout_destination_update_event"}]},{"group":"example-checkout-events","pages":[{"title":"checkout_transaction","description":"Event is pushed to subscribers when the checkout transaction is created or\nupdated\n","deprecated":null,"version":null,"sidebarTitle":"checkout_transaction","openapi":"/mintlify-docs/openapi/spec-core.yaml post /examples/checkout_transaction","href":"/core-api/example-checkout-events/example_checkout_transaction_event"}]},{"group":"log events","pages":[{"title":"Add log event","description":"Endpoint intended for Dintero frontend to report any\nerror raised during operation\n","deprecated":null,"version":null,"sidebarTitle":"Add log event","openapi":"/mintlify-docs/openapi/spec-core.yaml post /logs/events","href":"/core-api/log-events/internal_logs_events_post"}]}]}]},{"dropdown":"Customers","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/users.svg","groups":[{"group":"Customers API","pages":[{"group":"password","pages":[{"title":"Change password","description":"Specify the email address of the user whose password you\nwould like to reset. If the call is successful, the user\nwill receive an email prompting them to change their password.\nThe caller must have scope `write:accounts:/auth/users` to perform a\nchange password request.\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Change password","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/change_password","href":"/customers-api/password/aid_customers_change_password"},{"title":"Login with email/password","description":"Login a customer user, the caller must have scope\n`write:accounts:/auth/users`.\nIf MFA is enabled on account, use\n`write:accounts:/auth/users/no-mfa` to skip MFA.\nscopes:\n- write:accounts:/auth/users\n- write:accounts:/auth/users/no-mfa\n","deprecated":null,"version":null,"sidebarTitle":"Login with email/password","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/login","href":"/customers-api/password/aid_customers_login_post"},{"title":"Login with MFA","description":"Initiate a Multi-Factor Authentication for a customer user, the caller must\nhave scope `write:accounts:/auth/users` to perform a login.\nPost the `ident_type`, along with the `ident` and `secret`.\nThe server will return a challenge response specifying the\n`challenge_type` that will have to be completed to when getting an access\ntoken from the `POST /v1/accounts/{oid}/auth/token` endpoint.\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Login with MFA","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/mfa_login","href":"/customers-api/password/aid_customers_mfa_login_post"},{"title":"MFA recovery","description":"Initiate a Multi-Factor Authentication recovery login for a customer user\nthat has forgotten/lost their `secret`.\nSpecify the ident_type and the ident (email or phone_number) of the user. If\nthe call is successful, the user will get an email with an one time recovery\ncode that has to be submitted to the mfa_recovery endpoint.\nWhen a valid one time recovery has been posted the server response with a\nregular MFA challenge.\nOnce authenticated the password or pin can be changed by updating the\ncustomer.\nscopes:\n - write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"MFA recovery","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/mfa_login_recovery","href":"/customers-api/password/aid_customers_mfa_login_initiate_recovery_post"}]},{"group":"settings","pages":[{"title":"Customers settings","description":"Get customers settings\n\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customers settings","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/settings","href":"/customers-api/settings/aid_customers_atributes_get"},{"title":"Update settings","description":"Update customers settings\n\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update settings","openapi":"/mintlify-docs/openapi/spec-customers.yaml put /accounts/{aid}/customers/settings","href":"/customers-api/settings/aid_customers_atributes_put"}]},{"group":"tags","pages":[{"title":"Tags collection","description":"Get all customer tags (also known as groups).\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Tags collection","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/tags","href":"/customers-api/tags/aid_customers_tags_get"},{"title":"Create new Tag","description":"Create a tag\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Tag","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/tags","href":"/customers-api/tags/aid_customers_tags_post"},{"title":"Delete Tag","description":"Delete a tag.\nA deleted tag is removed from customer tags\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete Tag","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/customers/tags/{tag_id}","href":"/customers-api/tags/aid_customers_tags_tid_delete"},{"title":"Tag collection","description":"Get tags for a customer\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Tag collection","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/users/{customer_id}/tags","href":"/customers-api/tags/aid_customers_cid_tags_get"},{"title":"Update Customer Tags","description":"Update Customer Tags\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update Customer Tags","openapi":"/mintlify-docs/openapi/spec-customers.yaml put /accounts/{aid}/customers/users/{customer_id}/tags","href":"/customers-api/tags/aid_customers_cid_tags_put"}]},{"group":"terms","pages":[{"title":"Terms collection","description":"Get all customer terms and conditions\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Terms collection","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/terms","href":"/customers-api/terms/aid_customers_terms_get"},{"title":"Create new Terms","description":"Create customer terms and conditions\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Terms","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/terms","href":"/customers-api/terms/aid_customers_terms_post"},{"title":"Terms details","description":"Get single terms and conditions\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Terms details","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/terms/{tid}","href":"/customers-api/terms/aid_customers_terms_tid_post"},{"title":"Delete Term","description":"Delete the customer term\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete Term","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/customers/terms/{tid}","href":"/customers-api/terms/aid_customers_terms_tid_delete"}]},{"group":"tokens","pages":[{"title":"Get token events","description":"Get the token events\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Get token events","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/tokens/events","href":"/customers-api/tokens/aid_customers_tokens_events_get"},{"title":"Find / Add token events","description":"Find details about a token, inclusive details about\nany customer the token belongs to and any token events recorded\nInclude event in the request to update the status of the token\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Find / Add token events","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/tokens/events","href":"/customers-api/tokens/aid_customers_tokens_events_post"},{"title":"Delete token events","description":"Delete the connection between token (type/value) and\nlist of events.\nInclude an event in the request to store the reason\nfor the request\nscopes:\n- admin:customers\n- write:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete token events","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/customers/tokens/events","href":"/customers-api/tokens/aid_customers_tokens_events_delete"},{"title":"Token collections","description":"Get all tokens for a Customer\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Token collections","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/users/{customer_id}/tokens","href":"/customers-api/tokens/aid_customers_cid_tokens_get"},{"title":"Create new Token","description":"Create a new customer token\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Create new Token","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/users/{customer_id}/tokens","href":"/customers-api/tokens/aid_customers_cid_tokens_post"},{"title":"Delete customer token","description":"Delete Token\n\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer token","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/customers/users/{customer_id}/tokens/{tid}","href":"/customers-api/tokens/aid_customers_cid_tokens_tid_delete"}]},{"group":"users","pages":[{"title":"Customer collection","description":"Get all customers, limited by parameters. The result will\nmatch all parameters with `AND`.\nSearch is done by prefix match, and `+` in phone_number/email\nmust be URL encoded, (+4799999999 => %2B4799999999)\n\nUsers with type `contact` are by default excluded from the result,\nuse `type=contact` or `type=any` to include contact users\n\nThe response from a request that match contact users will include the\nusers that are linked from the contact\n\nscopes:\n- admin:customers\n- read:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customer collection","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/users","href":"/customers-api/users/aid_customers_get"},{"title":"Create new Customer","description":"Create a new customer, `customer_id`, `email` and `phone_number` must\nbe unique if specified.\nscopes:\n- admin:customers\n- write:customers\n- create:customers:/users\n","deprecated":null,"version":null,"sidebarTitle":"Create new Customer","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/users","href":"/customers-api/users/aid_customers_post"},{"title":"User exist","description":"Check if there is users that match the parameters. The result will\nmatch all parameters with `AND`.\nThis endpoint must be enabled from [PUT /customers/settings](/customers-api/settings/aid_customers_atributes_put)\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"User exist","openapi":"/mintlify-docs/openapi/spec-customers.yaml head /accounts/{aid}/customers/users","href":"/customers-api/users/aid_customers_head"},{"title":"Customer details","description":"Customer details\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n- user:customers:/customer/details\n","deprecated":null,"version":null,"sidebarTitle":"Customer details","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/users/{customer_id}","href":"/customers-api/users/aid_customers_cid_get"},{"title":"Update Customer","description":"Update customer properties, properties not included in the body\nwill remain unchanged.\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Update Customer","openapi":"/mintlify-docs/openapi/spec-customers.yaml put /accounts/{aid}/customers/users/{customer_id}","href":"/customers-api/users/aid_customers_cid_put"},{"title":"Delete customer","description":"Delete single customer\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/customers/users/{customer_id}","href":"/customers-api/users/aid_customers_cid_delete"},{"title":"Change customer_id","description":"Update customer_id for an customer\n**warning**: Any external resources \"owned\" by the user, i.e\nreceipts, discounts etc. will not be updated with the new\ncustomer_id.\nA new metadata property `dintero_change_customer_id_{timestamp}.{hash}`\nwill be added everytime the customer_id is changed\nFollowing data will be included in the metadata property\n - created_at\n - created_by\n - old\n - new\nscopes:\n- admin:customers\n- admin:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Change customer_id","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/users/{customer_id}/change_customer_id","href":"/customers-api/users/aid_customers_cid_change_customer_id_post"}]},{"group":"communication","pages":[{"title":"Customer email/phone_number Status","description":"Get the status of customer email / phone_number communication\nscopes:\n- admin:customers\n- read:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Customer email/phone_number Status","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/users/{customer_id}/communication","href":"/customers-api/communication/aid_customers_cid_verify_get"},{"title":"Verify Customer email/phone_number","description":"Verify customer email/phone_number field. Consist of\nto steps:\n - send verification code to the customer (sms or email)\n - verify the email/phone_number by posting verification code sent to customer\nscopes:\n- admin:customers\n- write:customers\n- user:customers\n","deprecated":null,"version":null,"sidebarTitle":"Verify Customer email/phone_number","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/customers/users/{customer_id}/communication/{operation}/{field}","href":"/customers-api/communication/aid_customers_cid_verify_post"}]},{"group":"locations","pages":[{"title":"Locations collection","description":"Get all sales locations, the starting_after have to be set to location_id\nscopes:\n- admin:locations\n- read:locations\n","deprecated":null,"version":null,"sidebarTitle":"Locations collection","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/locations","href":"/customers-api/locations/aid_locations_get"},{"title":"Create new sales location","description":"Create a sales location\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Create new sales location","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/locations","href":"/customers-api/locations/aid_location_post"},{"title":"Location details","description":"Get single sales location\nscopes:\n- admin:locations\n- read:locations\n","deprecated":null,"version":null,"sidebarTitle":"Location details","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/locations/{lid}","href":"/customers-api/locations/aid_locations_lid_get"},{"title":"Update Sales location","description":"Update location properties\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Update Sales location","openapi":"/mintlify-docs/openapi/spec-customers.yaml put /accounts/{aid}/locations/{lid}","href":"/customers-api/locations/aid_location_lid_put"},{"title":"Delete location","description":"Delete single location\nscopes:\n- admin:locations\n- write:locations\n","deprecated":null,"version":null,"sidebarTitle":"Delete location","openapi":"/mintlify-docs/openapi/spec-customers.yaml delete /accounts/{aid}/locations/{lid}","href":"/customers-api/locations/aid_location_lid_delete"}]},{"group":"organizations","pages":[{"title":"Get addresses for organization number from external organization registry","description":"scopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Get addresses for organization number from external organization registry","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/search/external/organizations/{country}/{organization_number}","href":"/customers-api/organizations/aid_get_external_organizations"},{"title":"Get organization subunits","description":"scopes:\n- public\n\nGet an organization's registered subunits. Proxies queries to respective registers.\nCurrently only Norway (`no`) organization numbers are supported.\n","deprecated":null,"version":null,"sidebarTitle":"Get organization subunits","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/search/external/organizations/{country}/{organization_number}/subunits","href":"/customers-api/organizations/aid_get_external_organization_subunits"},{"title":"Search external organization registry","description":"Proxy queries to the Norwegian or Danish organization registry.\n\nPlease note that the only supported countries currently are \"no\" (Norway)\nand \"dk\" (Denmark).\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Search external organization registry","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/search/external/organizations/{country}","href":"/customers-api/organizations/aid_search_external_organizations_country"}]},{"group":"addresses","pages":[{"title":"Search external postal place","description":"Get postal place by country and postal code.\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Search external postal place","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/search/external/postal_place/{country}/{postal_code}","href":"/customers-api/addresses/aid_search_external_postal_place"},{"title":"Validate address","description":"Validate the given address and return close matching alternative\nsuggestions if the provided address was most likely wrong.\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Validate address","openapi":"/mintlify-docs/openapi/spec-customers.yaml post /accounts/{aid}/search/external/address/{country}/validate","href":"/customers-api/addresses/aid_search_external_validate_address"}]},{"group":"company","pages":[{"title":"Get departments","description":"List all departments register by company customers\n\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Get departments","openapi":"/mintlify-docs/openapi/spec-customers.yaml get /accounts/{aid}/customers/company/departments","href":"/customers-api/company/aid_company_departments_get"}]}]}]},{"dropdown":"Discounts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/tag.svg","groups":[{"group":"Discounts API","pages":[{"group":"rules automations","pages":[{"title":"Automation collection","description":"Get available automations for the account\n\nscopes:\n- admin:automations\n- read:automations\n","deprecated":null,"version":null,"sidebarTitle":"Automation collection","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/automations/rules","href":"/discounts-api/rules-automations/aid_automations_rules_get"},{"title":"Create new automation","description":"Create a discount automation to apply on events received.\n\n\nA automation can be used to automate the task of\ngiving discount to customers. The customer found in\nthe event will receive the discount.\n\n###\nWelcome discount: give discount to new user\n\n {\n \"requirement\": {\n \"events\": [\"customer_add\"],\n \"automation_from\": \"2018-05-07T08:54:31Z\",\n \"automation_to\": \"2018-06-07T08:54:31Z\"\n },\n \"actions\": [\n {\n \"type\": \"discount\",\n \"id\": \"cae3e485-0e15-4afa-bc66-472f843efb84\"\n }\n ]\n }\n\n###\nPurchase discount: give discount on first purchase at store\n\n {\n \"name\": \"purchase at store sc029\",\n \"requirement\": {\n \"events\": [\"receipt_add\"],\n \"automation_from\": \"2018-05-07T08:54:31Z\",\n \"automation_to\": \"2018-06-07T08:54:31Z\",\n \"filters\": {\n \"$.store.id\": [\"sc029\"]\n }\n },\n \"actions\": [\n {\n \"type\": \"discount\",\n \"id\": \"cae3e485-0e15-4afa-bc66-472f843efb84\"\n }\n ],\n \"limitation\": {\n \"automation_repeat\": 1\n }\n }\n\nscopes:\n- admin:automations\n- write:automations\n","deprecated":null,"version":null,"sidebarTitle":"Create new automation","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/automations/rules","href":"/discounts-api/rules-automations/aid_automations_rules_post"},{"title":"Automation details","description":"Get details about an automations\n\nscopes:\n- admin:automations\n- read:automations\n","deprecated":null,"version":null,"sidebarTitle":"Automation details","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/automations/rules/{arid}","href":"/discounts-api/rules-automations/aid_automations_rules_rid_get"},{"title":"Delete automation","description":"Delete an automation rule.\n\nscopes:\n- admin:automations\n- write:automations\n","deprecated":null,"version":null,"sidebarTitle":"Delete automation","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/automations/rules/{arid}","href":"/discounts-api/rules-automations/aid_automations_rules_rid_delete"}]},{"group":"use discounts","pages":[{"title":"Post receipt for discount","description":"Find discounts available for the receipt\n\n### Active discounts\n\n- `customer_id` will be used to find active discounts for the purchase.\n- `customer.token` will be used to resolve `customer_id` if no `customer_id` is provided.\n- No discounts will be given if the token does not resolve to any customer_id.\n- A receipt with no `customer_id` and no `customer.token` will only be applicable for\n active discounts given to **`/`**\n ([see](/discounts-api/rules-customers/aid_discounts_did_customers_post))\n\n### Requirement of the receipt\n\n - all items must have `eligible_for_discount` set to enable for discount\n - all items must have a positive `gross_amount` to qualify for discount\n - a `net` base discount reward requires the receipt to include existing\n discounts as discount_lines (on item) in order to calculate net\n\nA receipt that qualified for discount will have the `is_change`\nproperty set to true. Any items that has received a discount will be\nflagged by `is_change` and have one or more new entries to its\ndiscount_lines.\n\nThe receipt `discounts` list will be populated with all discounts the\nreceipt is qualified to receive\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Post receipt for discount","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/available_for_receipt","href":"/discounts-api/use-discounts/aid_discounts_available_for_receipt_post"},{"title":"Claim collections","description":"Get all claims, limited by parameters. The result will\nmatch all parameters with `AND`\n\nscopes:\n- admin:discounts\n- read:discounts\n- read:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Claim collections","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/available_for_receipt/claims","href":"/discounts-api/use-discounts/aid_discounts_available_for_receipt_get_claims"},{"title":"Claim discounts","description":"Claim discount rewards, checks will be done to ensure that all\ndiscount limitation are uphold\n\nNote, only the following discount limitation will affect\nthe success of a claim\n\n - discount_reward_usage\n - discount_repeat_usage\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Claim discounts","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/available_for_receipt/claims","href":"/discounts-api/use-discounts/aid_discounts_available_for_receipt_post_claim"},{"title":"Get claim","description":"Get details about a claim\n\nscopes:\n- admin:discounts\n- read:discounts\n- read:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/available_for_receipt/claims/{claim_id}","href":"/discounts-api/use-discounts/aid_discounts_available_for_receipt_get_claim"},{"title":"Delete claim","description":"Release claim on discounts, revert previously claimed discount\nand make them available for future purchase\n\nscopes:\n- admin:discounts\n- write:discounts\n- write:discounts:/available_for_receipt\n","deprecated":null,"version":null,"sidebarTitle":"Delete claim","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/discounts/available_for_receipt/claims/{claim_id}","href":"/discounts-api/use-discounts/aid_discounts_available_for_receipt_delete_claim"},{"title":"Post event","description":"Send an Event to the service.\n\n- rules automations will receive the event and give\n its discount to the customer found in the event\n\n\n- Token received will be stored to support resolving\n customer from token when handling discounts available\n for receipt\n\n scopes:\n - admin:discounts\n - write:discounts\n - write:discounts:/events\n","deprecated":null,"version":null,"sidebarTitle":"Post event","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/events","href":"/discounts-api/use-discounts/aid_discounts_events_post"}]},{"group":"campaigns","pages":[{"title":"Campaigns collection","description":"List campaigns\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Campaigns collection","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/campaigns","href":"/discounts-api/campaigns/aid_discounts_campaigns_get"},{"title":"Create new campaign","description":"Create a new campaign to group discount rules\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Create new campaign","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/campaigns","href":"/discounts-api/campaigns/aid_discounts_campaigns_post"},{"title":"Campaign details","description":"Get more details about a campaign\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Campaign details","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/discounts-api/campaigns/aid_discounts_campaigns_campaign_id_get"},{"title":"Update Campaign","description":"Update campaign details. Undeletes a deleted campaign.\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Campaign","openapi":"/mintlify-docs/openapi/spec-discounts.yaml put /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/discounts-api/campaigns/aid_discounts_campaigns_campaign_id_put"},{"title":"Delete campagn","description":"Delete a campagn.\n\nDeleting a campagn does not affect its discount rules. i.e. active\ncampagn rules will continue to be active after deleting the campagn\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete campagn","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/discounts/campaigns/{campaign_id}","href":"/discounts-api/campaigns/aid_discounts_campaigns_campaign_id_delete"}]},{"group":"rules customers","pages":[{"title":"Get customer discount ref","description":"Get a customer discount ref.\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get customer discount ref","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/discounts-api/rules-customers/aid_discounts_customer_cid_get_ref_id"},{"title":"Update customer discount ref","description":"Add stamps and usage to a discount ref.\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update customer discount ref","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/discounts-api/rules-customers/aid_discounts_customer_cid_post_ref_id"},{"title":"Delete customer discount ref","description":"Delete a customer discount ref. The discount will no longer\nbe available on purchase ([Post receipt for discount](/discounts-api/use-discounts/aid_discounts_available_for_receipt_post))\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete customer discount ref","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/discounts/customers/{customer_id}/refs/{ref_id}","href":"/discounts-api/rules-customers/aid_discounts_customer_cid_delete_ref_id"},{"title":"Customer discounts collection","description":"Get all discounts available for a customer, result will exclude\nexpired and inactive discounts\n\n\nExpired discounts are:\n\n - discount used up (customer has allready used it) and there\n was a limitation on the discount that prevents more use.\n - discount requirement purchase periode is in the past\n - discount that has been deleted\n\nInactive discounts are:\n\n - discount with `active` property set to false.\n\nUse value of `ref_id` as parameter value of `starting_after`\n\nscopes:\n- admin:discounts\n- read:discounts\n- user:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Customer discounts collection","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/customers/{customer_id}/rules","href":"/discounts-api/rules-customers/aid_discounts_customer_cid_get"},{"title":"Get discount customers (refs)","description":"Get list of customers refs for a discount. A ref is an instant\nof discount given to a customer or `all customers`. See\n[Add customers](/discounts-api/rules-customers/aid_discounts_did_customers_post)\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get discount customers (refs)","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/rules/{did}/customers","href":"/discounts-api/rules-customers/aid_discounts_did_customers_get"},{"title":"Add customers","description":"Give the Discount to one or more customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Add customers","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/rules/{did}/customers","href":"/discounts-api/rules-customers/aid_discounts_did_customers_post"},{"title":"Remove customers","description":"Remove Discount from one or more customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Remove customers","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/discounts/rules/{did}/customers","href":"/discounts-api/rules-customers/aid_discounts_did_customers_delete"},{"title":"Get discount ref usages","description":"Get list of discount refs usages.\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Get discount ref usages","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/rules/{did}/usages","href":"/discounts-api/rules-customers/aid_discounts_did_usages_get"}]},{"group":"rules","pages":[{"title":"Public Discount collection","description":"Get all discounts available for any customer given\ncurrent date, result will exclude expired and inactive\ndiscounts\n\nUse value of `ref_id` as parameter value of `starting_after`\n\nscopes:\n- admin:discounts\n- read:discounts\n- public:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Public Discount collection","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/public/rules","href":"/discounts-api/rules/aid_discounts_public_get"},{"title":"Discount collection","description":"List discounts available for the account\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Discount collection","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/rules","href":"/discounts-api/rules/aid_discounts_get"},{"title":"Create new discount","description":"Create a new discount for an account.\n\nA new discount will be **unavailable** for purchases\nuntil the discount is given to one or more customer.\n\nDiscount can be given to a customer by either adding\na automation to the discount that will grant the\ndiscount to the customer from events received or by\nadding customers to the discount.\n\nSee [Discount Examples](#section/Discount-Examples)\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Create new discount","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/rules","href":"/discounts-api/rules/aid_discounts_post"},{"title":"Discount details","description":"Get more details about a discount, includes statistics\nabout the discount\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Discount details","openapi":"/mintlify-docs/openapi/spec-discounts.yaml get /accounts/{aid}/discounts/rules/{did}","href":"/discounts-api/rules/aid_discounts_did_get"},{"title":"Update Discount","description":"Update discount details.\n\n\n**Caution**: Update of non-meta properties, properties that\nchanges requirement or limitation can create conflict with\nthe usage history of the discount.\n\nExample is to change requirement.item.items, such change would\nmean that purchases before the change would not be correctly\nrewarded given the new version of the discount.\n\nWe recommend to limit the update of a discount to meta only\nproperties if the discount has previously been used in a\npurchase.\n\nUpdate on requirement `purchase_to` is only supported when\nthe new value that is after current value.\n\n`purchase_from` can not be updated. Changing `purchase_to` or\n`limitation.dynamic_purchase_to_days` also updates the customer\ndiscounts already given, and is only supported with `mode=merge`.\n\n`reward` can be updated. The replace rules are described in the\n`reward` property of the request body.\n\n`requirement` and `limitation` keys are merged with the current\nvalues. Use `mode=replace` to replace the rule, for example to\nremove a key.\n\nThe discount `type` (receipt/item) is derived from the updated\n`requirement.item`.\n\nThe reward of a `discount_debit` discount can not be changed, and a\nreward can not be changed to `discount_debit`. Only `reward.base`\ncan be updated.\n\nUpdate `discount.active` to toggle if an discount is active\nand available for purchase.\n\nUpdate `discount.private` to toggle if an discount is included\nin public discount collection if given to all customers\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Discount","openapi":"/mintlify-docs/openapi/spec-discounts.yaml put /accounts/{aid}/discounts/rules/{did}","href":"/discounts-api/rules/aid_discounts_did_put"},{"title":"Delete discount","description":"Delete a discount\n\n- Customer that has previously received the discount will not\n be able to use it on purchases.\n- rules automations belonging to the discount will be deleted\n\nscopes:\n- admin:discounts\n- write:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete discount","openapi":"/mintlify-docs/openapi/spec-discounts.yaml delete /accounts/{aid}/discounts/rules/{did}","href":"/discounts-api/rules/aid_discounts_did_delete"},{"title":"Search for discount rules","description":"\nSearch for active discounts given current date matching queries\n\nscopes:\n- admin:discounts\n- read:discounts\n","deprecated":null,"version":null,"sidebarTitle":"Search for discount rules","openapi":"/mintlify-docs/openapi/spec-discounts.yaml post /accounts/{aid}/discounts/search/rules","href":"/discounts-api/rules/aid_discounts_rules_search_post"}]}]}]},{"dropdown":"Extension","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/puzzle.svg","groups":[{"group":"Extension API","pages":[{"group":"silenttouch","pages":[{"title":"Legacy - Create new receipt","description":"create a new Dintero Receipt from SilentTouch receipt\n\nRequires existing\n[SalesLocation](https://docs.dintero.com/api.html#tag/locations)\ntobe define upfront before receiving SilentTouch receipt\n","deprecated":null,"version":null,"sidebarTitle":"Legacy - Create new receipt","openapi":"/mintlify-docs/openapi/spec-extension.yaml post /PosService/InsertReceipts","href":"/extension-api/silenttouch/aid_silenttouch_receipt_legacy_post"},{"title":"Create new receipt","description":"create a new Dintero Receipt from SilentTouch receipt\n\nRequires existing\n[SalesLocation](https://docs.dintero.com/api.html#tag/locations)\ntobe define upfront before receiving SilentTouch receipt\n","deprecated":null,"version":null,"sidebarTitle":"Create new receipt","openapi":"/mintlify-docs/openapi/spec-extension.yaml post /accounts/{aid}/silenttouch/receipt","href":"/extension-api/silenttouch/aid_silenttouch_receipt_post"}]},{"group":"company","pages":[{"title":"Get departments","description":"List all departments register by company customers\n\nscopes:\n- admin:customers\n- read:customers\n- public:customers\n","deprecated":null,"version":null,"sidebarTitle":"Get departments","openapi":"/mintlify-docs/openapi/spec-extension.yaml get /accounts/{aid}/customers/company/departments","href":"/extension-api/company/aid_company_departments_get"}]},{"group":"offline","pages":[{"title":"process receipt","description":"Process offline Dintero Receipt.\n\nOutage or service down during a purchase may result in\na receipt with incomplete data.\n\n - missing `customer_id`\n - did not receive discounts\n - was not sent to the receipts service\n\n## Use this endpoint to:\n\n**insert receipt** where `customer.token` will be resolved to `customer_id`\nif found.\n\n - The `token.value` will be excluded from the receipt created.\n\n**update receipt** with `customer_id` or resolve it from `customer.token`.\n - Update only allowed if the receipt has not customer_id\n - The receipt must have an `id`.\n\n**create debit discount** from the discounts that is applicable\nfor the receipt.\n\n - Only possible if the receipt has not yet received any discounts\n (receipt.discounts empty)\n - All discount used in the debit discount will be claimed\n - A claim can be reverted to release the discounts\n\n*NOTE:* All receipt properties other than `customer_id/customer.token` is\nread-only, and can't be updated with this endpoint.\n\nYou can subscribe to `receipt_update` to receive notification on\nthe update done to the receipt.\n\n`receipt_add` event will be published when sending a new receipt to\nthis endpoint.\n\n## Extra info\n\nA receipt sent to this endpoint will be extended with `extra_info` with info about\nthe offline processing of the receipt.\n\n - `dintero.offline.receipt.created_at`: datetime, when sent to this endpoint\n - `dintero.offline.receipt.claim_id`: string, set if discounts was claimed\n - `dintero.offline.receipt.discount_debit_template_id`: string, set if debit template was used\n - `dintero.offline.receipt.discount_debit_id`: string, set if debit discount was created\n - `dintero.offline.receipt.customer_updated`: boolean, set if customer_id was updated\n","deprecated":null,"version":null,"sidebarTitle":"process receipt","openapi":"/mintlify-docs/openapi/spec-extension.yaml post /accounts/{aid}/offline/receipt","href":"/extension-api/offline/aid_offline_receipt_post"}]},{"group":"organizations","pages":[{"title":"Search external organization registry","description":"Proxy queries to the Norwegian or Danish organization registry.\n\nPlease note that the only supported countries currently are \"no\" (Norway)\nand \"dk\" (Denmark).\n\nscopes:\n- public\n","deprecated":null,"version":null,"sidebarTitle":"Search external organization registry","openapi":"/mintlify-docs/openapi/spec-extension.yaml get /accounts/{aid}/search/external/organizations/{country}","href":"/extension-api/organizations/aid_search_external_organizations_country"}]},{"group":"events","pages":[{"title":"Send customer events","description":"Endpoint for receiving customer events (webhooks) and\ntransform the customer event to CSV and send it\nvia SFTP.\n","deprecated":null,"version":null,"sidebarTitle":"Send customer events","openapi":"/mintlify-docs/openapi/spec-extension.yaml post /{instance}/sftp/customer","href":"/extension-api/events/post_sftp_customer"}]}]}]},{"dropdown":"Fraud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/shield-check.svg","groups":[{"group":"Fraud API","pages":[{"group":"alarms","pages":[{"title":"Collection of current alarms","description":"Lists arlams in fraud service.\n\n**scopes**:\n- admin:fraud:/admin\n- read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Collection of current alarms","openapi":"/mintlify-docs/openapi/spec-fraud.yaml get /accounts/{aid}/fraud/alarms","href":"/fraud-api/alarms/api_fraud_alarms_get"}]},{"group":"psp-block-rules","pages":[{"title":"Collection of PSP block rules","description":"Lists block rules for blocking payments based on certain criteria in the PSP-service.\n\n**scopes**:\n- admin:fraud:/admin\n- read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Collection of PSP block rules","openapi":"/mintlify-docs/openapi/spec-fraud.yaml get /accounts/{aid}/fraud/psp-block-rules","href":"/fraud-api/psp-block-rules/api_fraud_psp_block_rules_get"},{"title":"Create a new PSP block rule","description":"Create block rules for blocking payments based on certain criteria in the PSP-service.\n\n**scopes**:\n- admin:fraud:/admin\n- write:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Create a new PSP block rule","openapi":"/mintlify-docs/openapi/spec-fraud.yaml post /accounts/{aid}/fraud/psp-block-rules","href":"/fraud-api/psp-block-rules/api_fraud_psp_block_rules_post"},{"title":"Get a PSP block rule","description":"**scopes**:\n - admin:fraud:/admin\n - read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Get a PSP block rule","openapi":"/mintlify-docs/openapi/spec-fraud.yaml get /accounts/{aid}/fraud/psp-block-rules/{id}","href":"/fraud-api/psp-block-rules/api_fraud_psp_block_rules_id_get"},{"title":"Delete a PSP block rule","description":"**scopes**:\n - admin:fraud:/admin\n - read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Delete a PSP block rule","openapi":"/mintlify-docs/openapi/spec-fraud.yaml delete /accounts/{aid}/fraud/psp-block-rules/{id}","href":"/fraud-api/psp-block-rules/api_fraud_psp_block_rules_id_delete"}]},{"group":"reports","pages":[{"title":"Get a alarms report from the fraud service","description":"Returns a file with report data from the fraud service.\n\nreport type alarms CSV example:\n```\nid;rule_type;rule_dimension;rule_threshold;severity;account_id;window_start;window_end;metric_account_id:metric_type;metric_value;metric_numerator;metric_denominator;entered_at;expires_at\n7e4ff3e5-18fe-4932-b322-2a5f549a141f;bin_attack;55555555;100.0;high;P00000000;2018-02-13T00:00:00;2018-02-13T23:59:59;P11112230;count;200;200;1;2018-02-13T15:28:48;2018-02-20T15:28:48\n```\n\n**scopes**:\n- admin:fraud:/admin\n- read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Get a alarms report from the fraud service","openapi":"/mintlify-docs/openapi/spec-fraud.yaml post /accounts/{aid}/fraud/reports/generate","href":"/fraud-api/reports/api_fraud_reports_generate_post"}]},{"group":"rules","pages":[{"title":"Collection of merchant metric rules","description":"Lists of merchant metric rules defined in fraud service.\n\n**scopes**:\n- admin:fraud:/admin\n- read:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Collection of merchant metric rules","openapi":"/mintlify-docs/openapi/spec-fraud.yaml get /accounts/{aid}/fraud/rules","href":"/fraud-api/rules/api_fraud_merchant_metric_rules_collection_get"},{"title":"Create a merchant metric rules","description":"Create a merchant metric rule for triggering alrmes when metric values exceed the defined thresholds.\n\n**scopes**:\n- admin:fraud:/admin\n- write:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Create a merchant metric rules","openapi":"/mintlify-docs/openapi/spec-fraud.yaml post /accounts/{aid}/fraud/rules","href":"/fraud-api/rules/api_fraud_merchant_metric_rules_collection_post"},{"title":"Update a merchant metric rule by id","description":"Update a merchant metric rule for triggering alrmes when metric values exceed the defined thresholds.\n\n**scopes**:\n- admin:fraud:/admin\n- write:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Update a merchant metric rule by id","openapi":"/mintlify-docs/openapi/spec-fraud.yaml put /accounts/{aid}/fraud/rules/{id}","href":"/fraud-api/rules/api_fraud_merchant_metric_rules_by_id_put"},{"title":"Delete a merchant metric rule by id","description":"Deletes a merchant metric rule.\n\n**scopes**:\n- admin:fraud:/admin\n- write:fraud:/admin\n","deprecated":null,"version":null,"sidebarTitle":"Delete a merchant metric rule by id","openapi":"/mintlify-docs/openapi/spec-fraud.yaml delete /accounts/{aid}/fraud/rules/{id}","href":"/fraud-api/rules/api_fraud_merchant_metric_rules_by_id_delete"}]}]}]},{"dropdown":"Insight","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/presentation-chart-line.svg","groups":[{"group":"Insight API","pages":[{"group":"generate-insight-report","pages":[{"title":"Generate report from reportparams","description":"Create a report from the report params, this bypasses the normal schedule\nreport setup and triggers report generation instantly\n\nThe \"from\" and \"to\" parameters needs to be populated with values matching\nthe provided schedule\n\nNB! For internal use only!\n\n**scopes**:\n- admin:insight\n- write:insight\n","deprecated":null,"version":null,"sidebarTitle":"Generate report from reportparams","openapi":"/mintlify-docs/openapi/spec-insight.yaml post /accounts/{aid}/insight/generate-report","href":"/insight-api/generate-insight-report/aid_insight_service_generate_report"}]},{"group":"kpi","pages":[{"title":"List checkout KPIs","description":"Get a list of KPIs where the transactiosn used is in the aggregations are transactions from \"event_created_at_gte\",\nuntil now. However, transactions from the \"current\" interval are not included.\\\nE.g if week is provided as interval, then no transactions from the current week are included. This is true for\nday and month intervals aswell.\n\nScopes:\n - read:insight\n - admin:insight\n**deprecated** 2025-05-20\n","deprecated":null,"version":null,"sidebarTitle":"List checkout KPIs","openapi":"/mintlify-docs/openapi/spec-insight.yaml get /accounts/{aid}/insight/kpi/checkout","href":"/insight-api/kpi/api_insight_checkout_kpis_get"},{"title":"Checkout transaction event KPIs","description":"Get a list of KPIs where the result is the aggregation of the specified\nevent type given provided interval\n\nScopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Checkout transaction event KPIs","openapi":"/mintlify-docs/openapi/spec-insight.yaml get /accounts/{aid}/insight/kpi/checkout-transaction-events","href":"/insight-api/kpi/api_insight_checkout_transactions_events_kpis_get"},{"title":"Checkout transaction status KPIs","description":"Get a list of KPIs where the result is the aggregation of transactions\nwhere that match provided status\n\nScopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Checkout transaction status KPIs","openapi":"/mintlify-docs/openapi/spec-insight.yaml get /accounts/{aid}/insight/kpi/checkout-transaction-status","href":"/insight-api/kpi/api_insight_checkout_transactions_status_kpis_get"}]},{"group":"report-configuration","pages":[{"title":"List insight configurations","description":"List all insight report configurations for the account.\n\nscopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"List insight configurations","openapi":"/mintlify-docs/openapi/spec-insight.yaml get /accounts/{aid}/insight/reports/configuration","href":"/insight-api/report-configuration/aid_reports_configuration_get"},{"title":"Create new insight report configuration","description":"Create a new report configuration\n\nscopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Create new insight report configuration","openapi":"/mintlify-docs/openapi/spec-insight.yaml post /accounts/{aid}/insight/reports/configuration","href":"/insight-api/report-configuration/aid_report_configuration_post"},{"title":"Update insight report configuration","description":"Update insight report configuration.\n\nScopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Update insight report configuration","openapi":"/mintlify-docs/openapi/spec-insight.yaml put /accounts/{aid}/insight/reports/configuration/{id}","href":"/insight-api/report-configuration/aid_reports_configuration_put"},{"title":"Delete insight report configuration","description":"Delete insight report configuration.\n\nscopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Delete insight report configuration","openapi":"/mintlify-docs/openapi/spec-insight.yaml delete /accounts/{aid}/insight/reports/configuration/{id}","href":"/insight-api/report-configuration/aid_reports_configuration_delete"}]}]}]},{"dropdown":"Ledger","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/book-open.svg","groups":[{"group":"Ledger API","pages":[{"group":"accounts","pages":[{"title":"Configure new account","description":"Create a new account with the provided configuration.\n","deprecated":null,"version":null,"sidebarTitle":"Configure new account","openapi":"/mintlify-docs/openapi/spec-ledger.yaml post /accounts/{aid}/ledger/config","href":"/ledger-api/accounts/accounts_config_post"}]},{"group":"payout-destinations","pages":[{"title":"List payout destinations","description":"List all payout destinations.","deprecated":null,"version":null,"sidebarTitle":"List payout destinations","openapi":"/mintlify-docs/openapi/spec-ledger.yaml get /accounts/{aid}/ledger/payout-destinations","href":"/ledger-api/payout-destinations/payout-destinations_get"},{"title":"Configure payout destination","description":"Set the configuration for a payout destination. If a payout destination does not exist for the given `payout_destination_id`, it will be created. Use payout destionation id `\"-\"` to create or update the account level default config.","deprecated":null,"version":null,"sidebarTitle":"Configure payout destination","openapi":"/mintlify-docs/openapi/spec-ledger.yaml put /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/config","href":"/ledger-api/payout-destinations/payout-destinations_config_put"},{"title":"On-demand payout","description":"Create a payout for the given payout destination by consolidating\nall pending funds from any payout interval account (week, month) into\nthe daily payout account (`Assets.Payouts.Day`). The funds will then be included\nin the next daily payout run.\n\nThis is useful when you want existing pending payouts to be disbursed without\nwaiting for the original schedule, or when you want to manually trigger a\npayout outside the normal interval.\n\n**NOTE**: This operation has **eventual consistency** with the balances returned\nfrom [GET /v1/accounts/{account_id}/ledger/payout-destinations](/ledger-api/payout-destinations/payout-destinations_get).\n","deprecated":null,"version":null,"sidebarTitle":"On-demand payout","openapi":"/mintlify-docs/openapi/spec-ledger.yaml post /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/payouts","href":"/ledger-api/payout-destinations/payout-destinations_payouts_post"},{"title":"Fund transfer","description":"Initiate a fund transfer from the current payout destination to another\npayout destination. Currently only same-account fund transfers are\nsupported.\n","deprecated":null,"version":null,"sidebarTitle":"Fund transfer","openapi":"/mintlify-docs/openapi/spec-ledger.yaml post /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/fund-transfers","href":"/ledger-api/payout-destinations/payout-destinations_fund-transfers_post"}]},{"group":"bank-accounts","pages":[{"title":"Create bank account","description":"Create a bank account for a payout destination. If a payout destination does not exist for the given `payout_destination_id`, it will be created.","deprecated":null,"version":null,"sidebarTitle":"Create bank account","openapi":"/mintlify-docs/openapi/spec-ledger.yaml post /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/bank-accounts","href":"/ledger-api/bank-accounts/bank-accounts_post"},{"title":"Unlink bank account","description":"Unlink a bank account from one payout destination; clears any currency override pointing at it in the same call.","deprecated":null,"version":null,"sidebarTitle":"Unlink bank account","openapi":"/mintlify-docs/openapi/spec-ledger.yaml delete /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/bank-accounts/{bank_account_id}/link","href":"/ledger-api/bank-accounts/bank-accounts_unlink"},{"title":"Set payout account overrides","description":"Set the bank account used for payouts per currency. Replaces all existing overrides; nothing changes if any override is invalid.","deprecated":null,"version":null,"sidebarTitle":"Set payout account overrides","openapi":"/mintlify-docs/openapi/spec-ledger.yaml put /accounts/{aid}/ledger/payout-destinations/{payout_destination_id}/bank-accounts/payout-accounts-mapping/overrides","href":"/ledger-api/bank-accounts/bank-accounts_payout-account-overrides_put"},{"title":"List Dintero bank accounts","description":"List Dintero's client bank accounts, optionally filtered by country and currency. When both filters are given, only bank accounts matching both are returned. The same accounts are returned for every account.","deprecated":null,"version":null,"sidebarTitle":"List Dintero bank accounts","openapi":"/mintlify-docs/openapi/spec-ledger.yaml get /accounts/{aid}/ledger/dintero-bank-accounts","href":"/ledger-api/bank-accounts/dintero-bank-accounts_get"}]}]}]},{"dropdown":"Management Auth","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/shield-check.svg","groups":[{"group":"Management Auth API","pages":[{"group":"account users","pages":[{"title":"Authenticated User","description":"Get public and private profile information when authenticated\nthrough Bearer auth\n\n> Use ID token as Bearer token if the user was authenticated\n> externally. The ID token must include a `email` claim that\n> identifies the account user.\n\nscopes:\n- openid\n- aws.cognito.signin.user.admin\n","deprecated":null,"version":null,"sidebarTitle":"Authenticated User","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /account/user","href":"/management-auth-api/account-users/account_user_get"},{"title":"Configure SMS MFA","description":"Update the user SMS MFA configuration\n","deprecated":null,"version":null,"sidebarTitle":"Configure SMS MFA","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /account/user/mfa/sms","href":"/management-auth-api/account-users/account_user_mfa_sms_put"},{"title":"Configure TOTP MFA","description":"Update the user TOTP MFA configuration\n","deprecated":null,"version":null,"sidebarTitle":"Configure TOTP MFA","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /account/user/mfa/totp","href":"/management-auth-api/account-users/account_user_mfa_totp_put"},{"title":"Change User password","description":"Change the password for the account user\n\nscopes:\n- openid\n","deprecated":null,"version":null,"sidebarTitle":"Change User password","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /account/user/password","href":"/management-auth-api/account-users/account_user_password_put"},{"title":"Users Collection","description":"Get list of all users with access to the account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Users Collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/users","href":"/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_get"},{"title":"Create User","description":"Create and grant user access to the account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create User","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/users","href":"/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_post"},{"title":"Update User","description":"Update user\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update User","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{oid}/management/users/{uid}","href":"/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_put"},{"title":"Delete User","description":"Delete a user from an account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete User","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{oid}/management/users/{uid}","href":"/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_delete"},{"title":"Get user activity log","description":"Get activities for User\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get user activity log","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/users/{uid}/activities","href":"/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_activities_get"}]},{"group":"challenge","pages":[{"title":"Challenge request","description":"Request a challenge for multi-factor authentication (MFA) based\non the challenge types supported by the user.\n\nThe challenge_type is how the user will get the challenge\nand prove possession. Supported challenge types include:\n\n - `oob`: for SMS messages or out-of-band (OOB)\n\nUse the response to request access token from the\n[auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) endpoint\nwith `grant_type=mfa_oob`\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/mfa\n","deprecated":null,"version":null,"sidebarTitle":"Challenge request","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/auth/mfa/challenge","href":"/management-auth-api/challenge/aid_auth_mfa_challenge_post"},{"title":"Recovery","description":"Request a recovery for user with multi-factor\nauthentication (MFA) enabled.\n\nA recovery is done with two out-of-band (OOB) challenges\nover different channels.\n\nUse the response to request access token from the\n[auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) endpoint\nwith `grant_type=mfa_oob`.\n\nA `403 status` with `mfa_required` error will be returned on success,\nuse the response to request a new challenge from the\n[auth/mfa/challenge](/management-auth-api/challenge/aid_auth_mfa_challenge_post) endpoint.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/mfa\n","deprecated":null,"version":null,"sidebarTitle":"Recovery","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/auth/mfa/recovery","href":"/management-auth-api/challenge/aid_auth_mfa_recovery_post"}]},{"group":"auth users","pages":[{"title":"Create User","description":"Create a new user\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Create User","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/auth/users","href":"/management-auth-api/auth-users/aid_auth_users_post"},{"title":"Update user","description":"Update existing user with new password\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Update user","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/auth/users/{username}","href":"/management-auth-api/auth-users/aid_auth_users_username_put"},{"title":"Delete user","description":"Delete existing user\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Delete user","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{aid}/auth/users/{username}","href":"/management-auth-api/auth-users/aid_auth_users_username_delete"},{"title":"Change username","description":"Update existing users username\n\nscopes:\n- admin:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Change username","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/auth/users/{username}/change_username","href":"/management-auth-api/auth-users/aid_auth_users_username_change_username_post"}]},{"group":"account-assets","pages":[{"title":"Create asset upload url","description":"Create an upload URL that can be used to transfere the asset\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/assets\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create asset upload url","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/assets","href":"/management-auth-api/account-assets/aid_account_assets_post"}]},{"group":"account-stores","pages":[{"title":"List BAX merchant agreements of the account","description":"List the BankAxept (BAX) merchant agreements of all stores in the account, newest first. Deleted agreements are not included.\n\nUse `bax_number` to find which store holds a number, `status` to find agreements that no longer match their store, and `store_id` to list one store's agreements.\n\nThe list only covers this account. A `bax_number` used on another account is not found.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"List BAX merchant agreements of the account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/bax-merchant-agreements","href":"/management-auth-api/account-stores/aid_account_management_bax_merchant_agreements_get"},{"title":"List stores","description":"Get details about the account stores\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List stores","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/stores","href":"/management-auth-api/account-stores/aid_account_management_stores_get"},{"title":"Create store","description":"Create a store\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create store","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/stores","href":"/management-auth-api/account-stores/aid_account_management_stores_post"},{"title":"Store details","description":"Get store details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Store details","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/stores/{store_id}","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_get"},{"title":"Update store","description":"Update store properties\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update store","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/stores/{store_id}","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_put"},{"title":"Delete store","description":"Delete single store. The store's BankAxept (BAX) merchant agreements are deleted too, so their `bax_number` can be used again.\n\nA store that has terminals cannot be deleted. The request fails with `409` and the error code `STORE_HAS_TERMINALS`. Delete the terminals first.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete store","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{aid}/stores/{store_id}","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_delete"},{"title":"List BAX merchant agreements","description":"List the store's BankAxept (BAX) merchant agreements, newest first. Deleted agreements are not included.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"List BAX merchant agreements","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/stores/{store_id}/bax-merchant-agreements","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_bax_merchant_agreements_get"},{"title":"Create BAX merchant agreement","description":"Register a BankAxept (BAX) merchant agreement for the store. The new agreement becomes the store's current agreement.\n\nThe request fails with 400 when:\n- the store has no payout destination\n- the store's payout destination is not found\n- the agreement doesn't match the store, see the request body\n- the `bax_number` is already used by another agreement\n\nCreating an agreement doesn't change the store's `status`.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Create BAX merchant agreement","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/stores/{store_id}/bax-merchant-agreements","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_bax_merchant_agreements_post"},{"title":"Update BAX merchant agreement","description":"Replace the values of a BankAxept (BAX) merchant agreement, including its `bax_number`. The agreement keeps its `id`. A deleted agreement can't be updated.\n\nThe values must match the store, see the request body. After a successful update the agreement's `status` is `valid`. If it is the store's current agreement, the new values are synced to the terminal system.\n\nThe request fails with 400 when:\n- the store has no payout destination\n- the store's payout destination is not found\n- the agreement doesn't match the store. The response lists the fields that don't match in `error.errors`, with the `expected` and `actual` value of each, see the request body.\n- the `bax_number` is already used by another agreement\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Update BAX merchant agreement","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/stores/{store_id}/bax-merchant-agreements/{agreement_id}","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_bax_merchant_agreements_agid_put"},{"title":"Delete BAX merchant agreement","description":"Delete a BankAxept (BAX) merchant agreement, e.g. one created by mistake. If it was the store's current agreement, the previous agreement becomes current. The `bax_number` can be used again.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Delete BAX merchant agreement","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{aid}/stores/{store_id}/bax-merchant-agreements/{agreement_id}","href":"/management-auth-api/account-stores/aid_account_management_stores_sid_bax_merchant_agreements_agid_delete"}]},{"group":"account-terminals","pages":[{"title":"List terminals","description":"List terminals for the account. Filter by store, payout destination, status, device model, or serial number.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List terminals","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/terminals","href":"/management-auth-api/account-terminals/aid_account_management_terminals_get"},{"title":"Create terminal","description":"Register a physical payment terminal and associate it with a store.\n\nFails with `400` `STORE_NOT_ACTIVE` if the store is not `ACTIVE`.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create terminal","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/terminals","href":"/management-auth-api/account-terminals/aid_account_management_terminals_post"},{"title":"Terminal details","description":"Get details for a single terminal.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Terminal details","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/terminals/{terminal_id}","href":"/management-auth-api/account-terminals/aid_account_management_terminals_termid_get"},{"title":"Delete terminal","description":"Remove a terminal from the account.\n\nRemoving a terminal also starts an `end_of_day` operation on it, to close the terminal's open batch. The operation runs asynchronously and does not block or fail the removal. Its result is available from `GET /v1/accounts/{aid}/payments/admin/terminals/operations?terminal_id={terminal_id}`. A terminal that is turned off or unreachable ends the operation as `TIMEOUT`. No operation is created for a terminal that is not active, for example one still being activated.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete terminal","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{aid}/terminals/{terminal_id}","href":"/management-auth-api/account-terminals/aid_account_management_terminals_termid_delete"}]},{"group":"account-price-package","pages":[{"title":"Price package details","description":"Get details of price package set for the account.\n\nscopes:\n - admin:accounts\n - read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Price package details","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/price-package","href":"/management-auth-api/account-price-package/aid_account_price_package_get"}]},{"group":"account-settings","pages":[{"title":"Get Account settings","description":"Get details about the account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Account settings","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings","href":"/management-auth-api/account-settings/aid_account_aid_get"},{"title":"Update Account Settings","description":"Update account settings\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Account Settings","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings","href":"/management-auth-api/account-settings/aid_account_settings_put"},{"title":"Get Account sandbox settings","description":"Get details about the account sandbox settings\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Account sandbox settings","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/sandbox","href":"/management-auth-api/account-settings/aid_account_settings_sandbox_get"},{"title":"Update Account sandbox settings","description":"\nRequest update of the sandbox settings. The update is done async.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Account sandbox settings","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/sandbox","href":"/management-auth-api/account-settings/aid_account_settings_sandbox_put"}]},{"group":"approvals","pages":[{"title":"List payment approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List payment approvals","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/approvals/payments","href":"/management-auth-api/approvals/aid_management_settings_approvals_payment_get"},{"title":"New payment approval","description":"Initiate an application for using Dintero payments . The application\nwill contain a link to an URL where the signatory of the account will need\nto finish submission of the case contract and sign it. Dintero will perform\na KYC, AML and bank ownership check before the application\n`case_status`will be updated to `ACTIVE`. Once the application is approved\nwe will set up your account for using Dintero payments. Note that not all\npayment methods are available in all countries, and that for some payments\nmethods some processing time must be expected before you can start accepting\npayments.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"New payment approval","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/approvals/payments","href":"/management-auth-api/approvals/aid_management_settings_approvals_payment_post"},{"title":"List seller approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List seller approvals","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/management-auth-api/approvals/aid_management_settings_approvals_payout_destinations_get"},{"title":"New seller approval","description":"Initiate an application for a new seller for Dintero Payout with\nsplit-payment. The application will contain a link to an URL where the\nsignatory of the seller will need to finish submission of the\ncase contract and sign it. Dintero will perform a KYC, AML and bank ownership\ncheck on the seller before the application `case_status`will be\nupdated to `ACTIVE`. Once the application is approved, the payout\ndestination will be added automatically to the Dintero Payout service.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n\n---\n For testing purposes it is possible to auto-approve or decline a new seller by adding one of the following values to `payout_destination_description`:\n\n - \"AUTO_APPROVE\": Approves the case automatically, the case status will be set to `ACTIVE`\n - \"AUTO_DECLINE\": Declines the case automatically, the case status will be set to `DECLINED`\n - \"AUTO_WAITING_FOR_SIGNATURE\": Leaves the signature check for the case, the case status will be set to `WAITING_FOR_SIGNATURE`\n\nNOTE: This behavior is only available in test mode, i.e. with an `aid` prefixed with \"T\".\n\n---\n Dintero admins (access tokens with the `admin:dintero` scope) can replace Dintero's standard terms for sellers with links to custom agreements by supplying `custom_agreements`. A case created with `custom_agreements` is always reviewed manually, it is never approved automatically.\n","deprecated":null,"version":null,"sidebarTitle":"New seller approval","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/management-auth-api/approvals/aid_management_settings_approvals_payout_destinations_post"},{"title":"Get seller approval","description":"Get a single seller approval by ID.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get seller approval","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/approvals/payout-destinations/{id}","href":"/management-auth-api/approvals/aid_management_settings_approvals_payout_destinations_id_get"},{"title":"Archive seller approval","description":"Archive approval where status is one of\n- ACTIVE\n- DECLINED\n- WAITING_FOR_SIGNATURE\n- WAITING_FOR_DECLARATION\n- ERROR\n\nThis will remove the approval from the list of approvals, updates to the\napproval will be ignored.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"Archive seller approval","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{aid}/management/settings/approvals/payout-destinations/{id}","href":"/management-auth-api/approvals/aid_management_settings_approvals_payout_destinations_id_delete"}]},{"group":"account-cdd","pages":[{"title":"Get list of due diligence cases","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get list of due diligence cases","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/cdd/cases","href":"/management-auth-api/account-cdd/aid_management_settings_cdd_cases_get"},{"title":"Create a due diligence case","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create a due diligence case","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/cdd/cases","href":"/management-auth-api/account-cdd/aid_management_settings_cdd_cases_post"},{"title":"Post updated case","description":"Performs a GET on CDD Service to get the updated case (ignores body).\n","deprecated":null,"version":null,"sidebarTitle":"Post updated case","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/cdd/cases/{id}/callback","href":"/management-auth-api/account-cdd/aid_management_settings_cdd_cases_callback"}]},{"group":"account-connections","pages":[{"title":"Get Mastercard 3D-Secure signup status","description":"Check status for enrolling the merchant into 3D-Secure for Mastercard\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Get Mastercard 3D-Secure signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/mastercard-3ds","href":"/management-auth-api/account-connections/aid_account_settings_connections_mastercard_3ds_get"},{"title":"Mastercard 3D-Secure signup","description":"Enrol the merchant into 3D-Secure for Mastercard\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard 3D-Secure signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/mastercard-3ds","href":"/management-auth-api/account-connections/aid_account_settings_connections_mastercard_3ds_post"},{"title":"Bambora PayFac signup","description":"Initialize Bambora PayFac signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Bambora PayFac signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/bambora-payfac","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_payfac_post"},{"title":"Get Bambora signup status","description":"Get details about the Bambora configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Bambora signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/bambora-direct","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_direct_get"},{"title":"Bambora Direct signup","description":"Initialize Bambora Direct signup\n\nscopes:\n - admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Bambora Direct signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/bambora-direct","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_direct_post"},{"title":"Get Bambora signup status","description":"Get details about the Bambora configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Bambora signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/bambora","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_get"},{"title":"Bambora signup","description":"**DEPRECATED** \n\nOld signup for bambora. Please use Bambora Direct or Bambora Payfac for new signups.\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Bambora signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/bambora","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_post"},{"title":"Bambora Callback","description":"Handle callback from Bambora signup\n\nCompletes the Bambora signup, enables Bambora for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/bambora\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Bambora Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/bambora/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_callback_post"},{"title":"List Bambora IPP submerchants","description":"List Bambora in-person payment (IPP) submerchant onboardings for the account.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"List Bambora IPP submerchants","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/bambora-ipp-submerchants","href":"/management-auth-api/account-connections/aid_account_settings_connections_bambora_ipp_get"},{"title":"Get Collector Bank signup status","description":"Get details about the Collector Bank configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Collector Bank signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/collector","href":"/management-auth-api/account-connections/aid_account_settings_connections_collector_get"},{"title":"Collector Bank signup","description":"Initialize Collector Bank signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Collector Bank signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/collector","href":"/management-auth-api/account-connections/aid_account_settings_connections_collector_post"},{"title":"Collector Bank Callback","description":"Handle callback from Collector Bank signup\n\nCompletes the Collector Bank signup, enables Collector Bank for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/collector\n- write:accounts\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Collector Bank Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/collector/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_collector_callback_post"},{"title":"Get Common signup status","description":"Get details about the Common configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Common signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/common","href":"/management-auth-api/account-connections/aid_account_settings_connections_common_get"},{"title":"Common signup","description":"Initialize Common signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Common signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/common","href":"/management-auth-api/account-connections/aid_account_settings_connections_common_post"},{"title":"Get link to the Common signup object with sensitive signup data","description":"Endpoint used by the Dintero Onboarding Team, get link to the common\nconfiguration signup object.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Get link to the Common signup object with sensitive signup data","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/common/signup","href":"/management-auth-api/account-connections/aid_account_settings_connections_common_signup_url_post"},{"title":"Get Dintero PSP signup status","description":"Get details about the Dintero PSP configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Dintero PSP signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/dintero-psp","href":"/management-auth-api/account-connections/aid_account_settings_connections_dintero_psp_get"},{"title":"Dintero PSP signup","description":"Initialize Dintero PSP signup.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Dintero PSP signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/dintero-psp","href":"/management-auth-api/account-connections/aid_account_settings_connections_dintero_psp_post"},{"title":"Get Instabank signup status","description":"Get details about the Instabank\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Instabank signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/instabank","href":"/management-auth-api/account-connections/aid_account_settings_connections_instabank_get"},{"title":"Instabank signup","description":"Initialize Instabank signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Instabank signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/instabank","href":"/management-auth-api/account-connections/aid_account_settings_connections_instabank_post"},{"title":"Instabank Callback","description":"Handle callback from Instabank signup\n\nCompletes the Instabank signup, enables Instabank for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/instabank\n","deprecated":null,"version":null,"sidebarTitle":"Instabank Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/instabank/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_instabank_callback_post"},{"title":"Get Klarna signup status","description":"Get details about the Klarna configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Klarna signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/klarna","href":"/management-auth-api/account-connections/aid_account_settings_connections_klarna_get"},{"title":"Klarna signup","description":"Initialize Klarna signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Klarna signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/klarna","href":"/management-auth-api/account-connections/aid_account_settings_connections_klarna_post"},{"title":"Get Kravia signup status","description":"Get details about the Kravia configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Kravia signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/kravia","href":"/management-auth-api/account-connections/aid_account_settings_connections_kravia_get"},{"title":"Kravia Update","description":"Update Kravia connection configuration.\n\nCurrently supports updating invoice delivery mode.\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Kravia Update","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/kravia","href":"/management-auth-api/account-connections/aid_account_settings_connections_kravia_put"},{"title":"Kravia Signup","description":"Initialize Kravia signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Kravia Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/kravia","href":"/management-auth-api/account-connections/aid_account_settings_connections_kravia_post"},{"title":"Get Seitatech signup status","description":"Get details about the Seitatech configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Seitatech signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/seitatech","href":"/management-auth-api/account-connections/aid_account_settings_connections_seitatech_get"},{"title":"Seitatech signup","description":"Initialize Seitatech signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Seitatech signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/seitatech","href":"/management-auth-api/account-connections/aid_account_settings_connections_seitatech_post"},{"title":"Get Two signup status","description":"Get details about the Two configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Two signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/two","href":"/management-auth-api/account-connections/aid_account_settings_connections_two_get"},{"title":"Two signup","description":"Initialize Two signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Two signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/two","href":"/management-auth-api/account-connections/aid_account_settings_connections_two_post"},{"title":"Get Vipps PSP signup status","description":"Get details about the Vipps PSP configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Vipps PSP signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/vipps-psp","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_psp_get"},{"title":"Vipps PSP Signup","description":"Initialize Vipps PSP signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Vipps PSP Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/vipps-psp","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_psp_post"},{"title":"Get Apple Pay signup status","description":"Get details about the Apple Pay configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Apple Pay signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/applepay","href":"/management-auth-api/account-connections/aid_account_settings_connections_apple_pay_get"},{"title":"Apple Pay Update","description":"Update Apple Pay connection with additional domains\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Apple Pay Update","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/applepay","href":"/management-auth-api/account-connections/aid_account_settings_connections_apple_pay_put"},{"title":"Apple Pay Signup","description":"Initialize Apple Pay signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Apple Pay Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/applepay","href":"/management-auth-api/account-connections/aid_account_settings_connections_apple_pay_post"},{"title":"Get PayEx signup status","description":"Get details about the Vipps\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get PayEx signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/payex/{payment_product_type}","href":"/management-auth-api/account-connections/aid_account_settings_connections_payex_get"},{"title":"PayEx signup","description":"Initialize PayEx signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"PayEx signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/payex/{payment_product_type}","href":"/management-auth-api/account-connections/aid_account_settings_connections_payex_post"},{"title":"PayEx Callback","description":"Handle callback from PayEx signup\n\nCompletes the PayEx signup, enables PayEx for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/payex\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"PayEx Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/payex/{payment_product_type}/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_payex_callback_post"},{"title":"PayEx overrides","description":"Add PayEx overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"PayEx overrides","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/payex/overrides","href":"/management-auth-api/account-connections/aid_account_settings_connections_payex_overrides_put"},{"title":"Santander overrides","description":"Add Santander overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Santander overrides","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/santander/overrides","href":"/management-auth-api/account-connections/aid_account_settings_connections_santander_overrides_put"},{"title":"Get Swish signup status","description":"Get details about the Swish configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Swish signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/swish","href":"/management-auth-api/account-connections/aid_account_settings_connections_swish_get"},{"title":"Swish signup","description":"Initialize Swish signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Swish signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/swish","href":"/management-auth-api/account-connections/aid_account_settings_connections_swish_post"},{"title":"Swish payfac signup","description":"Initialize Swish signup\n\nRequires a case_id created from a payment approval\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Swish payfac signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/swish-payfac","href":"/management-auth-api/account-connections/aid_account_settings_connections_swish_payfac_post"},{"title":"Swish Callback","description":"Handle callback from Swish signup\n\nCompletes the Swish signup, enables Swish for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/swish\n","deprecated":null,"version":null,"sidebarTitle":"Swish Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/swish/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_swish_callback_post"},{"title":"Swish overrides","description":"Add Swish overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Swish overrides","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/swish/overrides","href":"/management-auth-api/account-connections/aid_account_settings_connections_swish_overrides_put"},{"title":"Get Vipps signup status","description":"Get details about the Vipps\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Vipps signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/vipps","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_get"},{"title":"Vipps signup","description":"Reinitialize Vipps signup if connection is not enabled.\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Vipps signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/vipps","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_put"},{"title":"Vipps signup","description":"Initialize Vipps signup\n\nRequires the account company to be configured with `organization_number`\n[PUT /management/settings](/management-auth-api/account-settings/aid_account_settings_put)\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Vipps signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/vipps","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_post"},{"title":"Vipps Callback","description":"Handle callback from Vipps signup\n\nCompletes the Vipps signup, enables Vipps for Checkout\n\nscopes:\n- write:accounts:/management/settings/connections/vipps\n","deprecated":null,"version":null,"sidebarTitle":"Vipps Callback","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/vipps/{callback_reference}","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_callback_post"},{"title":"Vipps overrides","description":"Add Vipps overrides for pre-existing connection\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Vipps overrides","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{aid}/management/settings/connections/vipps/overrides","href":"/management-auth-api/account-connections/aid_account_settings_connections_vipps_overrides_put"},{"title":"Get Visa Tokenization signup status","description":"Get details about the Visa Tokenization configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Visa Tokenization signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/visa-tokenization","href":"/management-auth-api/account-connections/aid_account_settings_connections_visa_tokenization_get"},{"title":"Visa Tokenization Signup","description":"Initialize Visa Tokenization signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Visa Tokenization Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/visa-tokenization","href":"/management-auth-api/account-connections/aid_account_settings_connections_visa_tokenization_post"},{"title":"Get Visa Click-to-Pay signup status","description":"Get details about the Visa Click-to-Pay configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Visa Click-to-Pay signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/clicktopay","href":"/management-auth-api/account-connections/aid_account_settings_connections_visa_click_to_pay_get"},{"title":"Visa Click-to-pay Signup","description":"Initialize Visa Click-to-pay signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Visa Click-to-pay Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/clicktopay","href":"/management-auth-api/account-connections/aid_account_settings_connections_visa_click_to_pay_post"},{"title":"Get Mastercard Tokenization signup status","description":"Get details about the Mastercard Tokenization configuration\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Mastercard Tokenization signup status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/management/settings/connections/mastercard-tokenization","href":"/management-auth-api/account-connections/aid_account_settings_connections_mastercard_tokenization_get"},{"title":"Mastercard Tokenization Signup","description":"Initialize Mastercard Tokenization signup\n\nscopes:\n- admin:dintero\n","deprecated":null,"version":null,"sidebarTitle":"Mastercard Tokenization Signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/management/settings/connections/mastercard-tokenization","href":"/management-auth-api/account-connections/aid_account_settings_connections_mastercard_tokenization_post"}]},{"group":"authenticate","pages":[{"title":"Authorize Passwordless link","description":"This endpoint is used to authorize Passwordless link sent to user\nby email/sms.\n\nA valid request will redirect to\nThis is the OAuth 2.0 grant that Client-side web apps\nutilize in order to access an API.\n","deprecated":null,"version":null,"sidebarTitle":"Authorize Passwordless link","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/authorize","href":"/management-auth-api/authenticate/aid_auths_oauth_authorize_post"},{"title":"Authorize with OIDC","description":null,"deprecated":null,"version":null,"sidebarTitle":"Authorize with OIDC","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/oidc/authorize","href":"/management-auth-api/authenticate/aid_auths_oidc_authorize_get"},{"title":"Token verified by OIDC","description":"Use this endpoint to obtains an access token by presenting its authorization\ngrant\n\nscopes:\n- write:accounts:/auth/users\n","deprecated":null,"version":null,"sidebarTitle":"Token verified by OIDC","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/oidc/token","href":"/management-auth-api/authenticate/aid_auths_oidc_token_post"},{"title":"Passwordless","description":"Passwordless connections do not require the user to\nremember a password. Instead, another mechanism is used\nto prove identity, such as a one-time code sent through\nemail or SMS, every time the account user logs in.\n\n- The client_id/audience must have a grant with type\n `authorization_code` to allow sending verification-code\n- This endpoint is designed to be called from the client-side\n and is subjected to rate limits\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/passwordless\n- write:accounts:/auth/passwordless-sms\n- write:accounts:/auth/passwordless-email\n","deprecated":null,"version":null,"sidebarTitle":"Passwordless","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/passwordless","href":"/management-auth-api/authenticate/aid_auth_account_passwordless_post"},{"title":"Passwordless Code","description":"Passwordless connections do not require the user to\nremember a password. Instead, another mechanism is used\nto prove identity, such as a one-time code sent through\nemail or SMS, every time the account user logs in.\n\nUse this endpoint to generate a one-time verification-code that can\nbe sent to the user.\n\nThe client_id/audience must have a grant with type\n`authorization_code` to allow creating a verification-code\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/passwordless/code\n","deprecated":null,"version":null,"sidebarTitle":"Passwordless Code","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/passwordless/code","href":"/management-auth-api/authenticate/aid_auth_passwordless_post"},{"title":"Redirect with ID token","description":"Use this endpoint to redirect to an URL with a\nID token added.\n","deprecated":null,"version":null,"sidebarTitle":"Redirect with ID token","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/redirect","href":"/management-auth-api/authenticate/aid_auths_oauth_redirect_post"},{"title":"Revoke Token","description":"Use this endpoint to invalidate a Refresh Token if it has been compromised.\n\nscopes:\n- admin:accounts\n- write:accounts\n- create:accounts:auth:refresh_token\n","deprecated":null,"version":null,"sidebarTitle":"Revoke Token","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/revoke","href":"/management-auth-api/authenticate/aid_auths_oauth_revoke_post"},{"title":"Get Token","description":"Use this endpoint to directly request an access_token\n\n### Client Access Token\nUse HTTP Basic authentication scheme for\nauthenticating grant_type `client_credentials`, use\nclient_id/client_secret as user/password.\n\n### Code/Password Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `authorization_code` or `password`, where the\nBearer value must be a JWT toke with access to the token\nendpoint.\n\n### Account User Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `account_user_token`, where the Bearer value\nmust be a account user JWT token.\n\n> Use ID token as Bearer toke if the user was authenticated\n> externally. The ID must include a `email` claim that\n> identifies the account user.\n\n### Refresh Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `refresh_token` where the Bearer value **must**\nbe an Access Token for the clients that was used to create\nthe Refresh Token.\n\n### Multi-factor authentication (MFA)\n\nWhen a request is made to the endpoint to get an access token,\nnormally you either get an error, or you get an access token.\nHowever, when the MFA is enabled, the endpoint may return a new\nerror with `error.code: mfa_required`.\n\nWhen an `mfa_required` error is returned, the client must perform\na `challenge`. This is done by sending a request to the\n[auth/mfa/challenge](/management-auth-api/challenge/aid_auth_mfa_challenge_post) endpoint\n\nTo verify MFA using an OOB challenge, the client must make a request to\nthis endpoint with `grant_type=mfa-oob`. Include the `oob_code` you\nreceived from the challenge response, as well as the `mfa_token` you\nreceived as part of mfa_required error.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n- write:accounts:/auth/users/no-mfa\n","deprecated":null,"version":null,"sidebarTitle":"Get Token","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/token","href":"/management-auth-api/authenticate/aid_auths_oauth_token_post"},{"title":"Exchange Token","description":"Use this endpoint to exchange access_token to a sub-account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Exchange Token","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{partner_id}/auth/exchange_token","href":"/management-auth-api/authenticate/aid_auths_oauth_exchange_token_post"}]},{"group":"grants","pages":[{"title":"Client grants collection","description":"Manage your Client Grants (also called Client Credentials Grants).\nUsing Client Grants, your Client can request an access token using\nits credentials (a Client ID and a Client Secret).\nThe access token then represents your Client during API calls.\n\nUse the Grant type to limit how the grant can be used when requesting\nan access token. A Grant with type `password` can only be used when\nrequesting an access token with grant_type set to `password`.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Client grants collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/client-grants","href":"/management-auth-api/grants/aid_auths_client_grants_get"},{"title":"Create client grant","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create client grant","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/client-grants","href":"/management-auth-api/grants/aid_auths_client_grants_post"},{"title":"Delete client grant","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete client grant","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{oid}/auth/client-grants/{id}","href":"/management-auth-api/grants/aid_auths_client_grants_id_delete"},{"title":"Update client grant","description":"Update the client grant with the given id.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update client grant","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml patch /accounts/{oid}/auth/client-grants/{id}","href":"/management-auth-api/grants/aid_auths_client_grants_id_patch"}]},{"group":"clients","pages":[{"title":"Clients collection","description":"Retrieve a list of all client applications\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Clients collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/clients","href":"/management-auth-api/clients/aid_auth_clients_get"},{"title":"Create Client","description":"Creates a new client application.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create Client","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/clients","href":"/management-auth-api/clients/aid_auth_clients_post"},{"title":"Get Client","description":"Retrieves a client by its id.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Client","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/clients/{id}","href":"/management-auth-api/clients/aid_auths_clients_id_get"},{"title":"Delete Client","description":"Deletes a client and all its related assets\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete Client","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{oid}/auth/clients/{id}","href":"/management-auth-api/clients/aid_auths_clients_id_delete"},{"title":"Update Client","description":"Update client details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Client","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml patch /accounts/{oid}/auth/clients/{id}","href":"/management-auth-api/clients/aid_auths_clients_id_patch"},{"title":"Rotate a client secret.","description":"Rotate a client secret.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Rotate a client secret.","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/clients/{id}/rotate-secret","href":"/management-auth-api/clients/aid_auths_clients_id_rotate_post"}]},{"group":"keys","pages":[{"title":"Get public keys","description":"Retrieve the JSON Web Key Set (JWKS) that can be used\nto validate `access_token`\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get public keys","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/keys","href":"/management-auth-api/keys/aid_auths_keys_get"}]},{"group":"roles","pages":[{"title":"Roles collection","description":"Retrieve filtered list of roles that can be assigned to users.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Roles collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/roles","href":"/management-auth-api/roles/aid_auths_roles_get"},{"title":"Create a role","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create a role","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/auth/roles","href":"/management-auth-api/roles/aid_auths_roles_post"},{"title":"Get role","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get role","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/auth/roles/{role_id}","href":"/management-auth-api/roles/aid_auths_roles_id_get"},{"title":"Update role","description":"\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update role","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{oid}/auth/roles/{role_id}","href":"/management-auth-api/roles/aid_auths_roles_id_put"},{"title":"Delete role","description":"scopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete role","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{oid}/auth/roles/{role_id}","href":"/management-auth-api/roles/aid_auths_roles_id_delete"}]},{"group":"accounts","pages":[{"title":"Accounts collection","description":"Get list of accounts filtered by the partner account\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Accounts collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/accounts","href":"/management-auth-api/accounts/aid_mgmnt_accounts_get"},{"title":"Create Account","description":"Create an account from an partner account\n\nscopes:\n- admin:accounts\n- write:accounts\n- public:accounts\n\nIn order to create an account with `livemode` correctly enabled, the following fields must be set in the body request:\n - `company.business_name`\n - `company.organization_number`\n - `company.address.address_line`\n - `company.address.postal_place`\n - `company.address.country`\n - `company.website`\n - `billing.business_name`\n - `billing.organization_number`\n - `billing.address.address_line`\n - `billing.address.postal_place`\n - `billing.address.country`\n\nThis allows the account to proceed with KYC in Backoffice.\n","deprecated":null,"version":null,"sidebarTitle":"Create Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/accounts","href":"/management-auth-api/accounts/aid_mgmnt_accounts_post"},{"title":"Get Account","description":"Get account details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/accounts/{aid}","href":"/management-auth-api/accounts/aid_accounts_aid_get"},{"title":"Update Account","description":"Update an account\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{oid}/management/accounts/{aid}","href":"/management-auth-api/accounts/aid_accounts_aid_put"},{"title":"Delete Account","description":"Delete an account\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml delete /accounts/{oid}/management/accounts/{aid}","href":"/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete"},{"title":"Update connection status","description":"Update an account connection with new status and add an event\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update connection status","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/accounts/{aid}/connections/{connection}/events","href":"/management-auth-api/accounts/aid_accounts_aid_connections_events_post"},{"title":"Account events","description":"Get list of account events\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Account events","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/accounts/{aid}/events","href":"/management-auth-api/accounts/aid_mgmnt_accounts_events_get"},{"title":"Create Account Event","description":"Create an account event\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create Account Event","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/accounts/{aid}/events","href":"/management-auth-api/accounts/aid_mgmnt_accounts_events_post"},{"title":"Partner onboarding link","description":"Partner onboarding link\n\nscopes:\n- admin:dintero\n- write:dintero:/management/accounts\n","deprecated":null,"version":null,"sidebarTitle":"Partner onboarding link","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/accounts/{aid}/partner_onboarding_link","href":"/management-auth-api/accounts/aid_accounts_aid_partner_onboarding_link_post"},{"title":"Update price packages","description":"Update the price packages available for the partner account.\n\nscopes:\n - admin:dintero\n - write:dintero:/management/accounts/price-packages\n","deprecated":null,"version":null,"sidebarTitle":"Update price packages","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{oid}/management/accounts/{aid}/price-packages","href":"/management-auth-api/accounts/aid_account_settings_price_packages_put"}]},{"group":"admin-tasks","pages":[{"title":"List administrative tasks","description":null,"deprecated":null,"version":null,"sidebarTitle":"List administrative tasks","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/tasks","href":"/management-auth-api/admin-tasks/aid_mgmnt_tasks_get"},{"title":"Create administrative tasks","description":null,"deprecated":null,"version":null,"sidebarTitle":"Create administrative tasks","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/tasks","href":"/management-auth-api/admin-tasks/aid_mgmnt_tasks_post"}]},{"group":"account-fraud-search","pages":[{"title":"MATCH register search","description":"Search the MATCH register for any potential matches related to fraud for the account\n\nscopes:\n- read:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"MATCH register search","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/compliance-search/match","href":"/management-auth-api/account-fraud-search/accounts_aid_search_match_post"},{"title":"Add a terminated merchant to MATCH","description":"Add a terminated merchant to Mastercard MATCH\n\nscopes:\n- write:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"Add a terminated merchant to MATCH","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/compliance-search/match/terminate","href":"/management-auth-api/account-fraud-search/accounts_aid_search_match_terminate_merchant_post"},{"title":"Get MATCH register search","description":"Get result of a MATCH inquiry by the inquiry reference number (IRN)\n\nscopes:\n- read:accounts:/match\n","deprecated":null,"version":null,"sidebarTitle":"Get MATCH register search","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{aid}/compliance-search/match/{irn}","href":"/management-auth-api/account-fraud-search/accounts_aid_search_match_get"},{"title":"VMSS register search","description":"Search the Visa Merchant Screening Service register for any potential matches related to fraud for the account\n\nscopes:\n- read:accounts:/vmss\n","deprecated":null,"version":null,"sidebarTitle":"VMSS register search","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/compliance-search/vmss","href":"/management-auth-api/account-fraud-search/accounts_aid_search_vmss_post"},{"title":"Add a terminated merchant to VMSS","description":"Add a terminated to Visa Merchant Screening Service\n\nscopes:\n- write:accounts:/vmss\n","deprecated":null,"version":null,"sidebarTitle":"Add a terminated merchant to VMSS","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/compliance-search/vmss/terminate","href":"/management-auth-api/account-fraud-search/accounts_aid_search_vmss_terminate_merchant_post"}]},{"group":"account-onboarding","pages":[{"title":"Signup to Dintero Account","description":"Initiate a signup for Dintero Account\n\n- An email verification request will be sent to the applicant,\n that contains a code that must be sent to\n [POST /account/{oid}/signup/verify](/management-auth-api/account-onboarding/accounts_oid_signup_verify_post)\n\n- A welcome email will be sent after verification of the applicant email\n is completed. The email contains links to Backoffice\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Signup to Dintero Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/signup","href":"/management-auth-api/account-onboarding/accounts_oid_signup_post"},{"title":"Verify signup","description":"Complete the signup for a Dintero Account by sending the verification code\nsent to the applicant\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Verify signup","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/signup/verify","href":"/management-auth-api/account-onboarding/accounts_oid_signup_verify_post"}]},{"group":"account-onboarding-prefill","pages":[{"title":"Pre-fill a sign up for a new Dintero Account","description":"Pre-fill a sign up form for a new Dintero Account\n\n- An email verification request will be sent to the applicant,\n that contains a link where the merchant can accept the terms and create a new account.\n\n [POST /account/{oid}/signup/prefill/{prefill_id}](/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_accept_post)\n\n- An email will be sent after accepting the terms. The email contains a link to the Backoffice as well as a password\n\nscopes:\n- create:applicant\n","deprecated":null,"version":null,"sidebarTitle":"Pre-fill a sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/signup/prefill","href":"/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_post"},{"title":"Get pending pre-filled sign up for a new Dintero Account","description":"Get a prefilled a sign up form for a new Dintero Account by id, not yet\naccepted by the applicant.\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Get pending pre-filled sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/signup/prefill/{prefill_id}","href":"/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_get"},{"title":"Accept pre-filled sign up for a new Dintero Account","description":"Accept a prefilled sign up form for a new Dintero Account\n\n- An email will be sent after accepting the terms if no auhtorize query is included.\n The email contains a link to the Backoffice as well as a password\n\nscopes:\n- create:account\n","deprecated":null,"version":null,"sidebarTitle":"Accept pre-filled sign up for a new Dintero Account","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/signup/prefill/{prefill_id}","href":"/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_accept_post"}]},{"group":"price-packages","pages":[{"title":"Price package collection","description":"Get list of price packages available for the account.\n\nscopes:\n - admin:accounts\n - read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Price package collection","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/management/price-packages","href":"/management-auth-api/price-packages/aid_mgmnt_price_packages_get"},{"title":"Create Price package","description":"Create a new price package\n\nscopes:\n - admin:dintero\n - write:dintero:/management/price-packages\n","deprecated":null,"version":null,"sidebarTitle":"Create Price package","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/management/price-packages","href":"/management-auth-api/price-packages/aid_mgmnt_price_packages_post"},{"title":"Update price package","description":"Update an existing price package.\n\nscopes:\n - admin:dintero\n - write:dintero:/management/price-packages\n","deprecated":null,"version":null,"sidebarTitle":"Update price package","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml put /accounts/{oid}/management/price-packages/{price_package_id}","href":"/management-auth-api/price-packages/aid_mgmnt_price_packages_put"}]},{"group":"payout-destinations","pages":[{"title":"List payout destinations","description":"Get list of payout destinations\n\nscopes:\n - admin:accounts\n - read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List payout destinations","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/payout-destinations","href":"/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get"},{"title":"Create payout destination","description":"Create a payout destination for an account\n\nDintero admins (access tokens with the `admin:dintero` scope) can replace Dintero's standard terms for sellers with links to custom agreements by supplying `custom_agreements`. A case created with `custom_agreements` is always reviewed manually, it is never approved automatically.\n\nscopes:\n - admin:accounts\n - write:accounts\n - write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"Create payout destination","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/payout-destinations","href":"/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_post"},{"title":"Get payout destination","description":"Get a payout destination by payout destination id\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get payout destination","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml get /accounts/{oid}/payout-destinations/{payout_destination_id}","href":"/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id"},{"title":"Update payout destination","description":"Update a payout destination. Currently only allows update of `payout_interval_type`.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update payout destination","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml patch /accounts/{oid}/payout-destinations/{payout_destination_id}","href":"/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch"},{"title":"On-demand payout","description":"Create a payout for the given payout destination by consolidating all\npending funds from any payout interval account (week, month) into the\ndaily payout account. The funds will then be included in the next daily\npayout run.\n\nThis is useful when you want existing pending payouts to be\ndisbursed without waiting for the original schedule, or when you\nwant to manually trigger a payout outside the normal interval.\n\nscopes:\n - write:accounts:/on-demand-payouts\n","deprecated":null,"version":null,"sidebarTitle":"On-demand payout","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/payout-destinations/{payout_destination_id}/payouts","href":"/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_payouts_post"},{"title":"Fund transfer","description":"Initiate a fund transfer from the current payout destination to another\npayout destination. Currently only same-account fund transfers are\nsupported.\n\nRequests for fund transfers are processed asynchronously, so in the response\nwe only inform you that we received a valid request. You will get the result in\nthe settlement report.\n\nscopes:\n - write:payout\n - admin:payout\n - write:accounts:/fund-transfers\n","deprecated":null,"version":null,"sidebarTitle":"Fund transfer","openapi":"/mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{oid}/payout-destinations/{payout_destination_id}/fund-transfers","href":"/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_fund-transfers_post"}]}]}]},{"dropdown":"Notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/bell.svg","groups":[{"group":"Notifications API","pages":[{"group":"publish","pages":[{"title":"Publish a message","description":"Publish a message\n\n**scopes**:\n- admin:notifications\n- write:notifications\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Publish a message","openapi":"/mintlify-docs/openapi/spec-notifications.yaml post /accounts/{aid}/notifications/publish","href":"/notifications-api/publish/aid_notifications_publish_post"}]}]}]},{"dropdown":"Orders","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/cube.svg","groups":[{"group":"Orders API","pages":[{"group":"customer.order","pages":[{"title":"Get Order","description":"Retrieve Order details for an customer\n\nscopes:\n- user:shopping\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Order","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/customers/{customer_id}/orders/{order_id}","href":"/orders-api/customerorder/aid_customers_cid_orders_id_get"},{"title":"Orders collection","description":"Retrieve a list of orders belonging to a customer user\n\nscopes:\n- user:shopping\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Orders collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/customers/{customer_id}/orders","href":"/orders-api/customerorder/aid_customers_cid_orders_get"}]},{"group":"draft","pages":[{"title":"Complete a draft order","description":"Use this resource to transition the draft order into an Order. A draft with\nmultiple sales locations will transition into one order per sales location.\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Complete a draft order","openapi":"/mintlify-docs/openapi/spec-orders.yaml put /accounts/{aid}/shopping/draft_orders/{id}/complete","href":"/orders-api/draft/aid_draft_orders_id_complete_put"},{"title":"Get draft order","description":"Get draft order.\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get draft order","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/draft_orders/{id}","href":"/orders-api/draft/aid_draft_orders_id_get"},{"title":"Update draft order","description":"Updates a draft order.\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Update draft order","openapi":"/mintlify-docs/openapi/spec-orders.yaml put /accounts/{aid}/shopping/draft_orders/{id}","href":"/orders-api/draft/aid_draft_orders_id_put"},{"title":"Create a draft order","description":"Use this resource to create orders in draft state.\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Create a draft order","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/draft_orders","href":"/orders-api/draft/aid_draft_orders_post"}]},{"group":"draft.items","pages":[{"title":"Update item in draft","description":"Update item in draft\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Update item in draft","openapi":"/mintlify-docs/openapi/spec-orders.yaml put /accounts/{aid}/shopping/draft_orders/{id}/items/{line_id}","href":"/orders-api/draftitems/aid_draft_orders_id_items_line_id_put"},{"title":"Remove item from draft","description":"Remove a item line from the draft\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Remove item from draft","openapi":"/mintlify-docs/openapi/spec-orders.yaml delete /accounts/{aid}/shopping/draft_orders/{id}/items/{line_id}","href":"/orders-api/draftitems/aid_draft_orders_id_items_line_id_delete"},{"title":"Add item to draft","description":"Updates a draft with new item\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Add item to draft","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/draft_orders/{id}/items","href":"/orders-api/draftitems/aid_draft_orders_id_items_post"}]},{"group":"order.list","pages":[{"title":"Draft orders collection","description":"Retrieve a list of draft orders\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Draft orders collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/draft_orders","href":"/orders-api/orderlist/aid_draft_orders_get"},{"title":"Get Authorization Collection","description":"Retrieve list of authorizations for an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Authorization Collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/authorizations","href":"/orders-api/orderlist/aid_orders_id_authorizations_get"},{"title":"Get Cancellation Collection","description":"Retrieve list of cancellations for an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Cancellation Collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/cancellations","href":"/orders-api/orderlist/aid_orders_id_cancellations_get"},{"title":"Get Capture Collection","description":"Retrieve list of captures for an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Capture Collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/captures","href":"/orders-api/orderlist/aid_orders_id_captures_get"},{"title":"Order events collection","description":"Retrieve a list of latest order events\n\nscopes:\n- admin:shopping\n- read:shopping\n- read:shopping:/orders/ANY/events\n","deprecated":null,"version":null,"sidebarTitle":"Order events collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/events","href":"/orders-api/orderlist/aid_orders_id_events_get"},{"title":"Get Refunds Collection","description":"Retrieve list of refunds for an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Refunds Collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/refunds","href":"/orders-api/orderlist/aid_orders_id_refunds_get"},{"title":"Get Session Collection","description":"Retrieve list of sessions for an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Session Collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/sessions","href":"/orders-api/orderlist/aid_orders_id_sessions_get"},{"title":"Orders collection","description":"Retrieve a list of orders\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Orders collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders","href":"/orders-api/orderlist/aid_orders_get"}]},{"group":"order.authorizations","pages":[{"title":"Get Authorization details","description":"Retrieve details about a authorization\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Authorization details","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/authorizations/{authorization_id}","href":"/orders-api/orderauthorizations/aid_orders_id_authorization_id_get"},{"title":"Create an authorization","description":"Create a authorization for an order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> An authorization event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Create an authorization","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/authorizations","href":"/orders-api/orderauthorizations/aid_orders_id_authorization_post"}]},{"group":"order.cancellations","pages":[{"title":"Get Cancellation details","description":"Retrieve details about a cancellation\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Cancellation details","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/cancellations/{cancellation_id}","href":"/orders-api/ordercancellations/aid_orders_id_cancellation_id_get"},{"title":"Create an cancellation","description":"Create a cancellation for an order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> An cancellation event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Create an cancellation","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/cancellations","href":"/orders-api/ordercancellations/aid_orders_id_cancellation_post"}]},{"group":"order.status","pages":[{"title":"Cancel Order","description":"Cancel the Order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A cancel event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Cancel Order","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/cancel","href":"/orders-api/orderstatus/aid_orders_id_cancel_post"},{"title":"Close order","description":"Close the order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A close event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Close order","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/close","href":"/orders-api/orderstatus/aid_orders_id_close_post"},{"title":"Open order","description":"Re-open a closed order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A open event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Open order","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/open","href":"/orders-api/orderstatus/aid_orders_id_open_post"}]},{"group":"order.captures","pages":[{"title":"Get Capture details","description":"Retrieve details about a capture\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Capture details","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/captures/{capture_id}","href":"/orders-api/ordercaptures/aid_orders_id_captures_id_get"},{"title":"Create a capture","description":"Create a capture for an order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A capture event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Create a capture","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/captures","href":"/orders-api/ordercaptures/aid_orders_id_capture_post"}]},{"group":"order.comments","pages":[{"title":"Delete an order comment","description":"Delete an order comment\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Delete an order comment","openapi":"/mintlify-docs/openapi/spec-orders.yaml delete /accounts/{aid}/shopping/orders/{order_id}/comments/{comment_id}","href":"/orders-api/ordercomments/aid_orders_id_comments_comment_id_delete"},{"title":"Create an order comment","description":"Create a new order comment\n\nscopes:\n- admin:shopping\n- write:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Create an order comment","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/comments","href":"/orders-api/ordercomments/aid_orders_id_comments_post"}]},{"group":"order.events","pages":[{"title":"Create an order event","description":"Create a new order event\n\nscopes:\n- admin:shopping\n- write:shopping\n- write:shopping:/orders/ANY/events\n","deprecated":null,"version":null,"sidebarTitle":"Create an order event","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/events","href":"/orders-api/orderevents/aid_orders_id_events_post"}]},{"group":"order.refunds","pages":[{"title":"Get Refunds details","description":"Retrieve specific refund\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Refunds details","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/refunds/{refund_id}","href":"/orders-api/orderrefunds/aid_orders_id_refunds_id_get"},{"title":"Create a refund","description":"Create a refund for an order\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A refund event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Create a refund","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/refunds","href":"/orders-api/orderrefunds/aid_orders_id_refunds_post"}]},{"group":"order.sessions","pages":[{"title":"Get Session details","description":"Retrieve details about a session\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Session details","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}/sessions/{session_id}","href":"/orders-api/ordersessions/aid_orders_id_sessions_id_get"},{"title":"Create a session","description":"Initiate a payment session for the order.\n\nscopes:\n- admin:shopping\n- write:shopping\n\n> A session event will be added to the order\n","deprecated":null,"version":null,"sidebarTitle":"Create a session","openapi":"/mintlify-docs/openapi/spec-orders.yaml post /accounts/{aid}/shopping/orders/{order_id}/sessions","href":"/orders-api/ordersessions/aid_orders_id_session_post"}]},{"group":"order","pages":[{"title":"Get Order","description":"Retrieve Order details\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Order","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/orders/{order_id}","href":"/orders-api/order/aid_orders_id_get"},{"title":"Put Order","description":"Update an order\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Put Order","openapi":"/mintlify-docs/openapi/spec-orders.yaml put /accounts/{aid}/shopping/orders/{order_id}","href":"/orders-api/order/aid_orders_id_put"}]},{"group":"store.order","pages":[{"title":"Get Order","description":"Retrieve Order details belonging to a store\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Get Order","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/stores/{store_id}/orders/{order_id}","href":"/orders-api/storeorder/aid_stores_sid_orders_id_get"},{"title":"Orders collection","description":"Retrieve a list of orders belonging to a store\n\nscopes:\n- admin:shopping\n- read:shopping\n","deprecated":null,"version":null,"sidebarTitle":"Orders collection","openapi":"/mintlify-docs/openapi/spec-orders.yaml get /accounts/{aid}/shopping/stores/{store_id}/orders","href":"/orders-api/storeorder/aid_stores_sid_orders_get"}]}]}]},{"dropdown":"Payments-v2","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/switch-horizontal.svg","groups":[{"group":"Payments-v2 API","pages":[{"group":"session","pages":[{"title":"Create checkout session from profile","description":"Create a corresponding Checkout Session for an order placed in your system\nusing predefined session profile\n\n#### Session with Instabank\n\nNote that `items` is a required property when creating a session with\nInstabank configured.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create checkout session from profile","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/sessions-profile","href":"/payments-v2-api/session/checkout_session_profile_post"},{"title":"Get checkout session details","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get checkout session details","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/sessions/{session_id}","href":"/payments-v2-api/session/checkout_session_get"},{"title":"Update checkout session details","description":"Session must be locked for paying before updating.\n\n**Requirements**:\n- `order.shipping_option` must be included in `express_shipping_options` if both are set.\n- `order.amount` must be equal to the sum of `order.items` and `order.shipping_option`\n\nscopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update checkout session details","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml put /accounts/{aid}/payments/sessions/{session_id}","href":"/payments-v2-api/session/checkout_session_put"},{"title":"Cancel session","description":"\nCancel a session\n\nThe session transaction will be voided in case where it is\ninitialized or authorized.\n\nCancel is not allowed in case where the current transaction\nstate is not initialized or authorized.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Cancel session","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/sessions/{session_id}/cancel","href":"/payments-v2-api/session/checkout_session_cancel_post"},{"title":"Payment token session","description":"\nThis endpoint lets you create payment and recurrence tokens without reserving\nor charging any amount.\n\nThe URL returned by this endpoint opens a web site where the customer\ncan enter their payment details, e.g. card information.\n\nThe payment details will be validated and a transaction with a\npayment/recurrence token will be created on success containing the payment\ntoken created from the customer payment details.\n\n- [GET /v1/transactions/{id}?includes=card.payment_token](/api-reference/default/transactions_id_get)\n- [GET /v1/transactions/{id}?includes=card.recurrence_token](/api-reference/default/transactions_id_get)\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Payment token session","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/sessions/payment-token","href":"/payments-v2-api/session/checkout_payment_token_session_post"}]},{"group":"payment","pages":[{"title":"Create and pay merchant initiated session","description":"For merchant initiated payments, where the customer is not involved.\n\nReceives a session and pays it with the given card token.\n\n> Merchant is resposible for managing their retry policy for payments\n> that fails, and not retry when payment fails with `DO_NOT_RETRY` error.\n>\n> 200 response will be returned when request fails due to authorization error. Transaction\n> will have status `FAILED` and error information can be found at `events.error`.\n>\n> Insufficient error handling will cause cards to be blocked\n> https://docs.dintero.com/docs/checkout/tokenization#do-not-try-again--excessive-reattempts\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Create and pay merchant initiated session","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/sessions/pay","href":"/payments-v2-api/payment/checkout_session_pay_post"},{"title":"Initiate a checkout payment","description":"For Express Checkout sessions, the _`order.shipping_address`_ must be set on\nthe session, and a _`order.items.shipping_option` item is required if the\nsession has either an _`express.shipping_address_callback_url`_ or the\nsession has at least one option in _`express.shipping_options`_.\n","deprecated":null,"version":null,"sidebarTitle":"Initiate a checkout payment","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/sessions/{session_id}/pay","href":"/payments-v2-api/payment/checkout_sid_pay_post"}]},{"group":"Transactions","pages":[{"title":"List all transactions","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List all transactions","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/transactions","href":"/payments-v2-api/transactions/transactions_get"},{"title":"Get a transaction","description":"scopes:\n- admin:checkout\n- read:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get a transaction","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/transactions/{id}","href":"/payments-v2-api/transactions/transactions_id_get"},{"title":"Update a transaction","description":"scopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Update a transaction","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml put /accounts/{aid}/payments/transactions/{id}","href":"/payments-v2-api/transactions/transactions_id_put"},{"title":"Capture a transaction","description":"Captures a transaction that was created with the Checkout\nendpoint with a `capture_now` value of `false`.\n\n#### Capture Instabank transaction\n\nNote that `items` is required when capturing a transaction\nwith `payment_product=instabank`. The items must include\nthe lines to Capture, with `line_id`, `quantity` and `amount`.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Capture a transaction","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/transactions/{id}/capture","href":"/payments-v2-api/transactions/transactions_id_capture_post"},{"title":"Update transaction authorization","description":"This endpoint is used to update an existing authorization:\n\n**Use cases:**\n\n1. **Extend authorization (Klarna)**\n - Provider: `klarna`\n - Purpose: Extend the lifetime of an existing authorization.\n - Required fields:\n - `reason` (string): The reason for the extension.\n - `reference` (string): A reference specified by the merchant to identify the transaction.\n\n2. **Update order amount (Klarna)**\n - Provider: `klarna`\n - Purpose: Update the authorized amount for an existing Klarna order.\n - Required fields:\n - `amount` (number): The new amount to authorize.\n - `items` (array): List of transaction items. Sum of item amounts must equal the updated transaction amount.\n - `description` (string): Optional description of the order.\n - `reason` (string): Optional reason for the update.\n - `reference` (string): Optional merchant reference to identify the transaction.\n\n3. **Update pre-authorization (Dintero PSP)**\n - Provider: `dintero_psp`\n - Purpose: Update the pre-authorized amount and/or finalize the authorization.\n - Required fields:\n - `amount` (number):\n The new amount to authorize.\n - If `final_authorization=false`, the new amount **must be greater than** the previous pre-authorized amount.\n - If `final_authorization=true`, the amount **may be increased, reduced, or unchanged**.\n - `final_authorization` (boolean):\n Indicates whether this is the final authorization step.\n - `true`: Finalizes the authorization and locks the transaction for further updates.\n - `false`: Keeps the pre-authorization open for future updates.\n - `reference` (string): Optional merchant reference to identify the transaction.\n - `items` (array): Optional list of transaction items to update. If the transaction already has items, this field is required. When present, sum of item amounts must equal the updated transaction amount.\n\n4. **Authorize external transaction (Dintero External)**\n - Provider: `dintero`\n - Purpose: Authorize a transaction currently on hold.\n - If `amount` or `items` are provided, the API will validate if the details are consistent with the order in the transaction.\n\n---\n**Notes:**\n- For Klarna:\n - If `amount` is **not provided**: Extend authorization flow is used (use case 1). Only `reason` and `reference` are relevant.\n - If `amount` **is provided**: Update order amount flow is used (use case 2). `amount` is required; `items` and `description` are optional.\n- For pre-authorization: Only `amount`, `final_authorization`, and `reference` are relevant.\n","deprecated":null,"version":null,"sidebarTitle":"Update transaction authorization","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/transactions/{id}/authorization","href":"/payments-v2-api/transactions/transaction_tid_extend_authorization_post"},{"title":"Refund transaction","description":"Once a transaction has been successfully captured,\na refund operation is available. Like other operations,\nrefund can be partial or total\n\n#### Refund Instabank transaction\n\nNote that `items` is required when refunding a transaction\nwith `payment_product=instabank`. The items must include the\nlines to Refund, with `line_id`, `quantity` and `amount`.\n\n#### Refund `seitatech.in_person` transaction\n\n`terminal_id` is required when refunding a `seitatech.in_person`\ntransaction. The cardholder must be present to approve the refund\non a terminal active on the same `payout_destination_id` as the\noriginal transaction.\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Refund transaction","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/transactions/{id}/refund","href":"/payments-v2-api/transactions/transactions_id_refund_post"},{"title":"Void transaction","description":"At any moment before capture of a transaction, it is\npossible to cancel an authorization. This operation is\ncalled voiding and can be performed by doing a POST to\nthis endpoint\n\n#### Void on part capture\n\nVoid after a part capture will cancel the difference between\nthe capture amount and the authorization amount.\n\nVoid on part capture is only supported on following types:\n - `payex.creditcard`\n - `payex.mobilepay`\n - `payex.vipps`\n - `payex.applepay`\n - `payex.clicktopay`\n - `payex.googlepay`\n - `vipps`\n - `klarna.klarna`\n - `klarna.billie`\n\nscopes:\n- admin:checkout\n- write:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Void transaction","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/transactions/{id}/void","href":"/payments-v2-api/transactions/transactions_id_void_post"}]},{"group":"Card Tokens","pages":[{"title":"Get card token","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Get card token","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/card-tokens/{token_id}","href":"/payments-v2-api/card-tokens/card_tokens_token_id_get"},{"title":"Delete card token","description":"scopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"Delete card token","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml delete /accounts/{aid}/payments/card-tokens/{token_id}","href":"/payments-v2-api/card-tokens/card_tokens_token_id_delete"},{"title":"List card tokens","description":"Use query parameters to filter the search. \nTo list all Transactions related to a Card Token, use [GET /v1/transactions](/api-reference/transactions/transactions_get) with query `?search={token_id}`.\n\nscopes:\n- admin:checkout\n","deprecated":null,"version":null,"sidebarTitle":"List card tokens","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/card-tokens","href":"/payments-v2-api/card-tokens/card_tokens_get"}]},{"group":"terminals","pages":[{"title":"List terminal operation results","description":"List administrative operations sent to any of the account's terminals,\nmost recently created first. Filter to a single terminal with\n`terminal_id`, or a single operation with `operation_id`.\n\nPoll this endpoint to see how a command finished: an operation is\ncreated as PENDING and reaches COMPLETED, FAILED or TIMEOUT once the\nterminal answers or the timeout window passes. The `result` of a\ncompleted operation is specific to the operation that was run.\n\nscopes:\n- admin:checkout\n- read:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"List terminal operation results","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/payments/admin/terminals/operations","href":"/payments-v2-api/terminals/admin_terminals_operations_get"},{"title":"Post terminal operation","description":"Send an administrative command to a payment terminal. These commands do not start a payment.\n\nThe response is returned immediately after the command is dispatched to the terminal, with status PENDING. The terminal's response is processed asynchronously. Use [GET /admin/terminals/operations](/api-reference/terminals/admin_terminals_operations_get) to see how the operation finished.\n\nWhile another operation of the same type is pending on the terminal, 409 is returned.\n\nEach operation also requires the terminal to be in a suitable status. The `operation` field below lists the status for each. The request is rejected with 400 when the status does not allow it.\n\nscopes:\n- admin:checkout\n- write:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"Post terminal operation","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/admin/terminals/operations","href":"/payments-v2-api/terminals/admin_terminals_operations_post"},{"title":"Trigger terminal activation","description":"Activate a terminal. Confirms the terminal is reachable and moves it\ninto an active, ready-to-use state. Call this once the terminal has\nbeen physically set up.\n\nscopes:\n- admin:checkout\n- write:checkout:/admin/terminals\n","deprecated":null,"version":null,"sidebarTitle":"Trigger terminal activation","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/payments/admin/terminals/{terminal_id}/activations","href":"/payments-v2-api/terminals/admin_terminals_terminal_id_activations_post"}]},{"group":"settlements","pages":[{"title":"List settlements","description":"List settlements\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"List settlements","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/settlements","href":"/payments-v2-api/settlements/aid_settlements_list"},{"title":"Download attachment","description":"Download a settlement attachment\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Download attachment","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/settlements/{settlementid}/attachments/{attachmentid}","href":"/payments-v2-api/settlements/settlement_attachment_download"},{"title":"Generate a test settlement report","description":"Generate a test settlement report. Only available in test.\n\n*scopes*:\n - admin:billing\n - admin:reports\n","deprecated":null,"version":null,"sidebarTitle":"Generate a test settlement report","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/settlements/reports/generate-test-report","href":"/payments-v2-api/settlements/aid_settlement_generate_test_report"}]},{"group":"settlements.configuration","pages":[{"title":"List settlement report configurations","description":"List settlement report configurations\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"List settlement report configurations","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/settlements/reports/configuration","href":"/payments-v2-api/settlementsconfiguration/aid_settlement_report_config_list"},{"title":"Create settlement report configurations","description":"Create settlement report configurations\n\n*scopes*:\n - admin:billing\n - admin:reports\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Create settlement report configurations","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/settlements/reports/configuration","href":"/payments-v2-api/settlementsconfiguration/aid_settlement_report_config_create"},{"title":"Get settlement report configuration","description":"Get settlement report configuration\n\n*scopes*:\n - admin:billing\n - read:billing\n - admin:reports\n - read:reports\n - admin:settlements\n - read:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Get settlement report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/settlements/reports/configuration/{id}","href":"/payments-v2-api/settlementsconfiguration/aid_settlement_report_config_details"},{"title":"Update settlement report configuration","description":"Update settlement report configuration\n\n*scopes*:\n - admin:billing\n - write:billing\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Update settlement report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml put /accounts/{aid}/settlements/reports/configuration/{id}","href":"/payments-v2-api/settlementsconfiguration/aid_settlement_report_config_update"},{"title":"Delete settlement report configuration","description":"Delete settlement report configuration\n\n*scopes*:\n - admin:billing\n - write:billing\n - admin:settlements\n - write:settlements\n","deprecated":null,"version":null,"sidebarTitle":"Delete settlement report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml delete /accounts/{aid}/settlements/reports/configuration/{id}","href":"/payments-v2-api/settlementsconfiguration/aid_settlement_report_config_delete"}]},{"group":"reports","pages":[{"title":"List report metadata","description":"Get list of report metadata for the account\n\nScopes:\n - read:reports\n - admin:reports\n","deprecated":null,"version":null,"sidebarTitle":"List report metadata","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/reports/metadata","href":"/payments-v2-api/reports/api_reports_metadata_list_get"}]},{"group":"authenticate","pages":[{"title":"Get Token","description":"Use this endpoint to directly request an access_token\n\n### Client Access Token\nUse HTTP Basic authentication scheme for\nauthenticating grant_type `client_credentials`, use\nclient_id/client_secret as user/password.\n\n### Code/Password Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `authorization_code` or `password`, where the\nBearer value must be a JWT toke with access to the token\nendpoint.\n\n### Account User Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `account_user_token`, where the Bearer value\nmust be a account user JWT token.\n\n> Use ID token as Bearer toke if the user was authenticated\n> externally. The ID must include a `email` claim that\n> identifies the account user.\n\n### Refresh Token\nUse HTTP Bearer authentication scheme for authenticating\ngrant_type `refresh_token` where the Bearer value **must**\nbe an Access Token for the clients that was used to create\nthe Refresh Token.\n\n### Multi-factor authentication (MFA)\n\nWhen a request is made to the endpoint to get an access token,\nnormally you either get an error, or you get an access token.\nHowever, when the MFA is enabled, the endpoint may return a new\nerror with `error.code: mfa_required`.\n\nWhen an `mfa_required` error is returned, the client must perform\na `challenge`. This is done by sending a request to the\n[auth/mfa/challenge](/management-auth-api/challenge/aid_auth_mfa_challenge_post) endpoint\n\nTo verify MFA using an OOB challenge, the client must make a request to\nthis endpoint with `grant_type=mfa-oob`. Include the `oob_code` you\nreceived from the challenge response, as well as the `mfa_token` you\nreceived as part of mfa_required error.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/auth/users\n- write:accounts:/auth/users/no-mfa\n","deprecated":null,"version":null,"sidebarTitle":"Get Token","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{oid}/auth/token","href":"/payments-v2-api/authenticate/aid_auths_oauth_token_post"}]},{"group":"approvals","pages":[{"title":"List seller approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List seller approvals","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/payments-v2-api/approvals/aid_management_settings_approvals_payout_destinations_get"},{"title":"New seller approval","description":"Initiate an application for a new seller for Dintero Payout with\nsplit-payment. The application will contain a link to an URL where the\nsignatory of the seller will need to finish submission of the\ncase contract and sign it. Dintero will perform a KYC, AML and bank ownership\ncheck on the seller before the application `case_status`will be\nupdated to `ACTIVE`. Once the application is approved, the payout\ndestination will be added automatically to the Dintero Payout service.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n\n---\n For testing purposes it is possible to auto-approve or decline a new seller by adding one of the following values to `payout_destination_description`:\n\n - \"AUTO_APPROVE\": Approves the case automatically, the case status will be set to `ACTIVE`\n - \"AUTO_DECLINE\": Declines the case automatically, the case status will be set to `DECLINED`\n - \"AUTO_WAITING_FOR_SIGNATURE\": Leaves the signature check for the case, the case status will be set to `WAITING_FOR_SIGNATURE`\n\nNOTE: This behavior is only available in test mode, i.e. with an `aid` prefixed with \"T\".\n\n---\n Dintero admins (access tokens with the `admin:dintero` scope) can replace Dintero's standard terms for sellers with links to custom agreements by supplying `custom_agreements`. A case created with `custom_agreements` is always reviewed manually, it is never approved automatically.\n","deprecated":null,"version":null,"sidebarTitle":"New seller approval","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/management/settings/approvals/payout-destinations","href":"/payments-v2-api/approvals/aid_management_settings_approvals_payout_destinations_post"},{"title":"List payment approvals","description":"\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List payment approvals","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/management/settings/approvals/payments","href":"/payments-v2-api/approvals/aid_management_settings_approvals_payment_get"},{"title":"New payment approval","description":"Initiate an application for using Dintero payments . The application\nwill contain a link to an URL where the signatory of the account will need\nto finish submission of the case contract and sign it. Dintero will perform\na KYC, AML and bank ownership check before the application\n`case_status`will be updated to `ACTIVE`. Once the application is approved\nwe will set up your account for using Dintero payments. Note that not all\npayment methods are available in all countries, and that for some payments\nmethods some processing time must be expected before you can start accepting\npayments.\n\nscopes:\n- admin:accounts\n- write:accounts\n- write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"New payment approval","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/management/settings/approvals/payments","href":"/payments-v2-api/approvals/aid_management_settings_approvals_payment_post"}]},{"group":"payout-destinations","pages":[{"title":"List payout destinations","description":"Get list of payout destinations\n\nscopes:\n - admin:accounts\n - read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List payout destinations","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{oid}/payout-destinations","href":"/payments-v2-api/payout-destinations/aid_mgmnt_payout_destinations_get"},{"title":"Create payout destination","description":"Create a payout destination for an account\n\nDintero admins (access tokens with the `admin:dintero` scope) can replace Dintero's standard terms for sellers with links to custom agreements by supplying `custom_agreements`. A case created with `custom_agreements` is always reviewed manually, it is never approved automatically.\n\nscopes:\n - admin:accounts\n - write:accounts\n - write:accounts:/management/settings/approvals\n","deprecated":null,"version":null,"sidebarTitle":"Create payout destination","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{oid}/payout-destinations","href":"/payments-v2-api/payout-destinations/aid_mgmnt_payout_destinations_post"},{"title":"Get payout destination","description":"Get a payout destination by payout destination id\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get payout destination","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{oid}/payout-destinations/{payout_destination_id}","href":"/payments-v2-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id"},{"title":"Update payout destination","description":"Update a payout destination. Currently only allows update of `payout_interval_type`.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update payout destination","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml patch /accounts/{oid}/payout-destinations/{payout_destination_id}","href":"/payments-v2-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch"},{"title":"On-demand payout","description":"Create a payout for the given payout destination by consolidating all\npending funds from any payout interval account (week, month) into the\ndaily payout account. The funds will then be included in the next daily\npayout run.\n\nThis is useful when you want existing pending payouts to be\ndisbursed without waiting for the original schedule, or when you\nwant to manually trigger a payout outside the normal interval.\n\nscopes:\n - write:accounts:/on-demand-payouts\n","deprecated":null,"version":null,"sidebarTitle":"On-demand payout","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{oid}/payout-destinations/{payout_destination_id}/payouts","href":"/payments-v2-api/payout-destinations/oid_mgmnt_payout_destinations_payouts_post"},{"title":"Fund transfer","description":"Initiate a fund transfer from the current payout destination to another\npayout destination. Currently only same-account fund transfers are\nsupported.\n\nRequests for fund transfers are processed asynchronously, so in the response\nwe only inform you that we received a valid request. You will get the result in\nthe settlement report.\n\nscopes:\n - write:payout\n - admin:payout\n - write:accounts:/fund-transfers\n","deprecated":null,"version":null,"sidebarTitle":"Fund transfer","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{oid}/payout-destinations/{payout_destination_id}/fund-transfers","href":"/payments-v2-api/payout-destinations/oid_mgmnt_payout_destinations_fund-transfers_post"}]},{"group":"account-stores","pages":[{"title":"List stores","description":"Get details about the account stores\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List stores","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/stores","href":"/payments-v2-api/account-stores/aid_account_management_stores_get"},{"title":"Create store","description":"Create a store\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create store","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/stores","href":"/payments-v2-api/account-stores/aid_account_management_stores_post"},{"title":"Store details","description":"Get store details\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Store details","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/stores/{store_id}","href":"/payments-v2-api/account-stores/aid_account_management_stores_sid_get"},{"title":"Update store","description":"Update store properties\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Update store","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml put /accounts/{aid}/stores/{store_id}","href":"/payments-v2-api/account-stores/aid_account_management_stores_sid_put"},{"title":"Delete store","description":"Delete single store. The store's BankAxept (BAX) merchant agreements are deleted too, so their `bax_number` can be used again.\n\nA store that has terminals cannot be deleted. The request fails with `409` and the error code `STORE_HAS_TERMINALS`. Delete the terminals first.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete store","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml delete /accounts/{aid}/stores/{store_id}","href":"/payments-v2-api/account-stores/aid_account_management_stores_sid_delete"}]},{"group":"account-terminals","pages":[{"title":"List terminals","description":"List terminals for the account. Filter by store, payout destination, status, device model, or serial number.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"List terminals","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/terminals","href":"/payments-v2-api/account-terminals/aid_account_management_terminals_get"},{"title":"Create terminal","description":"Register a physical payment terminal and associate it with a store.\n\nFails with `400` `STORE_NOT_ACTIVE` if the store is not `ACTIVE`.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Create terminal","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/terminals","href":"/payments-v2-api/account-terminals/aid_account_management_terminals_post"},{"title":"Terminal details","description":"Get details for a single terminal.\n\nscopes:\n- admin:accounts\n- read:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Terminal details","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/terminals/{terminal_id}","href":"/payments-v2-api/account-terminals/aid_account_management_terminals_termid_get"},{"title":"Delete terminal","description":"Remove a terminal from the account.\n\nRemoving a terminal also starts an `end_of_day` operation on it, to close the terminal's open batch. The operation runs asynchronously and does not block or fail the removal. Its result is available from `GET /v1/accounts/{aid}/payments/admin/terminals/operations?terminal_id={terminal_id}`. A terminal that is turned off or unreachable ends the operation as `TIMEOUT`. No operation is created for a terminal that is not active, for example one still being activated.\n\nscopes:\n- admin:accounts\n- write:accounts\n","deprecated":null,"version":null,"sidebarTitle":"Delete terminal","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml delete /accounts/{aid}/terminals/{terminal_id}","href":"/payments-v2-api/account-terminals/aid_account_management_terminals_termid_delete"}]},{"group":"kpi","pages":[{"title":"List checkout KPIs","description":"Get a list of KPIs where the transactiosn used is in the aggregations are transactions from \"event_created_at_gte\",\nuntil now. However, transactions from the \"current\" interval are not included.\\\nE.g if week is provided as interval, then no transactions from the current week are included. This is true for\nday and month intervals aswell.\n\nScopes:\n - read:insight\n - admin:insight\n**deprecated** 2025-05-20\n","deprecated":null,"version":null,"sidebarTitle":"List checkout KPIs","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/insight/kpi/checkout","href":"/payments-v2-api/kpi/api_insight_checkout_kpis_get"},{"title":"Checkout transaction event KPIs","description":"Get a list of KPIs where the result is the aggregation of the specified\nevent type given provided interval\n\nScopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Checkout transaction event KPIs","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/insight/kpi/checkout-transaction-events","href":"/payments-v2-api/kpi/api_insight_checkout_transactions_events_kpis_get"},{"title":"Checkout transaction status KPIs","description":"Get a list of KPIs where the result is the aggregation of transactions\nwhere that match provided status\n\nScopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Checkout transaction status KPIs","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/insight/kpi/checkout-transaction-status","href":"/payments-v2-api/kpi/api_insight_checkout_transactions_status_kpis_get"}]},{"group":"report-configuration","pages":[{"title":"List insight configurations","description":"List all insight report configurations for the account.\n\nscopes:\n - read:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"List insight configurations","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/insight/reports/configuration","href":"/payments-v2-api/report-configuration/aid_reports_configuration_get"},{"title":"Create new insight report configuration","description":"Create a new report configuration\n\nscopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Create new insight report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /accounts/{aid}/insight/reports/configuration","href":"/payments-v2-api/report-configuration/aid_report_configuration_post"},{"title":"Update insight report configuration","description":"Update insight report configuration.\n\nScopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Update insight report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml put /accounts/{aid}/insight/reports/configuration/{id}","href":"/payments-v2-api/report-configuration/aid_reports_configuration_put"},{"title":"Delete insight report configuration","description":"Delete insight report configuration.\n\nscopes:\n - write:insight\n - admin:insight\n","deprecated":null,"version":null,"sidebarTitle":"Delete insight report configuration","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml delete /accounts/{aid}/insight/reports/configuration/{id}","href":"/payments-v2-api/report-configuration/aid_reports_configuration_delete"}]},{"group":"Generate checkout image","pages":[{"title":"Get payment logos image","description":"Endpoint that returns an svg that can be used to show the world your payment options. [Go to the documentation for the checkout branding endpoints.](/docs/checkout/display-payment-logos)","deprecated":null,"version":null,"sidebarTitle":"Get payment logos image","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /branding/logos/{logos}/variant/{variant}/color/{color}/width/{width}/{template}","href":"/payments-v2-api/generate-checkout-image/branding_logoframe"},{"title":"Get checkout profile image","description":"Endpoint that returns an svg that can be used to show the world your payment options. [Go to the documentation for the checkout branding endpoints.](/docs/checkout/display-payment-logos)","deprecated":null,"version":null,"sidebarTitle":"Get checkout profile image","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /branding/profiles/{profile_id}/variant/{variant}/color/{color}/width/{width}/{template}","href":"/payments-v2-api/generate-checkout-image/branding_profile"}]},{"group":"v2-fund-transfers","pages":[{"title":"Initiate fund transfer","description":"You can use the endpoint to programmatically initiate a fund transfer\nbetween two sellers\n\nRequests for fund transfers are processed asynchronously so in the response,\nwe only inform you that we received your request. You'll get the result in\nthe settlement report\n","deprecated":null,"version":null,"sidebarTitle":"Initiate fund transfer","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml post /v2/accounts/{aid}/payout/fund-transfers","href":"/payments-v2-api/v2-fund-transfers/v2_aid_payout_fund_transfers_post"}]},{"group":"v2-config-payout-destinations","pages":[{"title":"List seller balances","description":"Get seller balance per currency\n","deprecated":null,"version":null,"sidebarTitle":"List seller balances","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/balances","href":"/payments-v2-api/v2-config-payout-destinations/v2_aid_payout_destination_balance_get"},{"title":"List seller transfers","description":"Get list of transfers for a seller\n","deprecated":null,"version":null,"sidebarTitle":"List seller transfers","openapi":"/mintlify-docs/openapi/spec-payments-v2.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/transfers","href":"/payments-v2-api/v2-config-payout-destinations/v2_aid_payout_destination_transfers_get"}]}]}]},{"dropdown":"Payout","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/switch-horizontal.svg","groups":[{"group":"Payout API","pages":[{"group":"admin-bankfile","pages":[{"title":"Get bankfiles","description":"Get bankfiles\n\nFilter identifiers:\n- id\n- proposal_id\n- external_id\n- file_name\n- is_outbound\n- status\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n","deprecated":null,"version":null,"sidebarTitle":"Get bankfiles","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/bankfiles","href":"/payout-api/admin-bankfile/aid_bankfiles_get"},{"title":"Get bankfile","description":"Get bankfile\n","deprecated":null,"version":null,"sidebarTitle":"Get bankfile","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/bankfiles/{bankfile_id}","href":"/payout-api/admin-bankfile/aid_bankfile_get"},{"title":"Get bankfile content","description":"Get bankfile content\n","deprecated":null,"version":null,"sidebarTitle":"Get bankfile content","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/bankfiles/{bankfile_id}/content","href":"/payout-api/admin-bankfile/aid_bankfile_content_get"},{"title":"Lock bankfile","description":"Lock bankfile from further processing.\nFor outbound files, this stops the file from being sent to the bank.\nFor inbound files, this stops the file from being processed.\n","deprecated":null,"version":null,"sidebarTitle":"Lock bankfile","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/bankfiles/{bankfile_id}/lock","href":"/payout-api/admin-bankfile/aid_bankfile_lock_post"},{"title":"Unlock bankfile","description":"Unlock bankfile for further processing.\nFor outbound files, this causes the file to be sent to the bank.\nFor inbound files, this causes the file to be processed.\n","deprecated":null,"version":null,"sidebarTitle":"Unlock bankfile","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/bankfiles/{bankfile_id}/unlock","href":"/payout-api/admin-bankfile/aid_bankfile_unlock_post"},{"title":"Get payment events","description":"Get payment events\n\nFilter identifiers:\n- id\n- account_id\n- proposal_id\n- proposal_item_id\n- original_message_id\n- message_id\n- group_id\n- transaction_id\n- iso_type\n- type\n- is_rejection\n- message\n- file_id\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n","deprecated":null,"version":null,"sidebarTitle":"Get payment events","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/payment-events","href":"/payout-api/admin-bankfile/aid_payment_events_get"},{"title":"Get payments","description":"Get payments\n\nFilter identifiers:\n- id\n- account_id\n- proposal_id\n- proposal_item_id\n- file_id\n- is_outbound\n- payment_id\n- message_id\n- group_id\n- e2e_id\n- paid_at\n- sender_name\n- sender_country\n- sender_bank_account_number\n- sender_bank_account_type\n- sender_bank_account_bic\n- receiver_name\n- receiver_country\n- receiver_bank_account_number\n- receiver_bank_account_type\n- receiver_bank_account_bic\n- message\n- tx_amount\n- tx_currency\n- instructed_amount\n- instructed_currency\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n","deprecated":null,"version":null,"sidebarTitle":"Get payments","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/payments","href":"/payout-api/admin-bankfile/aid_payments_get"},{"title":"Get payment","description":"Get payment\n","deprecated":null,"version":null,"sidebarTitle":"Get payment","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/payments/{payment_id}","href":"/payout-api/admin-bankfile/aid_payment_get"}]},{"group":"admin-block-rule","pages":[{"title":"Test block rule target","description":"Test if target is blocked by active block rules\n","deprecated":null,"version":null,"sidebarTitle":"Test block rule target","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/block-rules-test","href":"/payout-api/admin-block-rule/aid_admin_block_rule_test"},{"title":"Get block rules","description":"Get block rules\n","deprecated":null,"version":null,"sidebarTitle":"Get block rules","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/block-rules","href":"/payout-api/admin-block-rule/aid_admin_block_rules_get"},{"title":"Post a block rule","description":"Post a block rule\n","deprecated":null,"version":null,"sidebarTitle":"Post a block rule","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/block-rules","href":"/payout-api/admin-block-rule/aid_admin_block_rule_post"},{"title":"Get block rule by id","description":"Get block rule by id\n","deprecated":null,"version":null,"sidebarTitle":"Get block rule by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/block-rules/{block_rule_id}","href":"/payout-api/admin-block-rule/aid_admin_block_rule_get"},{"title":"Delete block rule by id","description":"Delete block rule by id\n","deprecated":null,"version":null,"sidebarTitle":"Delete block rule by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/admin/block-rules/{block_rule_id}","href":"/payout-api/admin-block-rule/aid_admin_block_rule_delete"},{"title":"Update a block rule","description":"Update a block rule\n","deprecated":null,"version":null,"sidebarTitle":"Update a block rule","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/admin/block-rules/{block_rule_id}","href":"/payout-api/admin-block-rule/aid_admin_block_rule_patch"}]},{"group":"admin-config-rfcs","pages":[{"title":"Get config rfcs","description":"Get config rfcs\n","deprecated":null,"version":null,"sidebarTitle":"Get config rfcs","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/config-rfcs","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfcs_get"},{"title":"Get config rfc by id","description":"Get config rfc by id\n","deprecated":null,"version":null,"sidebarTitle":"Get config rfc by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/config-rfcs/{config_rfc_id}","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfc_get"},{"title":"Replace config RFC data","description":"Replace config RFC data. RFC cannot be approved/rejected.\n","deprecated":null,"version":null,"sidebarTitle":"Replace config RFC data","openapi":"/mintlify-docs/openapi/spec-payout.yaml put /v1/accounts/{aid}/payout/admin/config-rfcs/{config_rfc_id}","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfc_put"},{"title":"Delete config RFC by id","description":"Delete config RFC by id\n","deprecated":null,"version":null,"sidebarTitle":"Delete config RFC by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/admin/config-rfcs/{config_rfc_id}","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfc_delete"},{"title":"Approve RFC","description":"Approve RFC\n\nscopes:\n- `admin:payout:/admin write:payout:/admin/config_rfc_approval`\n","deprecated":null,"version":null,"sidebarTitle":"Approve RFC","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/config-rfcs/{config_rfc_id}/approve","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfc_approve"},{"title":"Reject RFC","description":"Reject RFC\n\nscopes:\n- `admin:payout:/admin write:payout:/admin/config_rfc_approval`\n","deprecated":null,"version":null,"sidebarTitle":"Reject RFC","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/config-rfcs/{config_rfc_id}/reject","href":"/payout-api/admin-config-rfcs/aid_admin_config_rfc_reject"}]},{"group":"admin-config","pages":[{"title":"Get dintero config","description":"Get dintero global config\n","deprecated":null,"version":null,"sidebarTitle":"Get dintero config","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/config","href":"/payout-api/admin-config/aid_admin_config_get"},{"title":"Update dintero config","description":"Update dintero config\n","deprecated":null,"version":null,"sidebarTitle":"Update dintero config","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/admin/config","href":"/payout-api/admin-config/aid_admin_config_patch"}]},{"group":"admin-config-bank-accounts","pages":[{"title":"Get dintero bank account balance estimates","description":"Get dintero bank account balance estimates\n","deprecated":null,"version":null,"sidebarTitle":"Get dintero bank account balance estimates","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/dintero-bank-account-balance-estimates","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_balance_estimates_get"},{"title":"Get dintero bank account balances","description":"Get dintero bank account balances\n","deprecated":null,"version":null,"sidebarTitle":"Get dintero bank account balances","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/dintero-bank-account-balances","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_balances_get"},{"title":"Post dintero bank account balance","description":"Post dintero bank account balance\n","deprecated":null,"version":null,"sidebarTitle":"Post dintero bank account balance","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/dintero-bank-account-balances","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_balances_post"},{"title":"Delete dintero bank account balance","description":"(soft) Delete dintero bank account balance\n","deprecated":null,"version":null,"sidebarTitle":"Delete dintero bank account balance","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/admin/dintero-bank-account-balances/{dintero_bank_account_balance_id}","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_balance_delete"},{"title":"Get dintero bank accounts","description":"Get dintero bank accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get dintero bank accounts","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/dintero-bank-accounts","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_accounts_get"},{"title":"Post dintero bank account","description":"Post dintero bank account\n","deprecated":null,"version":null,"sidebarTitle":"Post dintero bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/dintero-bank-accounts","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_accounts_post"},{"title":"Delete dintero bank account","description":"(soft) Delete dintero bank account\n","deprecated":null,"version":null,"sidebarTitle":"Delete dintero bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/admin/dintero-bank-accounts/{dintero_bank_account_id}","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_delete"},{"title":"Patch dintero bank account","description":"Patch dintero bank account\n","deprecated":null,"version":null,"sidebarTitle":"Patch dintero bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/admin/dintero-bank-accounts/{dintero_bank_account_id}","href":"/payout-api/admin-config-bank-accounts/aid_admin_dintero_bank_account_patch"}]},{"group":"admin-ledger","pages":[{"title":"Get ledger accounts","description":"Get ledger accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get ledger accounts","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/ledger-accounts","href":"/payout-api/admin-ledger/aid_ledger_accounts_get"},{"title":"Post ledger correction","description":"Post ledger correction\n","deprecated":null,"version":null,"sidebarTitle":"Post ledger correction","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/ledger-corrections","href":"/payout-api/admin-ledger/aid_ledger_corrections_post"},{"title":"Get ledger entries","description":"Get ledger entries.\n\nFilter identifiers:\n- id\n- account_id\n- ledger_bundle_id\n- ledger_account_number\n- ledger_link_id\n- proposal_id\n- proposal_item_id\n- link_open\n- payout_destination_id\n- amount\n- currency\n- source\n- posted_at\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n","deprecated":null,"version":null,"sidebarTitle":"Get ledger entries","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/ledger-entries","href":"/payout-api/admin-ledger/aid_ledger_entries_get"},{"title":"Get ledger entry","description":"Get ledger entry\n","deprecated":null,"version":null,"sidebarTitle":"Get ledger entry","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/ledger-entries/{entry_id}","href":"/payout-api/admin-ledger/aid_ledger_entry_get"},{"title":"Post manual ledger match","description":"Post manual ledger match\n","deprecated":null,"version":null,"sidebarTitle":"Post manual ledger match","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/ledger-matches","href":"/payout-api/admin-ledger/aid_ledger_match_post"}]},{"group":"admin-config-merchants","pages":[{"title":"Get payout merchants","description":"Get payout merchant configurations\n","deprecated":null,"version":null,"sidebarTitle":"Get payout merchants","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/merchants","href":"/payout-api/admin-config-merchants/aid_admin_merchants_get"},{"title":"Get payout merchant by merchant accountId","description":"Get payout merchant configuration by merchant accountId.\nReturns all sellers, bank accounts, rfcs and block-rule hits for the merchant.\n","deprecated":null,"version":null,"sidebarTitle":"Get payout merchant by merchant accountId","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/merchants/{merchant_account_id}","href":"/payout-api/admin-config-merchants/aid_admin_merchant_get"},{"title":"Patch payout merchant config by merchant accountId","description":"Patch payout merchant configuration by merchant accountId.\nReturns configuration for the merchant after patch.\n","deprecated":null,"version":null,"sidebarTitle":"Patch payout merchant config by merchant accountId","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/admin/merchants/{merchant_account_id}/config","href":"/payout-api/admin-config-merchants/aid_admin_merchant_config_patch"},{"title":"Patch Seller by merchant accountId","description":"Patch merchant Seller (payout destination) config by merchant accountId. Returns the Seller config after patch\n","deprecated":null,"version":null,"sidebarTitle":"Patch Seller by merchant accountId","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/admin/merchants/{merchant_account_id}/payout_destinations/{payout_destination_config_id}","href":"/payout-api/admin-config-merchants/aid_admin_merchant_payout_destination_patch"}]},{"group":"admin-proposal","pages":[{"title":"Get proposal items","description":"Get list of proposal items based on search query\n\nFilter identifiers:\n- id\n- status\n- e2e_id\n- proposal_id\n- account_id\n- payout_destination_id\n- config_bank_account_id\n- amount\n- currency\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n- amount\n- status\n","deprecated":null,"version":null,"sidebarTitle":"Get proposal items","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/proposal-items","href":"/payout-api/admin-proposal/aid_admin_proposal_items_get"},{"title":"Approve / undo rejections of proposal item","description":"Approve / undo rejections a single proposal item\n","deprecated":null,"version":null,"sidebarTitle":"Approve / undo rejections of proposal item","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposal-items/{proposal_item_id}/approve","href":"/payout-api/admin-proposal/aid_admin_proposal_item_approve"},{"title":"Proposal item details / report","description":"Proposal item details / report\n","deprecated":null,"version":null,"sidebarTitle":"Proposal item details / report","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/proposal-items/{proposal_item_id}/details","href":"/payout-api/admin-proposal/aid_admin_proposal_item_details"},{"title":"Reject proposal item","description":"Reject a single proposal item\n","deprecated":null,"version":null,"sidebarTitle":"Reject proposal item","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposal-items/{proposal_item_id}/reject","href":"/payout-api/admin-proposal/aid_admin_proposal_item_reject"},{"title":"Fail proposal item","description":"Fail a single proposal item\n","deprecated":null,"version":null,"sidebarTitle":"Fail proposal item","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposal-items/{proposal_item_id}/fail","href":"/payout-api/admin-proposal/aid_admin_proposal_item_fail"},{"title":"Generate proposals","description":"Generate proposals\n","deprecated":null,"version":null,"sidebarTitle":"Generate proposals","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/generate-proposals","href":"/payout-api/admin-proposal/aid_admin_proposals_generate"},{"title":"Get proposals","description":"Get list of proposals based on search query\n\nFilter identifiers:\n- id\n- status\n- e2e_id\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n","deprecated":null,"version":null,"sidebarTitle":"Get proposals","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/proposals","href":"/payout-api/admin-proposal/aid_admin_proposals_get"},{"title":"Get a proposal","description":"Get a single proposal by id\n","deprecated":null,"version":null,"sidebarTitle":"Get a proposal","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/proposals/{proposal_id}","href":"/payout-api/admin-proposal/aid_admin_proposal_get"},{"title":"Approve proposal","description":"Approve a proposal\n","deprecated":null,"version":null,"sidebarTitle":"Approve proposal","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposals/{proposal_id}/approve","href":"/payout-api/admin-proposal/aid_admin_proposal_approve"},{"title":"Reject proposal","description":"Reject a proposal\n","deprecated":null,"version":null,"sidebarTitle":"Reject proposal","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposals/{proposal_id}/reject","href":"/payout-api/admin-proposal/aid_admin_proposal_reject"},{"title":"Sync status from items","description":"Sync status from items\n","deprecated":null,"version":null,"sidebarTitle":"Sync status from items","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/proposals/{proposal_id}/sync-status-from-items","href":"/payout-api/admin-proposal/aid_admin_proposal_sync_status_from_items_post"}]},{"group":"admin-settlement","pages":[{"title":"Get settlements processed for payout","description":"Get list of settlements processed for payout based on search query\n\nFilter identifiers:\n- account_id\n- payment_provider\n- payment_provider_reference\n- settlement_id\n- status\n- status_text\n- created_at\n- updated_at\n\nSort identifiers:\n- created_at\n- updated_at\n- status\n","deprecated":null,"version":null,"sidebarTitle":"Get settlements processed for payout","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/settlements","href":"/payout-api/admin-settlement/aid_admin_settlements_get"},{"title":"Get a settlement processed for payout","description":"Get a single settlement processed for payout by id\n","deprecated":null,"version":null,"sidebarTitle":"Get a settlement processed for payout","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/admin/settlements/{settlement_id}","href":"/payout-api/admin-settlement/aid_admin_settlement_get"},{"title":"Reject settlement","description":"Reject a settlement, preventing it from automatic retries.\n","deprecated":null,"version":null,"sidebarTitle":"Reject settlement","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/settlements/{settlement_id}/reject","href":"/payout-api/admin-settlement/aid_admin_settlement_reject"},{"title":"Retry settlement","description":"Flag a settlement for automatic retry\n","deprecated":null,"version":null,"sidebarTitle":"Retry settlement","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/admin/settlements/{settlement_id}/retry","href":"/payout-api/admin-settlement/aid_admin_settlement_retry"}]},{"group":"config-account-payout-destination-links","pages":[{"title":"Get links between bank account and seller","description":"Get links between bank account and seller |\nand the associated config\n","deprecated":null,"version":null,"sidebarTitle":"Get links between bank account and seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/bank-account-payout-destinations","href":"/payout-api/config-account-payout-destination-links/aid_config_bank_account_payout_destinations_get"},{"title":"Link bank account with seller, and add config for the link","description":"Link bank account with seller, and add config for the link\n","deprecated":null,"version":null,"sidebarTitle":"Link bank account with seller, and add config for the link","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/bank-account-payout-destinations","href":"/payout-api/config-account-payout-destination-links/aid_config_bank_account_payout_destinations_post"},{"title":"Get single link between bank account and seller","description":"Get single link between bank account and seller\n","deprecated":null,"version":null,"sidebarTitle":"Get single link between bank account and seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/bank-account-payout-destinations/{config_bank_account_payout_destination_id}","href":"/payout-api/config-account-payout-destination-links/aid_config_bank_account_payout_destination_get"},{"title":"Delete link between bank account and seller","description":"Delete link between bank account and seller\n","deprecated":null,"version":null,"sidebarTitle":"Delete link between bank account and seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/bank-account-payout-destinations/{config_bank_account_payout_destination_id}","href":"/payout-api/config-account-payout-destination-links/aid_config_bank_account_payout_destination_delete"},{"title":"Update link between bank account seller","description":"Update link between bank account seller\n","deprecated":null,"version":null,"sidebarTitle":"Update link between bank account seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/bank-account-payout-destinations/{config_bank_account_payout_destination_id}","href":"/payout-api/config-account-payout-destination-links/aid_config_bank_account_payout_destination_patch"}]},{"group":"config-bank-accounts","pages":[{"title":"Get bank accounts","description":"Get bank accounts\n","deprecated":null,"version":null,"sidebarTitle":"Get bank accounts","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/bank-accounts","href":"/payout-api/config-bank-accounts/aid_config_bank_accounts_get"},{"title":"Get single bank account","description":"Get single bank account\n","deprecated":null,"version":null,"sidebarTitle":"Get single bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/bank-accounts/{config_bank_account_id}","href":"/payout-api/config-bank-accounts/aid_config_bank_account_get"},{"title":"Delete bank account","description":"Delete bank account\n","deprecated":null,"version":null,"sidebarTitle":"Delete bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/bank-accounts/{config_bank_account_id}","href":"/payout-api/config-bank-accounts/aid_config_bank_account_delete"},{"title":"Update bank account","description":"Update bank account\n","deprecated":null,"version":null,"sidebarTitle":"Update bank account","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/bank-accounts/{config_bank_account_id}","href":"/payout-api/config-bank-accounts/aid_config_bank_account_patch"}]},{"group":"config-rfcs","pages":[{"title":"Get config rfcs","description":"Get config rfcs\n","deprecated":null,"version":null,"sidebarTitle":"Get config rfcs","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/config-rfcs","href":"/payout-api/config-rfcs/aid_config_rfcs_get"},{"title":"Post a config RFC","description":"Post a config RFC\n","deprecated":null,"version":null,"sidebarTitle":"Post a config RFC","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/config-rfcs","href":"/payout-api/config-rfcs/aid_config_rfc__post"},{"title":"Get config rfc by id","description":"Get config rfc by id\n","deprecated":null,"version":null,"sidebarTitle":"Get config rfc by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/config-rfcs/{config_rfc_id}","href":"/payout-api/config-rfcs/aid_config_rfc_get"},{"title":"Replace config RFC data","description":"Replace config RFC data. RFC cannot be approved/rejected.\n","deprecated":null,"version":null,"sidebarTitle":"Replace config RFC data","openapi":"/mintlify-docs/openapi/spec-payout.yaml put /v1/accounts/{aid}/payout/config-rfcs/{config_rfc_id}","href":"/payout-api/config-rfcs/aid_config_rfc_put"},{"title":"Delete config RFC by id","description":"Delete config RFC by id\n","deprecated":null,"version":null,"sidebarTitle":"Delete config RFC by id","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/config-rfcs/{config_rfc_id}","href":"/payout-api/config-rfcs/aid_config_rfc_delete"}]},{"group":"config","pages":[{"title":"Get config","description":"Get config\n","deprecated":null,"version":null,"sidebarTitle":"Get config","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/config","href":"/payout-api/config/aid_config_get"},{"title":"Update config","description":"Update config\n","deprecated":null,"version":null,"sidebarTitle":"Update config","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/config","href":"/payout-api/config/aid_config_patch"}]},{"group":"fund-transfers","pages":[{"title":"Initiate fund transfer","description":"You can use the endpoint to programmatically initiate a fund transfer\nbetween two sellers\n\nRequests for fund transfers are processed asynchronously so in the response,\nwe only inform you that we received your request. You'll get the result in\nthe settlement report\n","deprecated":null,"version":null,"sidebarTitle":"Initiate fund transfer","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/fund-transfers","href":"/payout-api/fund-transfers/aid_payout_fund_transfers_post"}]},{"group":"config-payout-destinations","pages":[{"title":"Get sellers","description":"Get sellers\n","deprecated":null,"version":null,"sidebarTitle":"Get sellers","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/payout-destinations","href":"/payout-api/config-payout-destinations/aid_payout_destination_configs_get"},{"title":"Add a seller","description":"Add a seller\n","deprecated":null,"version":null,"sidebarTitle":"Add a seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v1/accounts/{aid}/payout/payout-destinations","href":"/payout-api/config-payout-destinations/aid_payout_destination_configs_post"},{"title":"Get seller config","description":"Get seller config\n","deprecated":null,"version":null,"sidebarTitle":"Get seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/payout-destinations/{payout_destination_config_id}","href":"/payout-api/config-payout-destinations/aid_payout_destination_config_get"},{"title":"Delete seller config","description":"Delete seller config\n","deprecated":null,"version":null,"sidebarTitle":"Delete seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v1/accounts/{aid}/payout/payout-destinations/{payout_destination_config_id}","href":"/payout-api/config-payout-destinations/aid_config_payout_destination_config_delete"},{"title":"Update seller config","description":"Update seller config\n","deprecated":null,"version":null,"sidebarTitle":"Update seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v1/accounts/{aid}/payout/payout-destinations/{payout_destination_config_id}","href":"/payout-api/config-payout-destinations/aid_payout_destination_config_patch"},{"title":"List seller balances","description":"Get seller balance per currency\n","deprecated":null,"version":null,"sidebarTitle":"List seller balances","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/payout-destinations/{payout_destination_config_id}/balances","href":"/payout-api/config-payout-destinations/aid_payout_destination_balance_get"},{"title":"Get seller transfers","description":"Get list of transfers for a seller\n","deprecated":null,"version":null,"sidebarTitle":"Get seller transfers","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/payout-destinations/{payout_destination_config_id}/transfers","href":"/payout-api/config-payout-destinations/aid_payout_destination_transfers_get"}]},{"group":"report","pages":[{"title":"Get report preview","description":"Get a preview of the next proposed payment report\n","deprecated":null,"version":null,"sidebarTitle":"Get report preview","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v1/accounts/{aid}/payout/report-preview","href":"/payout-api/report/aid_report_preview_get"}]},{"group":"v2-fund-transfers","pages":[{"title":"Initiate fund transfer","description":"You can use the endpoint to programmatically initiate a fund transfer\nbetween two sellers\n\nRequests for fund transfers are processed asynchronously so in the response,\nwe only inform you that we received your request. You'll get the result in\nthe settlement report\n","deprecated":null,"version":null,"sidebarTitle":"Initiate fund transfer","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v2/accounts/{aid}/payout/fund-transfers","href":"/payout-api/v2-fund-transfers/v2_aid_payout_fund_transfers_post"}]},{"group":"v2-config-payout-destinations","pages":[{"title":"Get sellers","description":"Get sellers\n","deprecated":null,"version":null,"sidebarTitle":"Get sellers","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/payout-destinations","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_configs_get"},{"title":"Add a seller","description":"Add a seller\n","deprecated":null,"version":null,"sidebarTitle":"Add a seller","openapi":"/mintlify-docs/openapi/spec-payout.yaml post /v2/accounts/{aid}/payout/payout-destinations","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_configs_post"},{"title":"Get seller config","description":"Get seller config\n","deprecated":null,"version":null,"sidebarTitle":"Get seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_config_get"},{"title":"Delete seller config","description":"Delete seller config\n","deprecated":null,"version":null,"sidebarTitle":"Delete seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml delete /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}","href":"/payout-api/v2-config-payout-destinations/v2_aid_config_payout_destination_config_delete"},{"title":"Update seller config","description":"Update seller config\n","deprecated":null,"version":null,"sidebarTitle":"Update seller config","openapi":"/mintlify-docs/openapi/spec-payout.yaml patch /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_config_patch"},{"title":"List seller balances","description":"Get seller balance per currency\n","deprecated":null,"version":null,"sidebarTitle":"List seller balances","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/balances","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_balance_get"},{"title":"List seller transfers","description":"Get list of transfers for a seller\n","deprecated":null,"version":null,"sidebarTitle":"List seller transfers","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/transfers","href":"/payout-api/v2-config-payout-destinations/v2_aid_payout_destination_transfers_get"}]},{"group":"v2-admin-ledger","pages":[{"title":"Get unpaid debt","description":"List unpaid debt grouped by account and payout destination.\n","deprecated":null,"version":null,"sidebarTitle":"Get unpaid debt","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/admin/ledger-unpaid-debt","href":"/payout-api/v2-admin-ledger/v2_aid_admin_unpaid_debt_get"}]},{"group":"v2-retained-transactions","pages":[{"title":"Get retained transactions","description":"Get retained transactions for a payout destination. A retained transactions\nis on hold and will not be payed untill explicitly released.\n","deprecated":null,"version":null,"sidebarTitle":"Get retained transactions","openapi":"/mintlify-docs/openapi/spec-payout.yaml get /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/retained-transactions","href":"/payout-api/v2-retained-transactions/v2_aid_payout_destination_retained_get"},{"title":"Release a retained transaction","description":"Release a retained transaction. The transaction will be part of the next\nscheduled payout.\n","deprecated":null,"version":null,"sidebarTitle":"Release a retained transaction","openapi":"/mintlify-docs/openapi/spec-payout.yaml put /v2/accounts/{aid}/payout/payout-destinations/{payout_destination_id}/retained-transactions/{payout_event_correlation_id}/release","href":"/payout-api/v2-retained-transactions/v2_aid_payout_destination_retained_release_put"}]}]}]},{"dropdown":"Products","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/archive.svg","groups":[{"group":"Products API","pages":[{"group":"catalogs","pages":[{"title":"Catalogs collection","description":"Get catalogs from account based on query parameters\n\nscopes:\n - admin:products\n - write:products\n - read:products\n","deprecated":null,"version":null,"sidebarTitle":"Catalogs collection","openapi":"/mintlify-docs/openapi/spec-products.yaml get /accounts/{aid}/products/catalogs","href":"/products-api/catalogs/aid_catalogs_get"},{"title":"Create new catalog","description":"Create a new product catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Create new catalog","openapi":"/mintlify-docs/openapi/spec-products.yaml post /accounts/{aid}/products/catalogs","href":"/products-api/catalogs/aid_catalogs_post"},{"title":"Update catalog","description":"Update an existing catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Update catalog","openapi":"/mintlify-docs/openapi/spec-products.yaml put /accounts/{aid}/products/catalogs/{catalog_id}","href":"/products-api/catalogs/aid_catalogs_put"},{"title":"Delete catalog","description":"Delete catalog and all corresponding products\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Delete catalog","openapi":"/mintlify-docs/openapi/spec-products.yaml delete /accounts/{aid}/products/catalogs/{catalog_id}","href":"/products-api/catalogs/aid_catalogs_delete"}]},{"group":"products","pages":[{"title":"Products collection","description":"Get products in a catalog based on query parameters\n\nscopes:\n - admin:products\n - write:products\n - read:products\n","deprecated":null,"version":null,"sidebarTitle":"Products collection","openapi":"/mintlify-docs/openapi/spec-products.yaml get /accounts/{aid}/products/catalogs/{catalog_id}/products","href":"/products-api/products/aid_products_get"},{"title":"Create new product","description":"Create a new product\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Create new product","openapi":"/mintlify-docs/openapi/spec-products.yaml post /accounts/{aid}/products/catalogs/{catalog_id}/products","href":"/products-api/products/aid_products_post"},{"title":"Update product","description":"Update an existing product\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Update product","openapi":"/mintlify-docs/openapi/spec-products.yaml put /accounts/{aid}/products/catalogs/{catalog_id}/products/{product_id}","href":"/products-api/products/aid_products_put"},{"title":"Delete product","description":"Delete product in a given catalog\n\nscopes:\n - admin:products\n - write:products\n","deprecated":null,"version":null,"sidebarTitle":"Delete product","openapi":"/mintlify-docs/openapi/spec-products.yaml delete /accounts/{aid}/products/catalogs/{catalog_id}/products/{product_id}","href":"/products-api/products/aid_catalog_id_product_delete"}]},{"group":"groups","pages":[{"title":"Group collection","description":"Lists all groups\n","deprecated":null,"version":null,"sidebarTitle":"Group collection","openapi":"/mintlify-docs/openapi/spec-products.yaml get /accounts/{aid}/products/groups","href":"/products-api/groups/aid_group_get"},{"title":"Create new group","description":"Insert a new group\n","deprecated":null,"version":null,"sidebarTitle":"Create new group","openapi":"/mintlify-docs/openapi/spec-products.yaml post /accounts/{aid}/products/groups","href":"/products-api/groups/aid_group_post"},{"title":"Update group","description":"Update an existing group\n","deprecated":null,"version":null,"sidebarTitle":"Update group","openapi":"/mintlify-docs/openapi/spec-products.yaml put /accounts/{aid}/products/groups/{group_id}","href":"/products-api/groups/aid_group_put"},{"title":"Delete group","description":"Delete an existing group\n","deprecated":null,"version":null,"sidebarTitle":"Delete group","openapi":"/mintlify-docs/openapi/spec-products.yaml delete /accounts/{aid}/products/groups/{group_id}","href":"/products-api/groups/aid_delete"}]},{"group":"tax","pages":[{"title":"Taxgroup collection","description":"Lists all taxgroups\n","deprecated":null,"version":null,"sidebarTitle":"Taxgroup collection","openapi":"/mintlify-docs/openapi/spec-products.yaml get /accounts/{aid}/products/tax","href":"/products-api/tax/aid_tax_get"},{"title":"Create new taxgroup","description":"Insert a new taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Create new taxgroup","openapi":"/mintlify-docs/openapi/spec-products.yaml post /accounts/{aid}/products/tax","href":"/products-api/tax/aid_tax_post"},{"title":"Update taxgroup","description":"Update an existing taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Update taxgroup","openapi":"/mintlify-docs/openapi/spec-products.yaml put /accounts/{aid}/products/tax/{tax_id}","href":"/products-api/tax/aid_tax_put"},{"title":"Delete taxgroup","description":"Delete an existing taxgroup\n","deprecated":null,"version":null,"sidebarTitle":"Delete taxgroup","openapi":"/mintlify-docs/openapi/spec-products.yaml delete /accounts/{aid}/products/tax/{tax_id}","href":"/products-api/tax/aid_tax_delete"}]}]}]},{"dropdown":"PSP","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/server.svg","groups":[{"group":"PSP API","pages":[{"group":"encryption","pages":[{"title":"Get public keys","description":"Keys used for encrypted sensitive card data","deprecated":null,"version":null,"sidebarTitle":"Get public keys","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /keys/v1","href":"/psp-api/encryption/encryptionget_public_keys"}]},{"group":"payment","pages":[{"title":"Post Payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Post Payment","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /payments/v1/{account_id}","href":"/psp-api/payment/paymentpost_payment"},{"title":"Get Payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get Payment","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /payments/v1/{account_id}/{payment_id}","href":"/psp-api/payment/paymentget_payment"},{"title":"Cancel Payment","description":"Cancel the payment. This prevents new transactions from being added to the payment.","deprecated":null,"version":null,"sidebarTitle":"Cancel Payment","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /payments/v1/{account_id}/{payment_id}/cancel","href":"/psp-api/payment/paymentcancel_payment"}]},{"group":"transaction","pages":[{"title":"Get Transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /transactions/v1/{account_id}/{transaction_id}","href":"/psp-api/transaction/transactionget_transaction"},{"title":"Post Authorization","description":"Authorize the full transaction amount. Not supported for Vipps transactions.","deprecated":null,"version":null,"sidebarTitle":"Post Authorization","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/authorization","href":"/psp-api/transaction/transactionpost_authorization"},{"title":"Post Void","description":"Reverses any open authorizations, and cancels the transaction (prevents new authorizations). If the transaction is already captured, void has no effect except to prevent new authorizations (if applicable).\n\nWith `void_type` `release`, the authorized amount is released without cancelling the transaction. Use `authorization_operation_ref` to select which authorization to release.","deprecated":null,"version":null,"sidebarTitle":"Post Void","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/void","href":"/psp-api/transaction/transactionpost_void"},{"title":"Post Capture","description":"Captures the specified amount. If there were multiple authorizations on this transaction, the capture may be split across those.","deprecated":null,"version":null,"sidebarTitle":"Post Capture","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/capture","href":"/psp-api/transaction/transactionpost_capture"},{"title":"Post Refund","description":"Refunds the specified amount. If there exists multiple captures, the refund may be split across those.","deprecated":null,"version":null,"sidebarTitle":"Post Refund","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/refund","href":"/psp-api/transaction/transactionpost_refund"},{"title":"Post Token Transaction","description":"Create transaction for unscheduled or recurring payment. Will automatically try to authorize payment. \u003cbr> \u003cbr> If the payment was created with `configuration.pre_authorization = true`, the authorization will be an initial pre-authorization, which requires subsequent call(s) to [POST /transactions/v1/{account_id}/{transaction_id}/authorization](/psp-api/transaction/transactionPost_Authorization) to finalize the authorization before it can be captured.","deprecated":null,"version":null,"sidebarTitle":"Post Token Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /tokens/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/transaction/cardpost_token_transaction"},{"title":"Post Transfer Authorization","description":"Finalize a transfer, pushing the funds to the recipient. Must be\ncalled after any required strong customer authentication (3-D Secure\nor Mastercard TAF) has completed.\n","deprecated":null,"version":null,"sidebarTitle":"Post Transfer Authorization","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transfer/v1/{account_id}/payments/{payment_id}/transactions/{transaction_id}/authorization","href":"/psp-api/transaction/transferpost_transfer_authorization"}]},{"group":"3-D Secure","pages":[{"title":"Post 3-D Secure Init","description":"This endpoint is used to initiate a 3-D Secure transaction. Note that this endpoint is a form post and not a JSON post. The reason being that we need to send the request Accept headers to 3Dsecure.io. The response will be a 302 redirect to our postback page. (The postback page will also be used in the redirect from the notificationURL used in the method and challenge flows).\n\nThe SDK form posts to the psp-service, the psp-service then does a preuaht request towards the 3D Secure server. The 3D Secure server then responds with a redirect to the notificationURL that redirects to the postback page so the SDK can retive the 3D Secure pre-auth result.\n\nIf the result is a `SECURE_3D_METHOD_REQUIRED` response the SDK will do a form post to the ACS with the 3D Secure method data. The ACS will then respond with a redirect to the notificationURL that redirects to the postback page so the SDK can retrieve the 3D Secure method result. The SDK will then do a form post to the psp-service with the [3D Secure method result](/psp-api/3-d-secure/3D-securePost_3D_Secure_Method).\n\nIf the result is a `SECURE_3D_CHALLENGE_REQUIRED` response the SDK will do a form post to the ACS with the 3D Secure challenge data. The ACS will then respond with a redirect to the notificationURL that redirects to the postback page so the SDK can retrieve the 3D Secure challenge result. The SDK will then do a form post to the psp-service with the [3D Secure challenge result](/psp-api/3-d-secure/3D-securePost_3D_Secure_Challenge).\n\nIf the result is with a `SECURE_3D_COMPLETE` response the SDK will notify the checkout-frontend of the result and the checkout-frontend will then make the payment request to the checkout-service. The checkout-service in turn checks the transaction status with the psp-service and update the transaction status in the checkout-service.","deprecated":null,"version":null,"sidebarTitle":"Post 3-D Secure Init","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/3d-secure-init","href":"/psp-api/3-d-secure/3d-securepost_3d_secure_init"},{"title":"Post 3-D Secure Method","description":"\nThis endpoint is used to complete method fingerprinting of the 3-D Secure transaction. Note that this endpoint is a form post and not a JSON post. The reason being that we need to send the request Accept headers to 3Dsecure.io. The response will be a 302 redirect to our postback page. (The postback page will also be used in the redirect from the notification_url used in the method and challenge flows).\n\nThis endpoint is called after the ACS has form posted to the notification url with the threeDSMethodData (method result). The notification url will redirect to the postback page where the SDK will retrieve the method result and post the values encoded in the threeDSMethodData to the psp-service (this endpoint).\n\nIf the result is a `SECURE_3D_CHALLENGE_REQUIRED` response the SDK will do a form post to the ACS with the 3D Secure challenge data. The ACS will then respond with a redirect to the notificationURL that redirects to the postback page so the SDK can retrieve the 3D Secure challenge result. The SDK will then do a form post to the psp-service with the [3D Secure challenge result](/psp-api/3-d-secure/3D-securePost_3D_Secure_Challenge).\n\nIf the result is with a `SECURE_3D_COMPLETE` response the SDK will notify the checkout-frontend of the result and the checkout-frontend will then make the payment request to the checkout-service. The checkout-service in turn checks the transaction status with the psp-service and update the transaction status in the checkout-service.","deprecated":null,"version":null,"sidebarTitle":"Post 3-D Secure Method","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/3d-secure-method-complete","href":"/psp-api/3-d-secure/3d-securepost_3d_secure_method"},{"title":"Post 3-D Secure Challenge","description":"This endpoint is called after the ACS has form posted to the notification url with the Cres (challenge result). The notification url will redirect to the postback page where the SDK will retrieve the challenge result and post the values encoded in the Cres to the psp-service (this endpoint).\n\nIf the psp-service response is of the type `SECURE_3D_COMPLETE` the SDK will notify the checkout-frontend of the result and the checkout-frontend will then make the payment request to the checkout-service. The checkout-service in turn checks the transaction status with the psp-service and updated the transaction status in the checkout-service.","deprecated":null,"version":null,"sidebarTitle":"Post 3-D Secure Challenge","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/3d-secure-challenge-complete","href":"/psp-api/3-d-secure/3d-securepost_3d_secure_challenge"},{"title":"NotificationURL for 3-D Secure","description":"This endpoint is used to as the notificationURL after the method or challenge has been completed in the iframe. The ACS will form post to this endpoint with the threeDSMethodData or Cres. The sever will read the body. Decode the base64url encoded data and redirect to the postback page with the decoded data as query parameters.","deprecated":null,"version":null,"sidebarTitle":"NotificationURL for 3-D Secure","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/3d-secure-notification-url","href":"/psp-api/3-d-secure/3d-securenotificationurl"},{"title":"NotificationURL for 3-D Secure (shorthand)","description":"Shorthand alternative to the [notificationURL](/psp-api/3-d-secure/3D-secureNotificationUrl) for 3-D Secure, addressed by an opaque, strictly alphanumeric `id` instead of `account_id` and `transaction_id`. Used where the ACS or 3DS server enforces a maximum notification URL length. Behaves identically to the full notificationURL endpoint.","deprecated":null,"version":null,"sidebarTitle":"NotificationURL for 3-D Secure (shorthand)","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/3dsn/{id}","href":"/psp-api/3-d-secure/3d-securenotificationurlshort"}]},{"group":"Mastercard TAF","pages":[{"title":"Post Mastercard TAF Challenge Completed Result","description":"This endpoint is called with the authentication result from the Mastercard Token Authentication Framework (TAF) initiated in the SDK.\n\nIf the psp-service response is of the type `MASTERCARD_TAF_COMPLETE` the SDK will notify the checkout-frontend of the result and the checkout-frontend will then make the payment request to the checkout-service. The checkout-service in turn checks the transaction status with the psp-service and updated the transaction status in the checkout-service.","deprecated":null,"version":null,"sidebarTitle":"Post Mastercard TAF Challenge Completed Result","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transactions/v1/{account_id}/{transaction_id}/mastercard-taf-challenge-complete","href":"/psp-api/mastercard-taf/mastercardtafpost_mastercard_taf_challenge_complete"}]},{"group":"token","pages":[{"title":"Delete card token","description":null,"deprecated":null,"version":null,"sidebarTitle":"Delete card token","openapi":"/mintlify-docs/openapi/spec-psp.yaml delete /tokens/v1/{account_id}/{token_id}","href":"/psp-api/token/tokendelete_token"},{"title":"Update card token","description":"Updates the account holder details of a card token. An account validation is performed against the card issuer, and the result is stored on the token's `account_validation_result` field. Use the status values to determine whether to proceed with a transaction.","deprecated":null,"version":null,"sidebarTitle":"Update card token","openapi":"/mintlify-docs/openapi/spec-psp.yaml patch /tokens/v1/{account_id}/{token_id}","href":"/psp-api/token/tokenpatch_token"},{"title":"Check transfer eligibility","description":"Checks whether the card token is eligible for sending and receiving Transfer payments.","deprecated":null,"version":null,"sidebarTitle":"Check transfer eligibility","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /tokens/v1/{account_id}/{token_id}/transfer-eligibility","href":"/psp-api/token/tokenpost_transfer_eligibility"}]},{"group":"card","pages":[{"title":"Post Card Transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Post Card Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /card/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/card/cardpost_card_transaction"}]},{"group":"visaClickToPay","pages":[{"title":"Post Visa C2P Transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Post Visa C2P Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /visa-click-to-pay/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/visaclicktopay/visaclicktopaypost_visa_c2p_transaction"}]},{"group":"vipps","pages":[{"title":"Post Vipps Transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Post Vipps Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /vipps/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/vipps/vippspost_vipps_transaction"}]},{"group":"vipps-ext","pages":[{"title":"Receive service callback from Vipps to complete payment","description":null,"deprecated":null,"version":null,"sidebarTitle":"Receive service callback from Vipps to complete payment","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /vipps/v1/{account_id}/payments/{payment_id}/transactions/{transaction_id}","href":"/psp-api/vipps-ext/vippspost_service"}]},{"group":"Apple Pay","pages":[{"title":"Post Apple Pay Validate Merchant","description":"Completes the merchant validation and returns a valid Apple Pay payment session.","deprecated":null,"version":null,"sidebarTitle":"Post Apple Pay Validate Merchant","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /apple-pay/v1/{account_id}/payments/{payment_id}/validate-merchant","href":"/psp-api/apple-pay/applepaypost_apple_pay_validate_merchant"},{"title":"Post Apple Pay Transaction","description":"Post an Apple Pay transaction to the PSP.","deprecated":null,"version":null,"sidebarTitle":"Post Apple Pay Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /apple-pay/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/apple-pay/applepaypost_apple_pay_transaction"}]},{"group":"apple pay tokenization","pages":[{"title":"Apple Pay Token Event Notifications","description":"Endpoint used for receiving Apple Pay token event notifications received through checkout service.\n","deprecated":null,"version":null,"sidebarTitle":"Apple Pay Token Event Notifications","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /apple-pay/v1/merchant-token-event","href":"/psp-api/apple-pay-tokenization/applepaytokeneventpost_notification"}]},{"group":"Google Pay","pages":[{"title":"Post Google Pay Transaction","description":"Post a Google Pay transaction to the PSP.","deprecated":null,"version":null,"sidebarTitle":"Post Google Pay Transaction","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /google-pay/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/google-pay/googlepaypost_google_pay_transaction"}]},{"group":"transfer","pages":[{"title":"Post Transfer","description":"Push funds from a sender's card to a recipient identified by email or\nphone number, as a person-to-person transfer. The recipient's identifier\nis resolved to a card internally, and the transfer is routed to Visa\nDirect (OCT) or Mastercard Send depending on the resolved card's scheme.\n","deprecated":null,"version":null,"sidebarTitle":"Post Transfer","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /transfer/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-api/transfer/transferpost_transfer_transaction"}]},{"group":"visa tokenization","pages":[{"title":"Token Notifications","description":"Endpoint used by VTS for token notifications","deprecated":null,"version":null,"sidebarTitle":"Token Notifications","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /visa-tokenization/v1/notifications/{notification_type}","href":"/psp-api/visa-tokenization/tokenpost_notification"}]},{"group":"mastercard tokenization","pages":[{"title":"Token Notifications","description":"Endpoint used by Mastercard for token notifications. The outbound CardNotification from Mastercard allows Integrators to keep credentials up-to-date with the latest status and underlying card information, including PAN details, card art, and token info.","deprecated":null,"version":null,"sidebarTitle":"Token Notifications","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /mastercard-tokenization/v1/notifications/card","href":"/psp-api/mastercard-tokenization/mastercardtokenpost_notification"},{"title":"Batch token notifications","description":"Endpoint used by Mastercard for notifications for batch enrollment of cards.","deprecated":null,"version":null,"sidebarTitle":"Batch token notifications","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /mastercard-tokenization/v1/notifications/batch/enrollmentrecord","href":"/psp-api/mastercard-tokenization/mastercardtokenbatchpost_notification"}]},{"group":"block-rules","pages":[{"title":"Get block rules","description":"Get all block rules or a list a particular type of block rules","deprecated":null,"version":null,"sidebarTitle":"Get block rules","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /admin/block-rules/v1/{account_id}","href":"/psp-api/block-rules/admingetbytype_blockrule"},{"title":"Create a block rule","description":"Create block rules for blocking payments based on certain criteria.\n","deprecated":null,"version":null,"sidebarTitle":"Create a block rule","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /admin/block-rules/v1/{account_id}","href":"/psp-api/block-rules/adminpost_blockrule"},{"title":"Get block rule","description":"Get block rule by id","deprecated":null,"version":null,"sidebarTitle":"Get block rule","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /admin/block-rules/v1/{account_id}/{block_rule_id}","href":"/psp-api/block-rules/adminget_blockrule"},{"title":"Delete block rule","description":"Delete block rule by id","deprecated":null,"version":null,"sidebarTitle":"Delete block rule","openapi":"/mintlify-docs/openapi/spec-psp.yaml delete /admin/block-rules/v1/{account_id}/{block_rule_id}","href":"/psp-api/block-rules/admindelete_blockrule"},{"title":"Patch block rule","description":"Update block rule by id","deprecated":null,"version":null,"sidebarTitle":"Patch block rule","openapi":"/mintlify-docs/openapi/spec-psp.yaml patch /admin/block-rules/v1/{account_id}/{block_rule_id}","href":"/psp-api/block-rules/adminpatch_blockrule"}]},{"group":"merchant-certificates","pages":[{"title":"List merchant certificates","description":"Lists merchant certificates for the account (pending, active, and\nexpired). Revoked certificates are excluded by default; pass\ninclude_deleted=true to see them too.\n","deprecated":null,"version":null,"sidebarTitle":"List merchant certificates","openapi":"/mintlify-docs/openapi/spec-psp.yaml get /merchant-certificates/v1/{account_id}","href":"/psp-api/merchant-certificates/adminget_merchantcertificates"},{"title":"Generate a merchant certificate key pair and CSR","description":"Generates an ECC P-256 key pair for a merchant payment certificate (e.g.\nfor native Apple Pay), stores the encrypted private key, and returns a\nCSR for the merchant to submit to the certificate provider.\n","deprecated":null,"version":null,"sidebarTitle":"Generate a merchant certificate key pair and CSR","openapi":"/mintlify-docs/openapi/spec-psp.yaml post /merchant-certificates/v1/{account_id}","href":"/psp-api/merchant-certificates/adminpost_merchantcertificate"},{"title":"Upload a signed merchant certificate","description":"Uploads an Apple-signed certificate for a pending merchant certificate key,\nactivating it.\n","deprecated":null,"version":null,"sidebarTitle":"Upload a signed merchant certificate","openapi":"/mintlify-docs/openapi/spec-psp.yaml put /merchant-certificates/v1/{account_id}/{merchant_certificate_id}/certificate","href":"/psp-api/merchant-certificates/adminput_merchantcertificatecertificate"},{"title":"Revoke a merchant certificate","description":"Revokes (deactivates) a merchant certificate. Revocation is final; a\nrevoked certificate cannot be reactivated.\n","deprecated":null,"version":null,"sidebarTitle":"Revoke a merchant certificate","openapi":"/mintlify-docs/openapi/spec-psp.yaml delete /merchant-certificates/v1/{account_id}/{merchant_certificate_id}","href":"/psp-api/merchant-certificates/admindelete_merchantcertificate"}]}]}]},{"dropdown":"PSP Wallet","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/credit-card.svg","groups":[{"group":"PSP Wallet API","pages":[{"group":"Google Pay","pages":[{"title":"Post Google Pay Transaction","description":"Post a Google Pay transaction to the PSP.","deprecated":null,"version":null,"sidebarTitle":"Post Google Pay Transaction","openapi":"/mintlify-docs/openapi/spec-psp-wallet.yaml post /google-pay/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-wallet-api/google-pay/googlepaypost_google_pay_transaction"}]},{"group":"Apple Pay","pages":[{"title":"Post Apple Pay Transaction","description":"Post an Apple Pay transaction to the PSP.","deprecated":null,"version":null,"sidebarTitle":"Post Apple Pay Transaction","openapi":"/mintlify-docs/openapi/spec-psp-wallet.yaml post /apple-pay/v1/{account_id}/payments/{payment_id}/transactions","href":"/psp-wallet-api/apple-pay/applepaypost_apple_pay_transaction"}]}]}]},{"dropdown":"Receipts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/receipt-tax.svg","groups":[{"group":"Receipts API","pages":[{"group":"receipts","pages":[{"title":"Create new Receipts","description":"Post receipts\n\nscopes:\n- admin:receipts\n- write:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Create new Receipts","openapi":"/mintlify-docs/openapi/spec-receipts.yaml post /accounts/{aid}/receipts","href":"/receipts-api/receipts/aid_receipts_post"},{"title":"Update receipt","description":"Update existing anonymous receipt.\n\n### Limitation\n\n- update of customer_id is only allowed if the current customer_id\n is null.\n- update of discounts is only allowed if current discounts value is\n null or empty\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Update receipt","openapi":"/mintlify-docs/openapi/spec-receipts.yaml put /accounts/{aid}/receipts/all/{receipt_id}","href":"/receipts-api/receipts/aid_receipts_update_put"},{"title":"Get receipt by token","description":"Get receipt from token. The token must be a signed JWT token\ncontaining the `customer_id` and `receipt_id` to fetch.\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n- public:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Get receipt by token","openapi":"/mintlify-docs/openapi/spec-receipts.yaml get /accounts/{aid}/receipts/receipt-token","href":"/receipts-api/receipts/aid_receipts_receipt_token_get"},{"title":"Claim receipt by token","description":"Update `customer_id` on receipt identified by token. The token will be\ninvalid after the claim.\n\nscopes:\n- admin:receipts\n- write:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Claim receipt by token","openapi":"/mintlify-docs/openapi/spec-receipts.yaml post /accounts/{aid}/receipts/receipt-token","href":"/receipts-api/receipts/aid_receipts_receipt_token_post"},{"title":"Receipt search","description":"Get receipts matching receipt_id (POS id)\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Receipt search","openapi":"/mintlify-docs/openapi/spec-receipts.yaml get /accounts/{aid}/receipts/search","href":"/receipts-api/receipts/aid_receipts_rid_get"}]},{"group":"segment","pages":[{"title":"Customer segmentation","description":"Segment customer by receipt data\n\nscopes:\n- admin:receipts\n- read:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer segmentation","openapi":"/mintlify-docs/openapi/spec-receipts.yaml post /accounts/{aid}/receipts/customer_segment","href":"/receipts-api/segment/aid_receipts_customer_segment_post"}]},{"group":"customer receipts","pages":[{"title":"Customer Receipts collection","description":"Get the receipts for a customer\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer Receipts collection","openapi":"/mintlify-docs/openapi/spec-receipts.yaml get /accounts/{aid}/receipts/customers/{customer_id}","href":"/receipts-api/customer-receipts/aid_receipts_customers_cid_get"},{"title":"Customer receipt details","description":"Get a customer receipt\n\nscopes:\n- admin:receipts\n- read:receipts\n- user:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Customer receipt details","openapi":"/mintlify-docs/openapi/spec-receipts.yaml get /accounts/{aid}/receipts/customers/{customer_id}/{receipt_id}","href":"/receipts-api/customer-receipts/aid_receipts_customers_cid_rid_get"},{"title":"Change customer_id","description":"Update customer_id for an receipt, i.e. move the receipt\nto a new customer\n\n> **warning**: The receipt will no longer be accessible\n> by the previous customer_id\n\nFollowing extra_info field will be added to the receipt\nwhen customer_id is changed using key\n\n - `dintero.receipts.change_customer_id.{timestamp}.{hash}`\n\nThe content of the extra_info will be a JSON string containing:\n\n - created_at\n - created_by\n - old\n - new\n\nscopes:\n- admin:receipts\n","deprecated":null,"version":null,"sidebarTitle":"Change customer_id","openapi":"/mintlify-docs/openapi/spec-receipts.yaml post /accounts/{aid}/receipts/customers/{customer_id}/{receipt_id}/change_customer_id","href":"/receipts-api/customer-receipts/aid_receipts_customers_cid_rid_change_customer_id_post"}]}]}]},{"dropdown":"Recommendations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/sparkles.svg","groups":[{"group":"Recommendations API","pages":[{"group":"products","pages":[{"title":"Product recommendation","description":"Get recommendations for a product\n\nscopes:\n - admin:recommendations\n - read:recommendations\n","deprecated":null,"version":null,"sidebarTitle":"Product recommendation","openapi":"/mintlify-docs/openapi/spec-recommendations.yaml get /accounts/{aid}/recommendations/products","href":"/recommendations-api/products/aid_recommendations_products_get"}]}]}]},{"dropdown":"Reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/chart-bar.svg","groups":[{"group":"Reports API","pages":[{"group":"reports","pages":[{"title":"Generate report from data","description":"Using this endpoint with the query parameter **save** set to true, will result in an **201**\nresponse, otherwise, the response will be **200**.\n\n#### Generate PDF report for transaction:\n\nFirst, fetch the transaction from [Get transaction](/api-reference/default/transactions_id_get).\n\nStore the transaction in the `transaction` variable and send this payload:\n\n [\n {\n \"key\": \"transaction\",\n \"path\": \"/checkout/v1/transactions/{transaction.id}\",\n \"data\": transaction\n }\n ]\n\nwith these query parameters set:\n\n- template_id=checkout_transaction_order\n- template_data_path=/checkout/v1/transactions/{transaction.id}\n- template_accept=application/pdf\n- template_accept_language=en\n\n**scopes**:\n - admin:reports\n - write:reports\n - read:reports\n","deprecated":null,"version":null,"sidebarTitle":"Generate report from data","openapi":"/mintlify-docs/openapi/spec-reports.yaml post /accounts/{aid}/reports/generation","href":"/reports-api/reports/api_reports_generation_post"},{"title":"List report metadata","description":"Get list of report metadata for the account\n\nScopes:\n - read:reports\n - admin:reports\n","deprecated":null,"version":null,"sidebarTitle":"List report metadata","openapi":"/mintlify-docs/openapi/spec-reports.yaml get /accounts/{aid}/reports/metadata","href":"/reports-api/reports/api_reports_metadata_list_get"}]}]}]},{"dropdown":"Terminals","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/terminal.svg","groups":[{"group":"Terminals API","pages":[{"group":"terminals-transactions","pages":[{"title":"Get transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get transaction","openapi":"/mintlify-docs/openapi/spec-terminals.yaml get /terminal/v1/{account_id}/transactions/{client_transaction_id}","href":"/terminals-api/terminals-transactions/terminal_v1_get_transaction"},{"title":"Create transaction","description":null,"deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/mintlify-docs/openapi/spec-terminals.yaml post /terminal/v1/{account_id}/transactions/{client_transaction_id}","href":"/terminals-api/terminals-transactions/terminal_v1_post_transaction"},{"title":"Post Authorization","description":"Update a non-final authorization to the specified amount. The operation is\nnot allowed if the previous authorization was final\n","deprecated":null,"version":null,"sidebarTitle":"Post Authorization","openapi":"/mintlify-docs/openapi/spec-terminals.yaml post /terminal/v1/{account_id}/transactions/{client_transaction_id}/authorization","href":"/terminals-api/terminals-transactions/terminal_v1_post_transaction_authorization"},{"title":"Post Capture","description":"Captures the specified amount.","deprecated":null,"version":null,"sidebarTitle":"Post Capture","openapi":"/mintlify-docs/openapi/spec-terminals.yaml post /terminal/v1/{account_id}/transactions/{client_transaction_id}/capture","href":"/terminals-api/terminals-transactions/terminal_v1_post_transaction_capture"},{"title":"Post Refund","description":"Refund the specified amount.","deprecated":null,"version":null,"sidebarTitle":"Post Refund","openapi":"/mintlify-docs/openapi/spec-terminals.yaml post /terminal/v1/{account_id}/transactions/{client_transaction_id}/refund","href":"/terminals-api/terminals-transactions/terminal_v1_post_transaction_refund"},{"title":"Post Void","description":"Void the specified amount and cancel the tranaction (prevents new\nauthorization). Void has no effect if the transaction is already captured,\nexcept to prevent new authorization/captures (if applicable)\n","deprecated":null,"version":null,"sidebarTitle":"Post Void","openapi":"/mintlify-docs/openapi/spec-terminals.yaml post /terminal/v1/{account_id}/transactions/{client_transaction_id}/void","href":"/terminals-api/terminals-transactions/terminal_v1_post_transaction_void"}]}]}]},{"dropdown":"Wallets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/credit-card.svg","groups":[{"group":"Wallets API","pages":[{"group":"cards","pages":[{"title":"Get cards","description":"Get all cards for an account\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Get cards","openapi":"/mintlify-docs/openapi/spec-wallets.yaml get /accounts/{aid}/wallets/cards","href":"/wallets-api/cards/aid_cards_get"},{"title":"Create a card","description":"Create a new card\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Create a card","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/cards","href":"/wallets-api/cards/aid_cards_post"},{"title":"Batch create cards","description":"Batch create cards. The cards created from the batch operation will\nall have zero balance and status `inactive`. They all need to be\nactivated before use.\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Batch create cards","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/cards/batch","href":"/wallets-api/cards/aid_cards_batch_post"},{"title":"Retrieve card by card ID","description":"Get all details about a card\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Retrieve card by card ID","openapi":"/mintlify-docs/openapi/spec-wallets.yaml get /accounts/{aid}/wallets/cards/{card_id}","href":"/wallets-api/cards/aid_cards_cardid_get"},{"title":"Activate card","description":"Activate a card with status `inactive`\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/activate\n","deprecated":null,"version":null,"sidebarTitle":"Activate card","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/cards/{card_id}/activate","href":"/wallets-api/cards/aid_cards_cardid_activate_post"},{"title":"Create a token for the card","description":"Create a temporary `token` (also referred as Card Code)\nfor the card, an temporary alias that must be used when\nwhen creating a drawdown transaction\n\nThe token can be stored in a barcode to allow use of virtuell card\nin purchase in POS or webstore\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Create a token for the card","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/cards/{card_id}/tokens","href":"/wallets-api/cards/aid_cards_cardid_token_post"},{"title":"Rotate Pin","description":"Rotate or add new pin to card\n\nscopes:\n- admin:wallets\n- write:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Rotate Pin","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/cards/{card_id}/rotate-pin","href":"/wallets-api/cards/aid_cards_cardid_rotate_pin_post"},{"title":"Retrieve card by Token","description":"Get details about a card, including the current balance and available\nfunds. No details will be returned for expired tokens\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/info\n","deprecated":null,"version":null,"sidebarTitle":"Retrieve card by Token","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/info","href":"/wallets-api/cards/aid_cards_token_post"}]},{"group":"transactions","pages":[{"title":"List card transactions","description":"Retrieve a list of Card's Transaction based on card id\n\nscopes:\n- admin:wallets\n- read:wallets\n","deprecated":null,"version":null,"sidebarTitle":"List card transactions","openapi":"/mintlify-docs/openapi/spec-wallets.yaml get /accounts/{aid}/wallets/cards/{card_id}/transactions","href":"/wallets-api/transactions/aid_cards_cardid_transactions_tid_get"},{"title":"Create transaction","description":"Create a transaction against a Card using `token` or `card_id`.\nIf the Transactions is created as pending, the value will\nbe locked until it is either captured or voided. Transaction ID must\nbe used when capturing or voiding a transaction.\n\n> Using **`card_id`** or creating a **`fund`** transaction requires\n> authorization scope `admin:wallets` or `write:wallets`\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/transactions","href":"/wallets-api/transactions/aid_cards_transactions_post"},{"title":"Capture pending transaction","description":"Capture a pending Transaction, thereby collection the amount\nwithheld by the pending transaction.\n\nOption to specify an amount that should be captured. \nDefaults to capture the full transaction.\nWhen the amount specified is less than the reserved/pending, \nthe remaining amount will still be reserved/pending and can be captured later.\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Capture pending transaction","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/transactions/{transaction_id}/capture","href":"/wallets-api/transactions/aid_cards_cardid_transactions_capture_post"},{"title":"Void pending transaction","description":"Void a pending Transaction by unlocking the amount\nwithheld by the pending transaction\n\nscopes:\n- admin:wallets\n- write:wallets\n- write:wallets:/transactions\n","deprecated":null,"version":null,"sidebarTitle":"Void pending transaction","openapi":"/mintlify-docs/openapi/spec-wallets.yaml post /accounts/{aid}/wallets/transactions/{transaction_id}/void","href":"/wallets-api/transactions/aid_cards_cardid_transactions_void_post"}]},{"group":"customers","pages":[{"title":"List customer cards","description":"Get the cards active for a customer\n\nscopes:\n- admin:wallets\n- read:wallets\n- user:wallets\n","deprecated":null,"version":null,"sidebarTitle":"List customer cards","openapi":"/mintlify-docs/openapi/spec-wallets.yaml get /accounts/{aid}/wallets/customers/{customer_id}/cards","href":"/wallets-api/customers/aid_customers_cid_cards_get"},{"title":"Get customer card details","description":"Get all details about a customer card \n\nscopes:\n- admin:wallets\n- read:wallets\n- user:wallets\n","deprecated":null,"version":null,"sidebarTitle":"Get customer card details","openapi":"/mintlify-docs/openapi/spec-wallets.yaml get /accounts/{aid}/wallets/customers/{customer_id}/cards/{card_id}","href":"/wallets-api/customers/aid_customers_cid_card_cid_get"}]}]}]},{"dropdown":"Webhooks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/dintero-c3a7bfec/mintlify-docs/assets/icons/link.svg","groups":[{"group":"Webhooks API","expanded":true,"pages":[{"group":"subscriptions","pages":[{"title":"List subscriptions","description":"Get a list of all subscriptions\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml get /accounts/{aid}/hooks/subscriptions","href":"/webhooks-api/subscriptions/aid_source_hooks_get"},{"title":"Create subscription","description":"\nWhen you create a new webhook, we'll send you a simple ping event to\nlet you know you've set up the webhook correctly.\nYou can trigger a ping again by calling the\n[ping endpoint](/webhooks-api/subscription-deliveries/aid_source_hooks_hid_ping_post).\n\n## Receiving Webhooks\n\nIn order for Dintero to send webhook payloads, your server needs to be\naccessible from the Internet. We also highly suggest using SSL\nso that we can send encrypted payloads over HTTPS.\n\n## Respond to a webhook\n\nYour webhook acknowledges that it received data by sending a 200 OK\nresponse. Any response outside of the 200 range will let Dintero\nknow that you did not receive your webhook, including 301 Redirect.\nDintero does not follow redirects for webhook notifications and will\nconsider a redirection as an error response.\n\nDintero has implemented a 60-second timeout period and a retry\nperiod for subscriptions. We wait 120 seconds for a response to\neach request, and if there isn't one or we get an error, we retry\nthe connection to a total of 5 times.\nA webhook will be deleted if there are consecutive failures for the\nexact same webhook. You should monitor the admin of your webhook\ntool for failing webhooks.\n\n### Webhooks Headers\n\nDintero will send along several HTTP headers to differentiate between\nevent types and payload identifiers.\n\n| Name | Description |\n|----------------|------------------------------------------------------|\n| event | The event type |\n| event-delivery | A guid to indentify the payload and event being sent |\n| event-signature| The value of this header is computed as the HMAC SHA1 hex digest of the body, using the secret config option as the key. |\n\nscopes:\n- admin:hooks\n- write:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /accounts/{aid}/hooks/subscriptions","href":"/webhooks-api/subscriptions/aid_source_hooks_post"},{"title":"Get subscription details","description":"Get subscription details\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Get subscription details","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml get /accounts/{aid}/hooks/subscriptions/{hid}","href":"/webhooks-api/subscriptions/aid_source_hooks_hid_get"},{"title":"Delete Subscription","description":"Delete a webhook subscription\n\nNo more events will be sent to the webhook\n\nscopes:\n- admin:hooks\n- write:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Delete Subscription","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml delete /accounts/{aid}/hooks/subscriptions/{hid}","href":"/webhooks-api/subscriptions/aid_source_hooks_hid_delete"}]},{"group":"subscription deliveries","pages":[{"title":"List subscription deliveries","description":"Get recent subscription deliveries\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"List subscription deliveries","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml get /accounts/{aid}/hooks/subscriptions/{hid}/deliveries","href":"/webhooks-api/subscription-deliveries/aid_source_hooks_hid_deliveries_get"},{"title":"Get delivery details","description":"Get subscription delivery details\n\nscopes:\n- admin:hooks\n- read:hooks\n","deprecated":null,"version":null,"sidebarTitle":"Get delivery details","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml get /accounts/{aid}/hooks/subscriptions/{hid}/deliveries/{delivery_id}","href":"/webhooks-api/subscription-deliveries/aid_source_hooks_hid_deliveries_did_get"},{"title":"Subscription ping","description":"This will trigger a ping event to be sent to the subscription URL.\n\n### Ping Event Payload\n\n```http\nPOST /\nUser-Agent: Dintero-Hook/0c9ad03b\nContent-Type: application/json\nevent: ping\nevent-delivery: cfedde7e-b088-415e-ad5b-cbe54acbb6f9\n\n{\n \"created_at\": \"2017-12-06T15:36:43Z\",\n \"created_by\": \"1c92f7e1-2897-4d46-bdcc-c127a914fb4e\",\n \"id\": \"string\",\n \"updated_at\": \"2017-12-06T15:36:43Z\",\n \"active\": true,\n \"config\": {\n \"content_type\": \"application/json\",\n \"insecure_ssl\": 0,\n \"secret\": { ... }\n \"url\": \"string\"\n },\n \"events\": [\"receipt_add\"]\n}\n```\n","deprecated":null,"version":null,"sidebarTitle":"Subscription ping","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /accounts/{aid}/hooks/subscriptions/{hid}/ping","href":"/webhooks-api/subscription-deliveries/aid_source_hooks_hid_ping_post"}]},{"group":"example-management-auth-events","pages":[{"title":"approval_payout_destination_update","description":"Event is pushed to subscribers when the `case_status`\nof a seller approval changes\n","deprecated":null,"version":null,"sidebarTitle":"approval_payout_destination_update","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/approval_payout_destination_update","href":"/webhooks-api/example-management-auth-events/example_approval_payout_destination_update_event"},{"title":"approval_payout_destination_delete","description":"Event is pushed to subscribers when the approval is archived\n","deprecated":null,"version":null,"sidebarTitle":"approval_payout_destination_delete","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/approval_payout_destination_delete","href":"/webhooks-api/example-management-auth-events/example_approval_payout_destination_update_delete"},{"title":"cdd_case_update","description":"Event is pushed to subscribers when a CDD case changes status.\n\nNote that the event will only include one of\n`payout_destination_case` or `payment_case` never both\n","deprecated":null,"version":null,"sidebarTitle":"cdd_case_update","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/cdd_case_update","href":"/webhooks-api/example-management-auth-events/example_cdd_case_update_event"},{"title":"account_store_add","description":"Event is pushed to subscribers when a new store is added to the account\n","deprecated":null,"version":null,"sidebarTitle":"account_store_add","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_store_add","href":"/webhooks-api/example-management-auth-events/example_account_store_add_event"},{"title":"account_store_update","description":"Event is pushed to subscribers when a store is updated\n","deprecated":null,"version":null,"sidebarTitle":"account_store_update","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_store_update","href":"/webhooks-api/example-management-auth-events/example_account_store_update_event"},{"title":"account_store_delete","description":"Event is pushed to subscribers when a store is deleted\n","deprecated":null,"version":null,"sidebarTitle":"account_store_delete","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_store_delete","href":"/webhooks-api/example-management-auth-events/example_account_store_delete_event"},{"title":"account_payout_destination_add","description":"Event is pushed to subscribers when a payout destination is added\n","deprecated":null,"version":null,"sidebarTitle":"account_payout_destination_add","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_payout_destination_add","href":"/webhooks-api/example-management-auth-events/example_account_payout_destination_add_event"},{"title":"account_payout_destination_update","description":"Event is pushed to subscribers when a payout destination is updated\n","deprecated":null,"version":null,"sidebarTitle":"account_payout_destination_update","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_payout_destination_update","href":"/webhooks-api/example-management-auth-events/example_account_payout_destination_update_event"},{"title":"account_payout_destination_delete","description":"Event is pushed to subscribers when a payout destination is deleted\n","deprecated":null,"version":null,"sidebarTitle":"account_payout_destination_delete","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/account_payout_destination_delete","href":"/webhooks-api/example-management-auth-events/example_account_payout_destination_delete_event"}]},{"group":"example-checkout-events","pages":[{"title":"checkout_transaction","description":"Event is pushed to subscribers when the checkout transaction is created or\nupdated\n","deprecated":null,"version":null,"sidebarTitle":"checkout_transaction","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/checkout_transaction","href":"/webhooks-api/example-checkout-events/example_checkout_transaction_event"},{"title":"checkout_authorization","description":"Event is pushed to subscribers when a transaction was authorized\nor failed authorization\n\n> The deliveries match what is delivered to the session callback_url\n> with `report_error=true` set\n","deprecated":null,"version":null,"sidebarTitle":"checkout_authorization","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/checkout_authorization","href":"/webhooks-api/example-checkout-events/example_checkout_authorization_event"},{"title":"checkout_token_*","description":"Event is pushed to subscribers when the checkout token is created, \\\nupdated or deleted\n","deprecated":null,"version":null,"sidebarTitle":"checkout_token_*","openapi":"/mintlify-docs/openapi/spec-webhooks.yaml post /examples/checkout_token","href":"/webhooks-api/example-checkout-events/example_checkout_token_event"}]}]}]}]}]},"basePath":"","title":"Set Express Checkout discount codes - Dintero Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}