You also need to set baseurl, see the Environments section for more details.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Synctera","colors":{"primary":"#00a5fb","light":"#00a5fb","dark":"#ffd200"},"logo":{"light":"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/light.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=ab8bf397160af4319e0c7718764522cb","dark":"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/dark.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=919430638125dbffac15274a667e9f75","href":"https://synctera.com/"},"favicon":"https://mintcdn.com/synctera/pDSOOmsGKwjC8uU7/favicon.png?fit=max\u0026auto=format\u0026n=pDSOOmsGKwjC8uU7\u0026q=85\u0026s=abb443d475485fa9811285908c40fa93","appearance":{"default":"light"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://app.synctera.com/login","label":"Log in"}],"primary":{"type":"button","label":"Contact Us","href":"https://synctera.com/contact-us"}},"footer":{"socials":{"x":"https://twitter.com/synctera","linkedin":"https://www.linkedin.com/company/synctera"}},"fonts":{"heading":{"family":"Open Sans"},"body":{"family":"Open Sans"}},"styling":{"codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Postman Collection","icon":"gear-code","href":"https://www.postman.com/synctera/workspace/synctera-public-workspace/"},{"anchor":"Blog","icon":"newspaper","href":"https://synctera.com/blog"},{"anchor":"Platform Status","icon":"bolt","href":"https://status.synctera.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"synctera","hasAudioNarration":false,"actualSubdomain":"synctera","customDomains":["docs.synctera.com"],"gitSource":{"type":"gitlab","owner":"synctera","repo":"docs","projectId":76847357,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":false,"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3988019d2b745f49d511d","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":764},{"language":"default","tag":"Learning Center","count":243},{"language":"default","tag":"Cards","count":224},{"language":"default","tag":"Accounts","count":202},{"language":"default","tag":"Money Movement","count":193},{"language":"default","tag":"Guides","count":177},{"language":"default","tag":"Synctera for FinTechs","count":105},{"language":"default","tag":"Customers","count":102},{"language":"default","tag":"Synctera FAQ","count":91},{"language":"default","tag":"Platform","count":85}]},"assistantConfig":{},"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}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"li[id=\"topbar-cta-button\"]>a>div>span{color:#000!important}li[id=\"topbar-cta-button\"]>a>div>svg>path{stroke:#000!important}.dark li[id=\"topbar-cta-button\"]>a>div>span{color:#000!important}"}],"page":{"pagePath":"v1/reference/authentication","slug":"/v1/reference/authentication","pageMetadata":{"title":"Authentication","description":"You authenticate each request by presenting your API key in the request header.","mode":"wide","href":"/v1/reference/authentication"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"You authenticate each request by presenting your API key in the request header.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.code,{children:`Authorization: Bearer {API_KEY}`})}),`\n`,_jsx(_components.p,{children:`For example, the beginning of a request using a fictitious key:`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Shell`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api-sandbox.synctera.com/v0/customers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer 476d901b4-a264a79-9db9-96d3dfaafb732'`})]}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`The examples in the Guides assume that you have set an environment variable `,_jsx(_components.code,{children:`apikey`}),`, e.g.`]}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Shell`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` apikey`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`476d901b4-a264a79-9db9-96d3dfaafb732`})]}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`You also need to set `,_jsx(_components.code,{children:`baseurl`}),`, see the `,_jsx(_components.a,{href:`/v1/reference/environments`,children:`Environments`}),` section for more details.`]})]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Authentication","description":"You authenticate each request by presenting your API key in the request header.","mode":"wide","href":"/v1/reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"synctera","siteName":"Synctera","title":"Authentication - Synctera","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/reference/introduction","matchLevel":2},"v0":{"href":"/reference/introduction","matchLevel":2},"v1":{"href":"/v1/reference/authentication","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T21:33:34.333Z","originalFileLocation":"v1/reference/authentication.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=\"You authenticate each request by presenting your API key in the request header.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Synctera\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Synctera\">\u003cmeta data-mint-head property=\"og:description\" content=\"You authenticate each request by presenting your API key in the request header.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synctera\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synctera.com/v1/reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=Synctera+API\u0026amp;title=Authentication\u0026amp;description=You+authenticate+each+request+by+presenting+your+API+key+in+the+request+header.\u0026amp;theme=35c9db4720262b17669a4eed\u0026amp;signature=d87a673b25a8c0201f5f1d1a5003b9681d77fbe7b72ebf17995255d83d1a7e32\">\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=\"Authentication - Synctera\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"You authenticate each request by presenting your API key in the request header.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=Synctera+API\u0026amp;title=Authentication\u0026amp;description=You+authenticate+each+request+by+presenting+your+API+key+in+the+request+header.\u0026amp;theme=35c9db4720262b17669a4eed\u0026amp;signature=d87a673b25a8c0201f5f1d1a5003b9681d77fbe7b72ebf17995255d83d1a7e32\">\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/synctera/ehuaQmwUkP97clsK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Synctera\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00a5fb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.synctera.com/v1/reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.synctera.com/#organization\",\"name\":\"Synctera\",\"url\":\"https://docs.synctera.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/light.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=ab8bf397160af4319e0c7718764522cb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.synctera.com#website\",\"name\":\"Synctera\",\"url\":\"https://docs.synctera.com\",\"publisher\":{\"@id\":\"https://docs.synctera.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.synctera.com/v1/reference/authentication#webpage\",\"url\":\"https://docs.synctera.com/v1/reference/authentication\",\"name\":\"Authentication\",\"description\":\"You authenticate each request by presenting your API key in the request header.\",\"dateModified\":\"2026-01-27T21:33:34.333Z\",\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synctera.com/v1/reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synctera.com/v1/reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Synctera API\",\"item\":\"https://docs.synctera.com/v1/reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.synctera.com/v1/reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.synctera.com/v1/reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"You authenticate each request by presenting your API key in the request header.\",\"url\":\"https://docs.synctera.com/v1/reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synctera.com/v1/reference/authentication#webpage\"},\"dateModified\":\"2026-01-27T21:33:34.333Z\",\"publisher\":{\"@id\":\"https://docs.synctera.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"}}]}\u003c/script>","agentPointerHref":"/v1/reference/authentication.md","siteName":"Synctera","nav":{"global":{"anchors":[{"anchor":"Postman Collection","icon":"gear-code","href":"https://www.postman.com/synctera/workspace/synctera-public-workspace/"},{"anchor":"Blog","icon":"newspaper","href":"https://synctera.com/blog"},{"anchor":"Platform Status","icon":"bolt","href":"https://status.synctera.com/"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/reference/introduction"}]},{"version":"v0","pages":[{"title":"v0","href":"/reference/introduction"}]},{"version":"v1","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v1/docs/platform-overview"}]},{"tab":"API Reference","groups":[{"group":"Synctera API","pages":[{"title":"Introduction","mode":"wide","href":"/v1/reference/introduction"},{"title":"Response Codes","mode":"wide","href":"/v1/reference/response-codes"},{"title":"OpenAPI Spec","mode":"wide","href":"/v1/reference/openapi-spec"},{"title":"Environments","description":"The base URL for your request determines whether the request goes to the Synctera sandbox or, when you’ve rolled your code out for real, to the Synctera production environment where your requests will transact business in the real world.","mode":"wide","href":"/v1/reference/environments"},{"title":"Authentication","mode":"wide","href":"/v1/reference/authentication"},{"title":"Idempotency","description":"All of our API endpoints support idempotency, in which a request defines a state, not an action. If you repeat an idempotent request through accident or because you're unsure if an earlier request made it through, the repeated requests won't accumulate with unintended results. If you repeat an idempotent request three times to credit an account with $30, for example, you won't accidentally credit $90, you will credit the intended $30.","mode":"wide","href":"/v1/reference/idempotency"},{"group":"Credit Disputes","pages":[{"openapi":"openapi-v1.json get /credit_disputes/{credit_dispute_id}","title":null,"href":"/v1/reference/getcreditdispute"}]},{"group":"Credit Dispute Batch Files","pages":[{"openapi":"openapi-v1.json get /credit_dispute_batches/{batch_id}","title":null,"href":"/v1/reference/getcreditdisputebatchfile"}]}]},{"group":"Customers","pages":[{"group":"Credit Scores","pages":[{"openapi":"openapi-v1.json get /credit_scores","title":"List credit scores","href":"/v1/reference/listcreditscores"},{"openapi":"openapi-v1.json post /credit_scores","title":"Create a credit score and associate it with a customer","href":"/v1/reference/createcreditscores"},{"openapi":"openapi-v1.json get /credit_scores/{credit_score_id}","title":"Retrieve a credit score","href":"/v1/reference/getcreditscore"}]},{"group":"CRR","pages":[{"openapi":"openapi-v1.json get /crr","title":null,"href":"/v1/reference/listcrr"}]}]},{"group":"Accounts","pages":[{"group":"Spend Controls","pages":[{"openapi":"openapi-v1.json get /spend_controls","title":"List Spend Controls","href":"/v1/reference/listspendcontrols"},{"openapi":"openapi-v1.json post /spend_controls","title":"Create Spend Control","href":"/v1/reference/createspendcontrol"},{"openapi":"openapi-v1.json get /spend_controls/{spend_control_id}","title":"Get Spend Control","href":"/v1/reference/getspendcontrol"},{"openapi":"openapi-v1.json patch /spend_controls/{spend_control_id}","title":"Update Spend Control","href":"/v1/reference/updatespendcontrol"}]},{"group":"Plaid Core Exchange","pages":[{"openapi":"openapi-v1.json get /fdx_auth_requests","title":"List FDX authorization requests","href":"/v1/reference/listfdxauthrequests"},{"openapi":"openapi-v1.json get /fdx_auth_requests/authorization_test","title":"Authorization Test","href":"/v1/reference/getauthorizationtest"},{"openapi":"openapi-v1.json post /fdx_auth_requests/authorize","title":"Grant an FDX authorization request","href":"/v1/reference/grantfdxauthrequest"},{"openapi":"openapi-v1.json get /fdx_tokens","title":"List tokens","href":"/v1/reference/listfdxtoken"},{"openapi":"openapi-v1.json get /fdx_tokens/{fdx_token_id}","title":"Get an FDX token","href":"/v1/reference/getfdxtoken"}]},{"group":"Statements","pages":[{"openapi":"openapi-v1.json get /statements","title":"List statements","href":"/v1/reference/liststatements"},{"openapi":"openapi-v1.json get /statements/{statement_id}","title":"Get a statement","href":"/v1/reference/getstatement"},{"openapi":"openapi-v1.json get /statements/{statement_id}/transactions","title":"Get a statement's transactions","href":"/v1/reference/getstatementtransactions"}]},{"group":"Applications","pages":[{"openapi":"openapi-v1.json get /applications","title":"List applications","href":"/v1/reference/listapplications-1"},{"openapi":"openapi-v1.json post /applications","title":"Create an application","href":"/v1/reference/createapplication-1"},{"openapi":"openapi-v1.json get /applications/{application_id}","title":"Get an application","href":"/v1/reference/getapplication-1"},{"openapi":"openapi-v1.json patch /applications/{application_id}","title":"Modify an application","href":"/v1/reference/patchapplication-1"}]},{"group":"Adverse Actions","pages":[{"openapi":"openapi-v1.json get /adverse_actions","title":"List adverse action notices","href":"/v1/reference/listadverseactions"},{"openapi":"openapi-v1.json post /adverse_actions","title":"Create an adverse action notice","href":"/v1/reference/createadverseaction"},{"openapi":"openapi-v1.json get /adverse_actions/{adverse_action_id}","title":"Retrieve an adverse action notice","href":"/v1/reference/getadverseaction"}]},{"group":"Autopay","pages":[{"openapi":"openapi-v1.json get /autopay_configs","title":"List autopay configurations","href":"/v1/reference/listautopayconfigs"},{"openapi":"openapi-v1.json post /autopay_configs","title":"Create autopay configuration","href":"/v1/reference/createautopayconfig"},{"openapi":"openapi-v1.json get /autopay_configs/{autopay_config_id}","title":"Get autopay configuration","href":"/v1/reference/getautopayconfig"},{"openapi":"openapi-v1.json patch /autopay_configs/{autopay_config_id}","title":"Update autopay configuration","href":"/v1/reference/updateautopayconfig"},{"openapi":"openapi-v1.json delete /autopay_configs/{autopay_config_id}","title":"Delete autopay configuration","href":"/v1/reference/deleteautopayconfig"},{"openapi":"openapi-v1.json get /autopays","title":"List autopays","href":"/v1/reference/listautopays"},{"openapi":"openapi-v1.json get /autopays/{autopay_id}","title":"Get autopay","href":"/v1/reference/getautopay"},{"openapi":"openapi-v1.json patch /autopays/{autopay_id}","title":"Update autopay","href":"/v1/reference/patchautopay"},{"openapi":"openapi-v1.json post /autopay_configs/{autopay_config_id}/evaluate_statement","title":"Evaluate statement for autopay configuration","href":"/v1/reference/evaluateautopayconfigforstatement"}]}]},{"group":"Cards","pages":[{"group":"Apple Pay","pages":[{"openapi":"openapi-v1.json post /certificates/applepay/csr","title":"Create an Apple Pay CSR","href":"/v1/reference/createapplepaycsr"}]},{"group":"Bulk Issuance","pages":[{"openapi":"openapi-v1.json get /cards/bulk_issuance","title":"List Bulk Order Configurations","href":"/v1/reference/listbulkorderconfigs"},{"openapi":"openapi-v1.json post /cards/bulk_issuance","title":"Create a bulk order configuration","href":"/v1/reference/createbulkorderconfig"},{"openapi":"openapi-v1.json get /cards/bulk_issuance/{bulk_order_config_id}","title":"Get bulk order configuration","href":"/v1/reference/getbulkorderconfig"},{"openapi":"openapi-v1.json post /cards/bulk_issuance/{bulk_order_config_id}/fulfill","title":"Fulfill a bulk order","href":"/v1/reference/fulfillbulkorder"}]},{"group":"Cards","pages":[{"openapi":"openapi-v1.json get /cards","title":"List Cards","href":"/v1/reference/listcards"},{"openapi":"openapi-v1.json post /cards","title":"Issue a Card","href":"/v1/reference/issuecard"},{"openapi":"openapi-v1.json post /cards/activate","title":"Activate a card","href":"/v1/reference/activatecard"},{"openapi":"openapi-v1.json get /cards/card_widget_url","title":"Get card widget URL","href":"/v1/reference/getcardwidgeturl"},{"openapi":"openapi-v1.json get /cards/gateways","title":"List Gateways","href":"/v1/reference/listgateways"},{"openapi":"openapi-v1.json post /cards/gateways","title":"Create Gateway","href":"/v1/reference/creategateway"},{"openapi":"openapi-v1.json get /cards/gateways/{gateway_id}","title":"Get Gateway","href":"/v1/reference/getgateway"},{"openapi":"openapi-v1.json patch /cards/gateways/{gateway_id}","title":"Update Gateway","href":"/v1/reference/updategateway"},{"openapi":"openapi-v1.json get /cards/images","title":"List Card Image Details","href":"/v1/reference/listcardimagedetails"},{"openapi":"openapi-v1.json post /cards/images","title":"Create Card Image","href":"/v1/reference/createcardimage"},{"openapi":"openapi-v1.json get /cards/images/{card_image_id}","title":"Get Card Image Details","href":"/v1/reference/getcardimagedetails"},{"openapi":"openapi-v1.json patch /cards/images/{card_image_id}","title":"Update Card Image Details","href":"/v1/reference/updatecardimagedetails"},{"openapi":"openapi-v1.json get /cards/images/{card_image_id}/data","title":"Get Card Image Data","href":"/v1/reference/getcardimagedata"},{"openapi":"openapi-v1.json post /cards/images/{card_image_id}/data","title":"Upload Card Image","href":"/v1/reference/uploadcardimagedata"},{"openapi":"openapi-v1.json get /cards/products","title":"List Card Products","href":"/v1/reference/listcardproducts"},{"openapi":"openapi-v1.json get /cards/three_ds_decision_gateways","title":"List 3DS Decision Gateways","href":"/v1/reference/listthreedsdecisiongateways"},{"openapi":"openapi-v1.json post /cards/three_ds_decision_gateways","title":"Create 3DS Decision Gateway","href":"/v1/reference/createthreedsdecisiongateway"},{"openapi":"openapi-v1.json get /cards/three_ds_decision_gateways/{id}","title":"Get 3DS DecisionGateway","href":"/v1/reference/getthreedsdecisiongateway"},{"openapi":"openapi-v1.json patch /cards/three_ds_decision_gateways/{id}","title":"Update 3DS Decision Gateway","href":"/v1/reference/updatethreedsgateway"},{"openapi":"openapi-v1.json get /cards/{card_id}","title":"Get Card","href":"/v1/reference/getcard"},{"openapi":"openapi-v1.json patch /cards/{card_id}","title":"Update Card","href":"/v1/reference/updatecard"},{"openapi":"openapi-v1.json get /cards/{card_id}/barcodes","title":"Get Card Barcode","href":"/v1/reference/getcardbarcode"},{"openapi":"openapi-v1.json post /cards/{card_id}/client_token","title":"Get a client token","href":"/v1/reference/getclientaccesstoken"},{"openapi":"openapi-v1.json post /cards/{card_id}/pin","title":"Set Card PIN","href":"/v1/reference/setcardpin"},{"openapi":"openapi-v1.json get /cards/{card_id}/reveal","title":"Reveal Card Details","href":"/v1/reference/revealcarddetails"},{"openapi":"openapi-v1.json get /cards/{card_id}/widget_token","title":"Get a widget access token","href":"/v1/reference/getwidgetaccesstoken"}]},{"group":"External Cards","pages":[{"openapi":"openapi-v1.json get /external_cards","title":"List External Cards","href":"/v1/reference/listexternalcards"},{"openapi":"openapi-v1.json post /external_cards/authenticate_3ds","title":"Authenticate 3DS","href":"/v1/reference/authenticate3ds"},{"openapi":"openapi-v1.json post /external_cards/initialize_3ds","title":"Initialize 3DS","href":"/v1/reference/initialize3ds"},{"openapi":"openapi-v1.json post /external_cards/lookup_3ds","title":"Lookup 3DS","href":"/v1/reference/lookup3ds"},{"openapi":"openapi-v1.json post /external_cards/tokens","title":"Create External Card from token","href":"/v1/reference/createexternalcardfromtoken"},{"openapi":"openapi-v1.json post /external_cards","title":"Create External Card","href":"/v1/reference/createexternalcard"},{"openapi":"openapi-v1.json get /external_cards/transfers","title":"List External Transfers","href":"/v1/reference/listexternalcardtransfers"},{"openapi":"openapi-v1.json post /external_cards/transfers","title":"Create External Card Transfer","href":"/v1/reference/createexternalcardtransfer"},{"openapi":"openapi-v1.json post /external_cards/transfers/applepay","title":"Create Apple Pay External Card Transfer","href":"/v1/reference/createapplepayexternalcardtransfer"},{"openapi":"openapi-v1.json post /external_cards/transfers/googlepay","title":"Create Google Pay External Card Transfer","href":"/v1/reference/creategooglepayexternalcardtransfer"},{"openapi":"openapi-v1.json get /external_cards/transfers/{transfer_id}","title":"Get External Card Transfer","href":"/v1/reference/getexternalcardtransfer"},{"openapi":"openapi-v1.json post /external_cards/transfers/{transfer_id}/reversals","title":"Create External Card Transfer Reversal","href":"/v1/reference/createexternalcardtransferreversal"},{"openapi":"openapi-v1.json delete /external_cards/{external_card_id}","title":"Delete External Card","href":"/v1/reference/deleteexternalcard"},{"openapi":"openapi-v1.json get /external_cards/{external_card_id}","title":"Get External Card","href":"/v1/reference/getexternalcard"},{"openapi":"openapi-v1.json get /external_cards/{external_card_id}/reveal","title":"Reveal External Card Details","href":"/v1/reference/revealexternalcarddetails"},{"openapi":"openapi-v1.json patch /external_cards/{external_card_id}","title":"Update External Card","href":"/v1/reference/updateexternalcard"}]},{"group":"Digital Wallet Tokens","pages":[{"openapi":"openapi-v1.json get /cards/digital_wallet_tokens","title":"List Digital Wallet Tokens","href":"/v1/reference/listdigitalwallettokens"},{"openapi":"openapi-v1.json get /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Get Digital Wallet Token","href":"/v1/reference/getdigitalwallettoken"},{"openapi":"openapi-v1.json patch /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Update Digital Wallet Token's life cycle status","href":"/v1/reference/updatedigitalwallettokenstatus"},{"openapi":"openapi-v1.json post /cards/{card_id}/digital_wallet_tokens/applepay","title":"Create digital wallet token provision request for Apple Pay","href":"/v1/reference/createdigitalwalletapple"},{"openapi":"openapi-v1.json post /cards/{card_id}/digital_wallet_tokens/googlepay","title":"Create digital wallet token provision request for Google Pay","href":"/v1/reference/createdigitalwalletgoogle"}]}]},{"group":"Money Movement","pages":[{"group":"Rewards","pages":[{"openapi":"openapi-v1.json get /reward_templates","title":"List reward templates","href":"/v1/reference/listrewardtemplates"},{"openapi":"openapi-v1.json post /reward_templates","title":"Create a reward template","href":"/v1/reference/createrewardtemplate"},{"openapi":"openapi-v1.json get /reward_templates/{reward_template_id}","title":"Get a Reward template","href":"/v1/reference/getrewardtemplate"},{"openapi":"openapi-v1.json patch /reward_templates/{reward_template_id}","title":"Patch Reward Template","href":"/v1/reference/patchrewardtemplate"},{"openapi":"openapi-v1.json get /rewards","title":"List rewards","href":"/v1/reference/listrewards"},{"openapi":"openapi-v1.json post /rewards","title":"Create a reward","href":"/v1/reference/createreward"},{"openapi":"openapi-v1.json get /rewards/{reward_id}","title":"Get Reward","href":"/v1/reference/getreward"},{"openapi":"openapi-v1.json post /rewards/{reward_id}/reverse","title":"Reverse a reward","href":"/v1/reference/reversereward"}]},{"group":"Reward Products","pages":[{"openapi":"openapi-v1.json get /reward_products","title":"List reward products","href":"/v1/reference/listrewardproducts"},{"openapi":"openapi-v1.json post /reward_products","title":"Create a reward product","href":"/v1/reference/createrewardproduct"},{"openapi":"openapi-v1.json get /reward_products/{reward_product_id}","title":"Get a reward product","href":"/v1/reference/getrewardproduct"},{"openapi":"openapi-v1.json patch /reward_products/{reward_product_id}","title":"Update a reward product","href":"/v1/reference/updaterewardproduct"},{"openapi":"openapi-v1.json get /reward_configs","title":"List reward configs","href":"/v1/reference/listrewardconfigs"},{"openapi":"openapi-v1.json post /reward_configs","title":"Create a reward config","href":"/v1/reference/createrewardconfig"},{"openapi":"openapi-v1.json get /reward_configs/{reward_config_id}","title":"Get a reward config","href":"/v1/reference/getrewardconfig"},{"openapi":"openapi-v1.json patch /reward_configs/{reward_config_id}","title":"Update a reward config","href":"/v1/reference/updaterewardconfig"}]},{"group":"Fees","pages":[{"openapi":"openapi-v1.json get /fee_templates","title":"List fee templates","href":"/v1/reference/listfeetemplates"},{"openapi":"openapi-v1.json post /fee_templates","title":"Create a fee template","href":"/v1/reference/createfeetemplate"},{"openapi":"openapi-v1.json get /fee_templates/{fee_template_id}","title":"Get a Fee template","href":"/v1/reference/getfeetemplate"},{"openapi":"openapi-v1.json patch /fee_templates/{fee_template_id}","title":"Patch Fee Template","href":"/v1/reference/patchfeetemplate"},{"openapi":"openapi-v1.json get /fees","title":"List fees","href":"/v1/reference/listfees"},{"openapi":"openapi-v1.json post /fees","title":"Create a fee","href":"/v1/reference/createfee"},{"openapi":"openapi-v1.json get /fees/{fee_id}","title":"Get Fee","href":"/v1/reference/getfee"},{"openapi":"openapi-v1.json post /fees/{fee_id}/reverse","title":"Reverse a fee","href":"/v1/reference/reversefee"}]},{"group":"Fee Products","pages":[{"openapi":"openapi-v1.json get /fee_products","title":"List fee products","href":"/v1/reference/listfeeproducts"},{"openapi":"openapi-v1.json post /fee_products","title":"Create a fee product","href":"/v1/reference/createfeeproduct"},{"openapi":"openapi-v1.json get /fee_products/{fee_product_id}","title":"Get a fee product","href":"/v1/reference/getfeeproduct"},{"openapi":"openapi-v1.json patch /fee_products/{fee_product_id}","title":"Update a fee product","href":"/v1/reference/updatefeeproduct"},{"openapi":"openapi-v1.json get /fee_configs","title":"List fee configs","href":"/v1/reference/listfeeconfigs"},{"openapi":"openapi-v1.json post /fee_configs","title":"Create a fee config","href":"/v1/reference/createfeeconfig"},{"openapi":"openapi-v1.json get /fee_configs/{fee_config_id}","title":"Get a fee config","href":"/v1/reference/getfeeconfig"},{"openapi":"openapi-v1.json patch /fee_configs/{fee_config_id}","title":"Update a fee config","href":"/v1/reference/updatefeeconfig"},{"openapi":"openapi-v1.json get /fee_categories","title":"List fee categories","href":"/v1/reference/listfeecategories"}]},{"group":"Batch Payments","pages":[{"openapi":"openapi-v1.json get /batch_templates","title":"Get Batch Payment Templates","href":"/v1/reference/getbatchpaymenttemplates"},{"openapi":"openapi-v1.json post /batch_templates","title":"Create Batch Payment Template","href":"/v1/reference/createbatchpaymenttemplate"},{"openapi":"openapi-v1.json get /batch_templates/{id}","title":"Get Batch Payment Template","href":"/v1/reference/getbatchpaymenttemplate"},{"openapi":"openapi-v1.json patch /batch_templates/{id}","title":"Update Batch Payment Template","href":"/v1/reference/updatebatchpaymenttemplate"},{"openapi":"openapi-v1.json get /batches","title":"Get Batch Payments","href":"/v1/reference/getbatchpayments"},{"openapi":"openapi-v1.json post /batches","title":"Create Batch Payments","href":"/v1/reference/createbatchpayments"},{"openapi":"openapi-v1.json get /batches/{id}","title":"Get BatchPayment","href":"/v1/reference/getbatchpayment"},{"openapi":"openapi-v1.json patch /batches/{id}","title":"Update Batch Payment","href":"/v1/reference/updatebatchpayment"}]},{"group":"Payments","pages":[{"openapi":"openapi-v1.json get /payments","title":"List payments","href":"/v1/reference/listpayments"},{"openapi":"openapi-v1.json post /payments","title":"Make a payment","href":"/v1/reference/makepayment"},{"openapi":"openapi-v1.json get /payments/{payment_id}","title":"Get payment","href":"/v1/reference/getpayment"},{"openapi":"openapi-v1.json patch /payments/{payment_id}","title":"Update payment","href":"/v1/reference/patchpayment"}]},{"group":"Outgoing SyncteraPay","pages":[{"openapi":"openapi-v1.json get /synctera_pay","title":"Get Outgoing Synctera Pay Transfers","href":"/v1/reference/getsyncterapaytransfers"},{"openapi":"openapi-v1.json post /synctera_pay","title":"Create Synctera Pay Transfer","href":"/v1/reference/createsyncterapaytransfer"},{"openapi":"openapi-v1.json get /synctera_pay/configurations","title":"Get Outgoing Synctera Pay Configurations","href":"/v1/reference/getsyncterapayconfigurations"},{"openapi":"openapi-v1.json get /synctera_pay/configurations/{id}","title":"Get Outgoing Synctera Pay Configuration","href":"/v1/reference/getsyncterapayconfiguration"},{"openapi":"openapi-v1.json get /synctera_pay/vendors","title":"List Outgoing Synctera Pay vendors","href":"/v1/reference/getsyncterapayvendors"},{"openapi":"openapi-v1.json get /synctera_pay/vendors/{id}","title":"Get an Outgoing Synctera Pay vendor","href":"/v1/reference/getsyncterapayvendor"},{"openapi":"openapi-v1.json get /synctera_pay/{id}","title":"Get Outgoing Synctera Pay Transfer","href":"/v1/reference/getsyncterapaytransfer"},{"openapi":"openapi-v1.json patch /synctera_pay/{id}","title":"Update an Outgoing Synctera Pay Transfer","href":"/v1/reference/updatesyncterapaytransfer"},{"openapi":"openapi-v1.json post /synctera_pay/{id}/return","title":"Return a Synctera Pay Transfer","href":"/v1/reference/returnsyncterapaytransfer"}]},{"group":"Incoming SyncteraPay","pages":[{"openapi":"openapi-v1.json get /synctera_pay/incoming/configurations","title":"List Incoming Synctera Pay Configurations","href":"/v1/reference/listincomingsyncterapayconfigurations"},{"openapi":"openapi-v1.json get /synctera_pay/incoming/configurations/{id}","title":"Get Incoming Synctera Pay Configuration","href":"/v1/reference/getincomingsyncterapayconfiguration"},{"openapi":"openapi-v1.json get /synctera_pay/incoming/transfers","title":"List Incoming Synctera Pay Transfers","href":"/v1/reference/listincomingsyncterapaytransfers"},{"openapi":"openapi-v1.json post /synctera_pay/incoming/transfers","title":"Create Incoming Synctera Pay Transfer","href":"/v1/reference/createincomingsyncterapaytransfer"},{"openapi":"openapi-v1.json get /synctera_pay/incoming/transfers/{id}","title":"Get Incoming Synctera Pay Transfer","href":"/v1/reference/getincomingsyncterapaytransfer"}]}]},{"group":"Transactions","pages":[{"group":"Disputes","pages":[{"openapi":"openapi-v1.json get /disputes","title":"List disputes","href":"/v1/reference/listdisputes"},{"openapi":"openapi-v1.json post /disputes","title":"Dispute a transaction","href":"/v1/reference/createdispute"},{"openapi":"openapi-v1.json get /disputes/documents/{document_id}/contents","title":"Get dispute document contents","href":"/v1/reference/getdisputedocumentcontents"},{"openapi":"openapi-v1.json get /disputes/{dispute_id}","title":"Get a Dispute","href":"/v1/reference/getdispute"},{"openapi":"openapi-v1.json patch /disputes/{dispute_id}","title":"Update a dispute","href":"/v1/reference/updatedispute"},{"openapi":"openapi-v1.json post /disputes/{dispute_id}/actions","title":"Create a dispute action","href":"/v1/reference/createaction"},{"openapi":"openapi-v1.json get /disputes/{dispute_id}/chargeback_data","title":"Get chargeback eligibility data","href":"/v1/reference/getchargebackdata"},{"openapi":"openapi-v1.json post /disputes/{dispute_id}/documents","title":"Add a document to a dispute","href":"/v1/reference/adddisputedocument"}]},{"group":"Transactions (beta)","pages":[{"openapi":"openapi-v1.json get /transactions","title":"List Transactions (deprecated)","href":"/v1/reference/listtransactions"},{"openapi":"openapi-v1.json get /transactions/{id}","title":"Get a transaction by ID (deprecated)","href":"/v1/reference/gettransactionbyid"}]}]},{"group":"Platform","pages":[{"group":"Webhooks","pages":[{"openapi":"openapi-v1.json get /webhooks","title":"List webhooks","href":"/v1/reference/listwebhooks"},{"openapi":"openapi-v1.json post /webhooks","title":"Create a webhook","href":"/v1/reference/createwebhook"},{"openapi":"openapi-v1.json post /webhooks/trigger","title":"Trigger an event","href":"/v1/reference/triggerevent-1"},{"openapi":"openapi-v1.json delete /webhooks/{webhook_id}","title":"Delete a webhook","href":"/v1/reference/deletewebhook-1"},{"openapi":"openapi-v1.json get /webhooks/{webhook_id}","title":"Get a webhook","href":"/v1/reference/getwebhook"},{"openapi":"openapi-v1.json put /webhooks/{webhook_id}","title":"Update a webhook","href":"/v1/reference/updatewebhook-1"},{"openapi":"openapi-v1.json get /webhooks/{webhook_id}/events","title":"List webhook events","href":"/v1/reference/listevents-1"},{"openapi":"openapi-v1.json get /webhooks/{webhook_id}/events/{event_id}","title":"Get webhook event","href":"/v1/reference/getevent-1"},{"openapi":"openapi-v1.json post /webhooks/{webhook_id}/events/{event_id}/resend","title":"Resend an event","href":"/v1/reference/resendevent-1"}]},{"group":"Cases","pages":[{"title":"List cases","openapi":"openapi-v2.json get /cases","href":"/v1/reference/listcases"},{"title":"Get case","openapi":"openapi-v2.json get /cases/{id}","href":"/v1/reference/getcase"}]}]},{"group":"Simulations","pages":[{"group":"Card Webhook Simulations (beta)","pages":[{"openapi":"openapi-v1.json post /cards/{card_id}/webhook_simulations/fulfillment","title":"Simulate Card Fulfillment Event","href":"/v1/reference/simulatecardfulfillmentevent"}]},{"group":"Card Transaction Simulations (beta)","pages":[{"openapi":"openapi-v1.json post /cards/transaction_simulations/authorization","title":"Simulate authorization","href":"/v1/reference/simulateauthorization"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/authorization/advice","title":"Simulate authorization advice","href":"/v1/reference/simulateauthorizationadvice"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/clearing","title":"Simulate clearing or refund","href":"/v1/reference/simulateclearing"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/clearing/l2l3","title":"Simulate L2l3","href":"/v1/reference/simulatel2l3"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/financial","title":"Simulate financial","href":"/v1/reference/simulatefinancial"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/financial/advice","title":"Simulate financial advice","href":"/v1/reference/simulatefinancialadvice"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/financial/balance_inquiry","title":"Simulate balance inquiry","href":"/v1/reference/simulatebalanceinquiry"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/financial/original_credit","title":"Simulate OCT","href":"/v1/reference/simulateoriginalcredit"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/financial/withdrawal","title":"Simulate ATM withdrawal","href":"/v1/reference/simulatewithdrawal"},{"openapi":"openapi-v1.json post /cards/transaction_simulations/reversal","title":"Simulate reversal","href":"/v1/reference/simulatereversal"}]},{"group":"Dispute Simulations (beta)","pages":[{"openapi":"openapi-v1.json post /disputes/simulations/{dispute_id}/actions","title":"Simulate a network dispute action","href":"/v1/reference/simulatedisputeaction"}]}]}]},{"tab":"Learning Center","pages":[{"title":"Learning Center","href":"/docs/learning-center"}]}]}]},"basePath":"","title":"Authentication - Synctera","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}