When backwards-incompatible changes are made to the API, we release a new version. Without specifically setting a version, requests will always use the latest version.
Use the X-Version header to specifically set the version of the API. We support the current version -2.
Current version is 2024-04. Apply header as X-Version: 2024-04 or leave out.
date
version
release
2024/04/09
2024-04
latest
2024/02/20
2024-02
supported
2023/07/13
2023-07
supported
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Debitdirect","colors":{"primary":"#10255c","light":"#6BC0C4","dark":"#10255c"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/debitdirect/D2clmxB1y7TjOk5o/logo/logo_text_black.svg?fit=max\u0026auto=format\u0026n=D2clmxB1y7TjOk5o\u0026q=85\u0026s=479f764213ffd2e69bdad1c0602f6d40","dark":"https://mintcdn.com/debitdirect/D2clmxB1y7TjOk5o/logo/logo_text_white.svg?fit=max\u0026auto=format\u0026n=D2clmxB1y7TjOk5o\u0026q=85\u0026s=8e9ac8088d6c3103e432a6c1ea6846ea"},"api":{"openapi":"https://api.debitdirect.io/swagger/v1/swagger.json"},"appearance":{"default":"light","strict":null},"navbar":{"links":[{"label":"Support","href":"mailto:hello@debitdirect.io"},{"label":"Status","href":"https://status.debitdirect.io/"}],"primary":{"type":"button","label":"Debitdirect","href":"https://www.debitdirect.io"}},"footer":{"socials":{"github":"https://github.com/debitdirect/","linkedin":"https://www.linkedin.com/company/debitdirect/"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","href":"https://stackoverflow.com/search?q=debitdirect","icon":"slack"},{"anchor":"Github","href":"https://github.com/debitdirect","icon":"github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"debitdirect","hasAudioNarration":false,"actualSubdomain":"debitdirect","customDomains":["docs.debitdirect.io"],"gitSource":{"type":"github","owner":"debitdirect","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21c9658d90fac40fc26145","collectionId":"f5a0ab38-ed5e-4088-a894-c636a58c9d01","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21c9658d90fac40fc26145:success","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"API Reference","count":25},{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"Schemes","count":15},{"language":"default","tag":"Merchants","count":8},{"language":"default","tag":"Getting Started","count":7},{"language":"default","tag":"Leverandørservice (DK)","count":7},{"language":"default","tag":"Customers","count":6},{"language":"default","tag":"Web events","count":6},{"language":"default","tag":"Betalingsservice (DK)","count":5},{"language":"default","tag":"Payments","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/versioning","slug":"/api-reference/versioning","pageMetadata":{"title":"Versioning","description":null,"href":"/api-reference/versioning"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,em:`em`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Info,Table}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`When backwards-incompatible changes are made to the API, we release a new version. Without specifically setting a version, requests will always use the latest version.\nUse the `,_jsx(_components.code,{children:`X-Version`}),` header to specifically set the version of the API. We support the current version -2.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Current version is `,_jsx(_components.strong,{children:`2024-04`}),`. Apply header as `,_jsx(_components.em,{children:`X-Version: 2024-04`}),` or leave out.`]})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`date`}),_jsx(_components.th,{children:`version`}),_jsx(_components.th,{children:`release`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2024/04/09`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`2024-04`}),_jsx(_components.td,{children:`latest`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2024/02/20`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`2024-02`}),_jsx(_components.td,{children:`supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2023/07/13`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`2023-07`}),_jsx(_components.td,{children:`supported`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Versioning","description":null,"href":"/api-reference/versioning"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"debitdirect","siteName":"Debitdirect","title":"Versioning - Debitdirect","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-11T19:01:12.541Z","originalFileLocation":"api-reference/versioning.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=\"application-name\" content=\"Debitdirect\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_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/debitdirect/NXXfFLIclc8ReLLM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Versioning - Debitdirect\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Debitdirect\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.debitdirect.io/api-reference/versioning\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debitdirect.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Versioning\u0026amp;theme=8a83313f82b8d1bb4c34857d\u0026amp;signature=2783e080ced2901ef40de8084589fb85ac042f83f47dede9e7eabb20e23c3fd9\">\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=\"Versioning - Debitdirect\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debitdirect.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Versioning\u0026amp;theme=8a83313f82b8d1bb4c34857d\u0026amp;signature=2783e080ced2901ef40de8084589fb85ac042f83f47dede9e7eabb20e23c3fd9\">\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/debitdirect/NXXfFLIclc8ReLLM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Debitdirect\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10255c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.debitdirect.io/api-reference/versioning\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/versioning.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.debitdirect.io/#organization\",\"name\":\"Debitdirect\",\"url\":\"https://docs.debitdirect.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/debitdirect/D2clmxB1y7TjOk5o/logo/logo_text_black.svg?fit=max\u0026auto=format\u0026n=D2clmxB1y7TjOk5o\u0026q=85\u0026s=479f764213ffd2e69bdad1c0602f6d40\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.debitdirect.io#website\",\"name\":\"Debitdirect\",\"url\":\"https://docs.debitdirect.io\",\"publisher\":{\"@id\":\"https://docs.debitdirect.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.debitdirect.io/api-reference/versioning#webpage\",\"url\":\"https://docs.debitdirect.io/api-reference/versioning\",\"name\":\"Versioning\",\"dateModified\":\"2025-12-11T19:01:12.541Z\",\"isPartOf\":{\"@id\":\"https://docs.debitdirect.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.debitdirect.io/api-reference/versioning#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.debitdirect.io/api-reference/versioning#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.debitdirect.io/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Versioning\",\"item\":\"https://docs.debitdirect.io/api-reference/versioning\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.debitdirect.io/api-reference/versioning#article\",\"headline\":\"Versioning\",\"name\":\"Versioning\",\"url\":\"https://docs.debitdirect.io/api-reference/versioning\",\"mainEntityOfPage\":{\"@id\":\"https://docs.debitdirect.io/api-reference/versioning#webpage\"},\"dateModified\":\"2025-12-11T19:01:12.541Z\",\"publisher\":{\"@id\":\"https://docs.debitdirect.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.debitdirect.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Debitdirect\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Debitdirect","nav":{"global":{"anchors":[{"anchor":"Community","href":"https://stackoverflow.com/search?q=debitdirect","icon":"slack"},{"anchor":"Github","href":"https://github.com/debitdirect","icon":"github"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Idempotency","description":null,"href":"/api-reference/idempotency"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"Traceability","description":null,"href":"/api-reference/traceability"},{"title":"Limitations","href":"/api-reference/limitations"}]},{"group":"Customers","pages":[{"title":"List Customers","openapi":"get /Customers","href":"/api-reference/customers/get-customers"},{"title":"Create Customer","openapi":"post /Customers","href":"/api-reference/customers/post-customers"},{"title":"Get Customer","openapi":"get /Customers/{customerIdOrHandle}","href":"/api-reference/customers/get-customers-1"},{"title":"Delete Customer","openapi":"delete /Customers/{customerId}","href":"/api-reference/customers/delete-customers"},{"title":"List Mandates","openapi":"get /Customers/mandates","href":"/api-reference/customers/get-customersmandates"},{"title":"Get Mandate","openapi":"get /Customers/mandates/{mandateIdOrHandle}","href":"/api-reference/customers/get-customersmandates-1"}]},{"group":"Merchants","pages":[{"openapi":"get /Merchants","title":null,"href":"/api-reference/merchants/get-merchants"},{"openapi":"post /Merchants","title":null,"href":"/api-reference/merchants/post-merchants"},{"openapi":"post /Merchants/agreements","title":null,"href":"/api-reference/merchants/post-merchantsagreements"},{"openapi":"get /Merchants/agreements/{agreementIdOrHandle}","title":null,"href":"/api-reference/merchants/get-merchantsagreements"},{"openapi":"delete /Merchants/agreements/{agreementId}","title":null,"href":"/api-reference/merchants/delete-merchantsagreements"},{"openapi":"get /Merchants/webhooks","title":null,"href":"/api-reference/merchants/get-merchantswebhooks"},{"openapi":"post /Merchants/webhooks/unsubscribe","title":null,"href":"/api-reference/merchants/post-merchantswebhooksunsubscribe"},{"openapi":"post /Merchants/webhooks/subscribe","title":null,"href":"/api-reference/merchants/post-merchantswebhookssubscribe"}]},{"group":"Payments","pages":[{"openapi":"get /Payments","title":null,"href":"/api-reference/payments/get-payments"},{"openapi":"post /Payments","title":null,"href":"/api-reference/payments/post-payments"},{"openapi":"get /Payments/{paymentIdOrHandle}","title":null,"href":"/api-reference/payments/get-payments-1"},{"openapi":"delete /Payments/{paymentId}","title":null,"href":"/api-reference/payments/delete-payments"}]}]},{"tab":"Web events","pages":[{"title":"Web events","href":"/web-events/introduction"}]}]},"title":"Versioning - Debitdirect","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}