An OpenAPI specification is provided for a large part of the API, including all endpoints required for payment processing.
This specification is automatically generated when new features are released, and is used to drive automatic changes to the server-side SDKs,
CLI, and Postman collection.
The OpenAPI 3.1.0 specification
Latest changes
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Gr4vy","colors":{"primary":"#0066CC","light":"#0099FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99","dark":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=7a09594217c27f95e0d127250c4cc958"},"favicon":"https://mintcdn.com/flexxbuy/39tfKGesfNHyX7HE/assets/favicon.png?fit=max\u0026auto=format\u0026n=39tfKGesfNHyX7HE\u0026q=85\u0026s=fc89afd637da9116e218f41f2c6b1105","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["csharp","go","java","php","python","javascript","curl"]},"mdx":{"auth":{"method":"bearer"},"server":["https://api.sandbox.flexxbuy.gr4vy.app","https://api.flexxbuy.gr4vy.app"]}},"navbar":{"links":[{"icon":"bell","href":"https://status.gr4vy.com","label":"Status"},{"icon":"github","href":"https://github.com/gr4vy","label":"GitHub"}],"primary":{"type":"button","label":"Gr4vy","href":"https://gr4vy.com/#form-contact"}},"footer":{"socials":{"website":"https://gr4vy.com","twitter":"https://twitter.com/Gr4vyInc","github":"https://github.com/gr4vy","linkedin":"https://www.linkedin.com/company/gr4vy-inc"},"links":[{"header":"About","items":[{"label":"Payment orchestration","href":"https://gr4vy.com/payment-orchestration"},{"label":"Gr4vy for merchants","href":"https://gr4vy.com/merchants"},{"label":"Gr4vy for platforms","href":"https://gr4vy.com/platforms"},{"label":"Increasing your revenue","href":"https://gr4vy.com/revenue"}]},{"header":"Developers","items":[{"label":"GitHub","href":"https://github.com/gr4vy"},{"label":"Latest news","href":"https://docs.gr4vy.com/updates"},{"label":"System status","href":"https://status.gr4vy.com"},{"label":"Customer support","href":"https://support.gr4vy.com"}]}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"G-9CX4E9QWKQ"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexxbuy","hasAudioNarration":false,"actualSubdomain":"flexxbuy","customDomains":["docs.byzly.com"],"gitSource":{"type":"github","owner":"gr4vy","repo":"flexxbuy-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf64bc3d6319f7be041995","collectionId":"bdb65d06-a21b-40ca-800b-8b423f379e82","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf64bc3d6319f7be041995"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf64bc3d6319f7be041995","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Build","count":195},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Connections","count":168},{"language":"default","tag":"Methods","count":141},{"language":"default","tag":"Features","count":95},{"language":"default","tag":"Integration guides","count":91},{"language":"default","tag":"Banking","count":46},{"language":"default","tag":"Dashboard","count":44},{"language":"default","tag":"Other","count":39},{"language":"default","tag":"Embed","count":38}]},"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":[{"filePath":"style.css","content":".payment-service-definition{background-color:#fff!important;border:1px solid #0a0e0d1a;border-radius:16px;padding:2em;vertical-align:middle}.payment-service-definition img{margin:0 1em 0 0;max-width:3em;display:inline-block}.payment-service-definition h2{margin:0;display:inline-block;position:relative;top:.1em}#sidebar-title{text-transform:uppercase}#sidebar-group .group{flex-direction:row-reverse}#footer .max-w-36{max-width:40rem}"}],"page":{"pagePath":"guides/api/openapi","slug":"/guides/api/openapi","pageMetadata":{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","description":null,"href":"/guides/api/openapi"},"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`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`An `,_jsx(_components.a,{href:`https://github.com/gr4vy/gr4vy-openapi`,children:`OpenAPI specification`}),` is provided for a large part of the API, including all endpoints required for payment processing.\nThis specification is automatically generated when new features are released, and is used to drive automatic changes to the `,_jsx(_components.a,{href:`/guides/get-started#server-side-sdks`,children:`server-side SDKs`}),`,\n`,_jsx(_components.a,{href:`/guides/tools/cli`,children:`CLI`}),`, and `,_jsx(_components.a,{href:`/guides/tools/postman`,children:`Postman collection`}),`.`]}),`\n`,_jsxs(CardGroup,{cols:`2`,children:[_jsx(Card,{icon:`github`,href:`https://github.com/gr4vy/gr4vy-openapi`,horizontal:true,children:_jsx(_components.p,{children:`The OpenAPI 3.1.0 specification`})}),_jsx(Card,{icon:`github`,href:`https://github.com/gr4vy/gr4vy-openapi/commits/main/openapi.json`,horizontal:true,children:_jsx(_components.p,{children:`Latest changes`})})]})]})}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":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","description":null,"href":"/guides/api/openapi"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"flexxbuy","siteName":"Gr4vy","title":"OpenAPI 3.1.0 Specification - Gr4vy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T13:44:51.440Z","originalFileLocation":"guides/api/openapi.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"OpenAPI 3.1.0 Specification - Gr4vy\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gr4vy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzly.com/guides/api/openapi\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=OpenAPI+3.1.0+Specification\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=cb4f629c4268c8cad596a3ba3e63b0f33165d8cf1df4240690a5843e7855ef27\">\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=\"OpenAPI 3.1.0 Specification - Gr4vy\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=OpenAPI+3.1.0+Specification\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=cb4f629c4268c8cad596a3ba3e63b0f33165d8cf1df4240690a5843e7855ef27\">\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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzly.com/guides/api/openapi\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/api/openapi.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzly.com/#organization\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzly.com#website\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzly.com/guides/api/openapi#webpage\",\"url\":\"https://docs.byzly.com/guides/api/openapi\",\"name\":\"OpenAPI 3.1.0 Specification\",\"dateModified\":\"2026-10-21T13:44:51.440Z\",\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzly.com/guides/api/openapi#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzly.com/guides/api/openapi#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.byzly.com/guides/tools/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"OpenAPI 3.1.0 Specification\",\"item\":\"https://docs.byzly.com/guides/api/openapi\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.byzly.com/guides/api/openapi#article\",\"headline\":\"OpenAPI 3.1.0 Specification\",\"name\":\"OpenAPI 3.1.0 Specification\",\"url\":\"https://docs.byzly.com/guides/api/openapi\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzly.com/guides/api/openapi#webpage\"},\"dateModified\":\"2026-10-21T13:44:51.440Z\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gr4vy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gr4vy","nav":{"global":null,"tabs":[{"tab":"Build","icon":"credit-card","groups":[{"group":"Get started","icon":"compass","pages":[{"sidebarTitle":"Overview","title":"Connect, build, and scale payments","mode":"wide","href":"/guides/get-started"},{"title":"Accept payments on the web","sidebarTitle":"Web payments","href":"/guides/payments/web"},{"title":"Accept payments on mobile","sidebarTitle":"Mobile payments","href":"/guides/payments/mobile"}]},{"group":"Integration guides","icon":"code","pages":[{"group":"Embed","pages":[{"group":"Web","pages":[{"title":"Embed","sidebarTitle":"Introduction","href":"/guides/payments/embed/quick-start/overview"},{"title":"Creating an API key for use with Embed","sidebarTitle":"API keys","href":"/guides/payments/embed/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/embed/quick-start/sdks"},{"title":"Adding Embed","sidebarTitle":"Embed checkout","href":"/guides/payments/embed/quick-start/embed"},{"title":"Inspecting transactions","sidebarTitle":"Transaction inspection","href":"/guides/payments/embed/quick-start/inspect"},{"title":"Going live","sidebarTitle":"Going live","href":"/guides/payments/embed/quick-start/live"},{"title":"Digital wallets in Embed","sidebarTitle":"Digital wallets","href":"/guides/payments/embed/digital-wallets"},{"title":"Embed events","sidebarTitle":"Events","href":"/guides/payments/embed/events"},{"title":"Embed localization","sidebarTitle":"Locales","href":"/guides/payments/embed/locale"},{"title":"Embed Theming","sidebarTitle":"Theming","href":"/guides/payments/embed/theming"},{"title":"Embed options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/embed/options"},{"title":"In-app browsers with Embed","sidebarTitle":"In-app browsers","href":"/guides/payments/embed/in-app-browsers"},{"title":"Common issues with Embed","sidebarTitle":"Common issues","href":"/guides/payments/embed/common-issues"}]},{"group":"Android","pages":[{"title":"Android SDK","sidebarTitle":"Introduction","href":"/guides/payments/android/quick-start/overview"},{"title":"Creating an API key for use with Android","sidebarTitle":"API keys","href":"/guides/payments/android/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/android/quick-start/sdks"},{"title":"Installing the Android SDK","sidebarTitle":"SDK installation","href":"/guides/payments/android/quick-start/android"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/android/quick-start/transact"},{"title":"Google Pay on Android","sidebarTitle":"Google Pay","href":"/guides/payments/android/google-pay"},{"title":"Android events","sidebarTitle":"Events","href":"/guides/payments/android/events"},{"title":"Android options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/android/options"}]},{"group":"iOS","pages":[{"title":"iOS SDK","sidebarTitle":"Introduction","href":"/guides/payments/ios/quick-start/overview"},{"title":"Creating an API key for use with iOS","sidebarTitle":"API keys","href":"/guides/payments/ios/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/ios/quick-start/sdks"},{"title":"Installing the iOS SDK","sidebarTitle":"SDK installation","href":"/guides/payments/ios/quick-start/ios"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/ios/quick-start/transact"},{"title":"Apple Pay on iOS","sidebarTitle":"Apple Pay","href":"/guides/payments/ios/apple-pay"},{"title":"iOS events","sidebarTitle":"Events","href":"/guides/payments/ios/events"},{"title":"iOS options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/ios/options"}]},{"group":"React Native","pages":[{"title":"React Native SDK","sidebarTitle":"Introduction","href":"/guides/payments/react-native/quick-start/overview"},{"title":"Creating an API key for use with React Native","sidebarTitle":"API keys","href":"/guides/payments/react-native/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/react-native/quick-start/sdks"},{"title":"Installing the React Native SDK","sidebarTitle":"SDK installation","href":"/guides/payments/react-native/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/react-native/quick-start/transact"},{"title":"Apple Pay on React Native","sidebarTitle":"Apple Pay","href":"/guides/payments/react-native/apple-pay"},{"title":"Google Pay on React Native","sidebarTitle":"Google Pay","href":"/guides/payments/react-native/google-pay"},{"title":"React Native events","sidebarTitle":"Events","href":"/guides/payments/react-native/events"},{"title":"React Native options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/react-native/options"}]}]},{"group":"Secure Fields","pages":[{"title":"Secure Fields","sidebarTitle":"Introduction","href":"/guides/payments/secure-fields/quick-start/overview"},{"title":"Creating an API key for use with Secure Fields","sidebarTitle":"API keys","href":"/guides/payments/secure-fields/quick-start/key"},{"title":"Creating checkout sessions","sidebarTitle":"Checkout sessions","href":"/guides/payments/secure-fields/quick-start/sdks"},{"title":"Adding secure fields","sidebarTitle":"Secure fields","href":"/guides/payments/secure-fields/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/secure-fields/quick-start/transact"},{"title":"Secure Fields and 3DS","sidebarTitle":"3DS","href":"/guides/payments/secure-fields/three-d-secure"},{"title":"Secure Fields with stored cards","sidebarTitle":"Stored cards","href":"/guides/payments/secure-fields/stored-cards"},{"title":"Secure Fields theming","sidebarTitle":"Theming","href":"/guides/payments/secure-fields/theming"},{"title":"Secure Fields events","sidebarTitle":"Events","href":"/guides/payments/secure-fields/events"},{"title":"Secure Fields UX options","sidebarTitle":"UX options","href":"/guides/payments/secure-fields/ux-options"}]},{"group":"Direct API","pages":[{"title":"Direct API","sidebarTitle":"Introduction","href":"/guides/payments/direct-api/quick-start/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/guides/payments/direct-api/quick-start/key"},{"title":"Listing payment options","sidebarTitle":"Payment options","href":"/guides/payments/direct-api/quick-start/payment-options"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/direct-api/quick-start/transaction"},{"title":"Handling redirects","sidebarTitle":"Redirects","href":"/guides/payments/direct-api/quick-start/handle-redirect"},{"title":"Getting transaction results","sidebarTitle":"Transaction results","href":"/guides/payments/direct-api/quick-start/status"},{"title":"PayPal via the API","sidebarTitle":"PayPal","href":"/guides/payments/direct-api/paypal"}]},{"group":"Native SDKs","pages":[{"title":"Native Mobile SDKs","sidebarTitle":"Overview","href":"/guides/payments/native/overview"},{"title":"Create an API key","sidebarTitle":"API keys","href":"/guides/payments/native/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/native/sdks"},{"title":"Vaulting card data","sidebarTitle":"Vaulting","href":"/guides/payments/native/vault"},{"title":"Adding 3DS authentication","sidebarTitle":"3DS","href":"/guides/payments/native/3ds"},{"sidebarTitle":"Get card details","title":"Card details","href":"/guides/payments/native/get-card-details"},{"sidebarTitle":"Payment options","title":"List payment options","href":"/guides/payments/native/list-payment-options"},{"sidebarTitle":"Buyer payment methods","title":"List buyer payment methods","href":"/guides/payments/native/list-buyer-payment-methods"},{"title":"SDK Response Reference","sidebarTitle":"Responses","href":"/guides/payments/native/responses"}]},{"group":"Agentic Development Kit","pages":[{"title":"Agentic Development Kit (ADK)","sidebarTitle":"Overview","href":"/guides/payments/adk/overview"},{"group":"ChatGPT","pages":[{"title":"ChatGPT ADK","sidebarTitle":"Introduction","href":"/guides/payments/chatgpt-app/overview"},{"title":"Architecture","sidebarTitle":"Architecture","href":"/guides/payments/chatgpt-app/architecture"},{"title":"Set up the project","sidebarTitle":"Setup","href":"/guides/payments/chatgpt-app/setup"},{"title":"Build the MCP server","sidebarTitle":"MCP server","href":"/guides/payments/chatgpt-app/mcp-server"},{"title":"Build the widgets","sidebarTitle":"Widgets","href":"/guides/payments/chatgpt-app/widgets"},{"title":"Integrate Gr4vy Embed","sidebarTitle":"Gr4vy Embed","href":"/guides/payments/chatgpt-app/gr4vy-embed"},{"title":"Deploy to ChatGPT","sidebarTitle":"Deployment","href":"/guides/payments/chatgpt-app/deployment"}]}]},{"group":"Vaulting","pages":[{"title":"Vaulting","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/overview"},{"title":"Tokenize a card","sidebarTitle":"Tokenize","href":"/guides/features/vault-forwarding/tokenize"},{"title":"Provision a PSP token","sidebarTitle":"PSP tokens","href":"/guides/features/vault-forwarding/psp-tokens"},{"title":"Vault Forward card data to API endpoint","sidebarTitle":"Forward to endpoint","href":"/guides/features/vault-forwarding/forward"}]},{"group":"E-commerce Plugins","pages":[{"group":"commercetools","pages":[{"title":"commercetools Integration","sidebarTitle":"Overview","href":"/guides/payments/commercetools/overview"},{"title":"commercetools Installation","sidebarTitle":"Installation","href":"/guides/payments/commercetools/installation"},{"title":"commercetools Configuration","sidebarTitle":"Configuration","href":"/guides/payments/commercetools/configuration"},{"title":"commercetools Administration","sidebarTitle":"Administration","href":"/guides/payments/commercetools/backend"},{"title":"commercetools Frontend","sidebarTitle":"Frontend","href":"/guides/payments/commercetools/frontend"}]},{"group":"Magento","pages":[{"title":"Magento Plugin","sidebarTitle":"Overview","href":"/guides/payments/magento/overview"},{"title":"Magento Installation","sidebarTitle":"Installation","href":"/guides/payments/magento/installation"},{"title":"Magento Configuration","sidebarTitle":"Configuration","href":"/guides/payments/magento/configuration"},{"title":"Magento Administration","sidebarTitle":"Administration","href":"/guides/payments/magento/backend"},{"title":"Magento Frontend","sidebarTitle":"Frontend","href":"/guides/payments/magento/frontend"}]},{"group":"Salesforce Commerce Cloud","pages":[{"title":"Salesforce Commerce Cloud Cartridge","sidebarTitle":"Overview","href":"/guides/payments/sfcc/overview"},{"title":"Salesforce Commerce Cloud Installation","sidebarTitle":"Installation","href":"/guides/payments/sfcc/installation"},{"title":"Salesforce Commerce Cloud Configuration","sidebarTitle":"Configuration","href":"/guides/payments/sfcc/configuration"},{"title":"Salesforce Commerce Cloud Administration","sidebarTitle":"Administration","href":"/guides/payments/sfcc/backend"},{"title":"Salesforce Commerce Cloud Frontend","sidebarTitle":"Frontend","href":"/guides/payments/sfcc/frontend"}]}]}]},{"group":"Best Practices","icon":"lightbulb","pages":[{"title":"Best practices","href":"/guides/best-practices/overview"},{"title":"Identifiers \u0026 reconciliation","sidebarTitle":"IDs \u0026 reconciliation","href":"/guides/ids"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"}]},{"group":"Resources","icon":"toolbox","pages":[{"title":"Command Line Interface (CLI)","sidebarTitle":"CLI","href":"/guides/tools/cli"},{"title":"Postman Collection","sidebarTitle":"Postman","description":null,"href":"/guides/tools/postman"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"}]},{"group":"Features","icon":"sliders","pages":[{"group":"3-D Secure","pages":[{"title":"3-D Secure","sidebarTitle":"Overview","description":null,"href":"/guides/features/3ds/overview"},{"title":"3-D Secure Setup","sidebarTitle":"Setup","href":"/guides/features/3ds/setup"},{"title":"Setup 3DS card schemes","sidebarTitle":"Schemes","href":"/guides/features/3ds/schemes"},{"title":"3-D Secure with multiple connections","sidebarTitle":"Multiple connections","href":"/guides/features/3ds/multiple-connections"},{"title":"3-D Secure in Embed","sidebarTitle":"Embed","href":"/guides/features/3ds/embed"},{"title":"Hosted 3-D Secure","sidebarTitle":"Hosted","href":"/guides/features/3ds/hosted"},{"title":"Native 3-D Secure","sidebarTitle":"Native","href":"/guides/features/3ds/native"},{"title":"Pass-through External 3-D Secure data","sidebarTitle":"External","href":"/guides/features/3ds/external"},{"title":"3DS authentication results","sidebarTitle":"Results","href":"/guides/features/3ds/statuses"},{"title":"3-D Secure testing","sidebarTitle":"Testing","href":"/guides/features/3ds/testing"},{"title":"3DS Scenarios","sidebarTitle":"Scenarios","href":"/guides/features/3ds/scenarios"}]},{"group":"Account updater","pages":[{"title":"Account Updater","sidebarTitle":"Overview","href":"/guides/features/account-updater/overview"},{"title":"Manual account updates","sidebarTitle":"Manual updates","href":"/guides/features/account-updater/integration"},{"title":"Scheduled account updates","sidebarTitle":"Scheduled updates","href":"/guides/features/account-updater/scheduler"},{"title":"Real time account updates","sidebarTitle":"Real time updates","href":"/guides/features/account-updater/real-time"}]},{"group":"AFTs","pages":[{"title":"Account funding transactions","sidebarTitle":"Overview","href":"/guides/features/account-funding-transactions/overview"}]},{"group":"Anti-fraud","pages":[{"title":"Anti-fraud","sidebarTitle":"Overview","href":"/guides/features/anti-fraud/overview"},{"title":"Anti-fraud setup","sidebarTitle":"Setup","href":"/guides/features/anti-fraud/setup"},{"title":"Silent mode","sidebarTitle":"Silent mode","href":"/guides/features/anti-fraud/silent-mode"},{"title":"Automatic anti-fraud device fingerprinting","sidebarTitle":"Fingerprints","href":"/guides/features/anti-fraud/fingerprint"},{"title":"Anti-fraud reviews","sidebarTitle":"Reviews","href":"/guides/features/anti-fraud/reviews"},{"title":"Anti-fraud simulator","sidebarTitle":"Simulator","href":"/guides/features/anti-fraud/simulator"}]},{"group":"Apple Pay","pages":[{"title":"Apple Pay","sidebarTitle":"Overview","href":"/guides/features/apple-pay/overview"},{"title":"Apple Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/apple-pay/web"},{"title":"Apple Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/apple-pay/web-without-sdk"},{"title":"Apple Pay on iOS with the SDK","sidebarTitle":"iOS with SDK","href":"/guides/features/apple-pay/ios"},{"title":"Apple Pay on iOS without the SDK","sidebarTitle":"iOS without SDK","href":"/guides/features/apple-pay/ios-without-sdk"},{"title":"Decrypted Apple Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/apple-pay/decrypted-tokens"}]},{"group":"Click to Pay","pages":[{"title":"Click to Pay","sidebarTitle":"Overview","href":"/guides/features/click-to-pay/overview"},{"title":"Click to Pay Setup","sidebarTitle":"Setup","href":"/guides/features/click-to-pay/setup"},{"title":"Customer Authentication Module (CAM)","sidebarTitle":"Customer Authentication","href":"/guides/features/click-to-pay/cam"},{"title":"Token Authentication Service (TAS)","sidebarTitle":"Token Authentication","href":"/guides/features/click-to-pay/tas"}]},{"group":"Gift Cards","pages":[{"title":"Gift Cards","sidebarTitle":"Overview","href":"/guides/features/gift-cards/overview"},{"title":"Gift card simulator","sidebarTitle":"Simulator","href":"/guides/features/gift-cards/simulator"}]},{"group":"Google Pay","pages":[{"title":"Google Pay","sidebarTitle":"Overview","href":"/guides/features/google-pay/overview"},{"title":"Google Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/google-pay/web"},{"title":"Google Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/google-pay/web-without-sdk"},{"title":"Google Pay on Android with the SDK","sidebarTitle":"Android with SDK","href":"/guides/features/google-pay/mobile"},{"title":"Google Pay on Android without the SDK","sidebarTitle":"Android without SDK","href":"/guides/features/google-pay/mobile-without-sdk"},{"title":"Decrypted Google Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/google-pay/decrypted-tokens"}]},{"group":"Guest checkout","pages":[{"title":"Guest checkout","sidebarTitle":"Overview","href":"/guides/features/guest-checkout/overview"},{"title":"Linking guests buyer details","sidebarTitle":"Buyer linking","href":"/guides/features/guest-checkout/linking"}]},{"group":"Import card data","pages":[{"title":"Vault token import","sidebarTitle":"Overview","href":"/guides/features/token-import/overview"},{"title":"Token import file creation","sidebarTitle":"Import file","mode":"wide","href":"/guides/features/token-import/token-import-file"},{"title":"Token import file upload","sidebarTitle":"Upload tokens","href":"/guides/features/token-import/token-file-transmission"},{"title":"Creating buyers \u0026 payment methods on import","sidebarTitle":"Buyers \u0026 payment methods","href":"/guides/features/token-import/buyer-payment-creation"}]},{"group":"Incremental authorization","pages":[{"title":"Incremental authorization","sidebarTitle":"Overview","href":"/guides/features/incremental-authorization/overview"}]},{"group":"Merchant accounts","pages":[{"title":"Merchant accounts","sidebarTitle":"Overview","href":"/guides/features/merchant-accounts/overview"},{"title":"Managing merchant accounts","sidebarTitle":"Accounts","href":"/guides/features/merchant-accounts/accounts"},{"title":"Users \u0026 merchant accounts","sidebarTitle":"Users","href":"/guides/features/merchant-accounts/users"},{"title":"API \u0026 merchant accounts","sidebarTitle":"API","href":"/guides/features/merchant-accounts/api"},{"title":"Embed \u0026 merchant accounts","sidebarTitle":"Embed","href":"/guides/features/merchant-accounts/embed"}]},{"group":"Multi captures","pages":[{"title":"Multi captures","sidebarTitle":"Overview","href":"/guides/features/multi-captures/overview"}]},{"group":"Network tokens","pages":[{"title":"Network tokens","sidebarTitle":"Overview","href":"/guides/features/network-tokens/overview"},{"title":"Network token implementation","sidebarTitle":"Implementation","href":"/guides/features/network-tokens/implementation"},{"title":"Network token lifecycle management","sidebarTitle":"Lifecycle","href":"/guides/features/network-tokens/lifecycle"},{"title":"Network Token Testing","sidebarTitle":"Testing","href":"/guides/features/network-tokens/testing"},{"title":"Network token pass through","sidebarTitle":"Pass through","href":"/guides/features/network-tokens/passthrough"}]},{"group":"Partial auth","pages":[{"title":"Partial authorization","sidebarTitle":"Overview","href":"/guides/features/partial-authentication/overview"}]},{"group":"Bank payments","pages":[{"title":"Bank payments","sidebarTitle":"Overview","href":"/guides/features/pay-by-bank/overview"}]},{"group":"Payment facilitators","pages":[{"title":"Payment facilitators","sidebarTitle":"Overview","href":"/guides/features/payment-facilitators/overview"}]},{"group":"Payment links","pages":[{"title":"Payment links","sidebarTitle":"Overview","href":"/guides/features/payment-links/overview"},{"title":"Sharing the payment link","sidebarTitle":"Sharing","href":"/guides/features/payment-links/sharing"},{"title":"Payment link expiration and statuses","sidebarTitle":"Expiration \u0026 Status","href":"/guides/features/payment-links/statuses"}]},{"group":"Payouts","pages":[{"title":"Payouts","sidebarTitle":"Introduction","href":"/guides/features/payouts/overview"}]},{"group":"Paze","pages":[{"title":"Paze","sidebarTitle":"Overview","href":"/guides/features/paze/overview"},{"title":"Set up Paze","sidebarTitle":"Set up","href":"/guides/features/paze/setup"},{"title":"Paze on web","sidebarTitle":"Web setup","href":"/guides/features/paze/web"},{"title":"Paze on mobile","sidebarTitle":"Mobile setup","href":"/guides/features/paze/mobile"}]},{"group":"PSP Tokenization","pages":[{"title":"PSP Tokenization","sidebarTitle":"Overview","href":"/guides/features/psp-tokenization/overview"}]},{"group":"Push payments","pages":[{"title":"Push payments","sidebarTitle":"Overview","href":"/guides/features/push-payments/overview"},{"title":"Push payments and Embed","sidebarTitle":"Embed","href":"/guides/features/push-payments/embed"}]},{"group":"Reauthorization","pages":[{"title":"Reauthorization","sidebarTitle":"Overview","href":"/guides/features/reauthorization/overview"}]},{"group":"Recurring payments","pages":[{"title":"Recurring payments","sidebarTitle":"Overview","href":"/guides/features/recurring-payments/overview"},{"title":"Common scenarios","href":"/guides/features/recurring-payments/scenarios"},{"title":"Recurring transactions with Embed","sidebarTitle":"In Embed","href":"/guides/features/recurring-payments/embed"},{"title":"Open-loop versus closed-loop","sidebarTitle":"Open or Closed-loop","href":"/guides/features/recurring-payments/open-loop"},{"title":"Recurring payments with network tokens","sidebarTitle":"Network tokens","href":"/guides/features/recurring-payments/network-tokens"},{"title":"Mastercard Transaction Link Identifier (TLID)","sidebarTitle":"Mastercard TLID","href":"/guides/features/recurring-payments/mastercard-tlid"}]},{"group":"Scheme Cards","pages":[{"title":"Card fingerprints","sidebarTitle":"Card fingerprints","href":"/guides/features/cards/fingerprints"},{"title":"Payment account references","sidebarTitle":"Payment account references","href":"/guides/features/cards/payment-account-reference"}]},{"group":"Shipment tracking","pages":[{"title":"Shipment tracking","sidebarTitle":"Overview","href":"/guides/features/shipment-tracking/overview"}]},{"group":"Simulators","pages":[{"title":"Transaction simulators","sidebarTitle":"Overview","href":"/guides/features/simulators/overview"},{"title":"Transaction simulator webhooks","sidebarTitle":"Webhooks","href":"/guides/features/simulators/webhooks"}]},{"group":"Vault Forwarding","pages":[{"title":"Enable a Vault Forward endpoint","sidebarTitle":"Enable endpoint","href":"/guides/features/vault-forwarding/enable"},{"title":"Vault Forward card data from a checkout session","sidebarTitle":"CVV \u0026 Secure Fields","href":"/guides/features/vault-forwarding/checkout-sessions"},{"title":"Forward 3DS authentication data via Vault Forward","sidebarTitle":"3DS forwarding","href":"/guides/features/vault-forwarding/3ds"},{"title":"Forward network tokens via Vault Forward","sidebarTitle":"Network tokens","href":"/guides/features/vault-forwarding/network-tokens"},{"group":"Advanced authentication","pages":[{"title":"Advanced authentication for Vault Forward","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/authentication"},{"title":"Advanced authentication for Visa","sidebarTitle":"Visa","href":"/guides/features/vault-forwarding/visa"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Introduction","href":"/guides/features/webhooks/overview"},{"title":"Webhook payload","sidebarTitle":"Payload","href":"/guides/features/webhooks/payload"},{"title":"Webhook events","sidebarTitle":"Events","mode":"wide","href":"/guides/features/webhooks/events"},{"title":"Technical webhook considerations","sidebarTitle":"Technical considerations","href":"/guides/features/webhooks/technical-considerations"},{"title":"Webhook signatures","sidebarTitle":"Signatures","href":"/guides/features/webhooks/signatures"}]}]},{"group":"Other","pages":[{"group":"Statuses","pages":[{"title":"Transaction statuses","sidebarTitle":"Transactions","href":"/guides/api/statuses/transactions"},{"title":"Payment method statuses","sidebarTitle":"Payment methods","href":"/guides/api/statuses/payment-methods"}]}]}]},{"tab":"Dashboard","icon":"circle-user","pages":[{"title":"Dashboard","href":"/guides/dashboard/overview"}]},{"tab":"Connections","icon":{"style":"light","name":"circle-nodes"},"pages":[{"title":"Connections","href":"/connections/payments/overview"}]},{"tab":"Custom Connectors","icon":"plug","hidden":true,"pages":[{"title":"Custom Connectors","href":"/guides/features/custom-connectors/overview"}]},{"tab":"Connector Requirements","icon":"clipboard-check","hidden":true,"pages":[{"title":"Connector Requirements","href":"/partners/connector-requirements/overview"}]},{"tab":"External Apps","icon":"puzzle-piece","hidden":true,"pages":[{"title":"External Apps","href":"/partners/external-apps"}]},{"tab":"API Reference","icon":{"style":"light","name":"square-terminal"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Authentication","mode":"wide","href":"/guides/api/authentication"},{"title":"Managing API keys","sidebarTitle":"API keys","mode":"wide","href":"/guides/api/api-keys"},{"title":"API Compatibility","sidebarTitle":"Compatibility","href":"/guides/api/compatibility"},{"title":"Connectivity and TLS","sidebarTitle":"Connectivity","href":"/guides/api/connectivity"},{"sidebarTitle":"JWTs","title":"Authentication with JWTs","href":"/guides/api/jwts"},{"title":"Environments","href":"/guides/api/environments"},{"title":"Error handling","sidebarTitle":"Errors","mode":"wide","href":"/guides/api/errors"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"title":"IP address forwarding","description":"Best practices on handling the original IP address for a transaction.","href":"/guides/api/ip-address-forwarding"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"},{"title":"Pagination","description":"Best practices on handling pagination in the API.","href":"/guides/api/pagination"},{"sidebarTitle":"Prefer header","title":"Prefer header","href":"/guides/api/prefer-header"},{"title":"Rate limiting","href":"/guides/api/rate-limiting"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"},{"title":"Transaction error codes","sidebarTitle":"Error Codes","mode":"wide","href":"/guides/api/error-codes"}]},{"group":"Transactions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions","title":"List transactions","href":"/reference/transactions/list-transactions"},{"openapi":"openapi.speakeasy.json POST /transactions","title":"Create transaction","href":"/reference/transactions/new-transaction"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}","title":"Get transaction","href":"/reference/transactions/get-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/capture","title":"Capture transaction","href":"/reference/transactions/capture-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/void","title":"Void transaction","href":"/reference/transactions/void-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/authorization/increment","title":"Increment transaction authorization","href":"/reference/transactions/increment-transaction-authorization"},{"group":"Captures","pages":[{"sidebarTitle":"List captures","title":"List transaction captures","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures","href":"/reference/transactions/list-transaction-captures"},{"sidebarTitle":"Get capture","title":"Get capture","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures/{capture_id}","href":"/reference/transactions/get-transaction-capture"}]},{"group":"More actions","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/events","title":"List transaction events","href":"/reference/transactions/list-transaction-events"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/actions","title":"List transaction Flow rules","href":"/reference/transactions/list-transaction-actions"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/sync","title":"Sync transaction","href":"/reference/transactions/sync-transaction"},{"title":"Update a transaction","openapi":"openapi.speakeasy.json PUT /transactions/{transaction_id}","href":"/reference/transactions/update-transaction"},{"title":"Cancel a transaction","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/cancel","href":"/reference/transactions/cancel-transaction"},{"title":"Get or update transaction session","sidebarTitle":"Get session","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/session","href":"/reference/transactions/get-transaction-session"}]}]},{"group":"Buyers","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /buyers","title":"List all buyers","href":"/reference/buyers/list-buyers"},{"openapi":"openapi.speakeasy.json POST /buyers","title":"Add a buyer","href":"/reference/buyers/new-buyer"},{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}","title":"Get a buyer","href":"/reference/buyers/get-buyer"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}","title":"Update a buyer","href":"/reference/buyers/update-buyer"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}","title":"Delete a buyer","href":"/reference/buyers/delete-buyer"},{"group":"Shipping details","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}/shipping-details","title":"List a buyer's shipping details","href":"/reference/buyers/get-buyer-shipping-details"},{"openapi":"openapi.speakeasy.json POST /buyers/{buyer_id}/shipping-details","title":"Add buyer shipping details","href":"/reference/buyers/new-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Update a buyer's shipping details","href":"/reference/buyers/update-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Delete a buyer's shipping details","href":"/reference/buyers/delete-buyer-shipping-detail"}]}]},{"group":"Checkout Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","href":"/reference/checkout-sessions/new-checkout-session"},{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/get-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/update-checkout-session"},{"openapi":"openapi.speakeasy.json DELETE /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/delete-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}/fields","sidebarTitle":"Update session fields","title":null,"href":"/reference/checkout-sessions/update-checkout-session-fields"}]},{"group":"Payment links","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payment-links","title":"List all payment links","href":"/reference/payment-links/list-payment-links"},{"openapi":"openapi.speakeasy.json POST /payment-links","title":"Add a payment link","href":"/reference/payment-links/new-payment-link"},{"openapi":"openapi.speakeasy.json GET /payment-links/{payment_link_id}","title":"Get payment link","href":"/reference/payment-links/get-payment-link"},{"openapi":"openapi.speakeasy.json POST /payment-links/{payment_link_id}/expire","title":"Expire a payment link","href":"/reference/payment-links/expire-payment-link"}]},{"group":"Payment options","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-options","title":"List payment options","href":"/reference/payment-options/list-payment-options"}]},{"group":"Payouts","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payouts","title":"List payouts created","href":"/reference/payouts/list-payouts"},{"openapi":"openapi.speakeasy.json POST /payouts","title":"Create a payout","href":"/reference/payouts/new-payout"},{"openapi":"openapi.speakeasy.json GET /payouts/{payout_id}","title":"Get a payout","href":"/reference/payouts/get-payout"}]},{"group":"Refunds","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refunds","title":"List transaction refunds","href":"/reference/transactions/list-transaction-refunds"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds","title":"Create transaction refund","href":"/reference/transactions/refund-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds/all","sidebarTitle":"Refund all instruments","title":"Create batch transaction refund","href":"/reference/transactions/refund-all"},{"sidebarTitle":"Get refund","title":"Get refund","openapi":"openapi.speakeasy.json GET /refunds/{refund_id}","href":"/reference/transactions/get-refund"}]},{"group":"Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-service-definitions/{payment_service_definition_id}/sessions","sidebarTitle":"Get session","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session"},{"openapi":"openapi.speakeasy.json POST /payment-services/{payment_service_id}/sessions","sidebarTitle":"Get session by ID","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session-by-id"}]},{"group":"Settlement records","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements","sidebarTitle":"List settlement records","title":"List transaction settlements","href":"/reference/settlements/list-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements/{settlement_id}","sidebarTitle":"Get settlement record","title":"Get transaction settlement","href":"/reference/settlements/get-settlement"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements","sidebarTitle":"List refund settlement records","title":"List transaction refund settlements","href":"/reference/settlements/list-refund-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements/{settlement_id}","sidebarTitle":"Get refund settlement record","title":"Get transaction refund settlement","href":"/reference/settlements/get-refund-settlement"}]},{"group":"Disputes","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargebacks","sidebarTitle":"List chargeback records","title":"List transaction chargebacks","href":"/reference/disputes/list-chargebacks"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargeback-reversals","sidebarTitle":"List chargeback reversal records","title":"List transaction chargeback reversals","href":"/reference/disputes/list-chargeback-reversals"}]},{"group":"Instruments","icon":"code","pages":[{"group":"Card schemes","pages":[{"openapi":"openapi.speakeasy.json GET /card-scheme-definitions","title":"List card scheme definitions","href":"/reference/card-schemes/list-card-scheme-definitions"}]},{"group":"Card details","pages":[{"openapi":"openapi.speakeasy.json GET /card-details","title":"Get card details","href":"/reference/card-details/get-card-details"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/apple/session","title":"Create a Apple Pay session","href":"/reference/digital-wallets/get-apple-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/google/session","title":"Create a Google Pay session","href":"/reference/digital-wallets/get-google-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/click-to-pay/session","title":"Create a Click to Pay session","href":"/reference/digital-wallets/get-click-to-pay-session"}]},{"group":"Gift cards","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/gift-cards","title":"List gift cards for a buyer","href":"/reference/gift-cards/list-buyer-gift-cards"},{"openapi":"openapi.speakeasy.json GET /gift-cards","title":"List gift cards","href":"/reference/gift-cards/list-gift-cards"},{"openapi":"openapi.speakeasy.json POST /gift-cards/balances","title":"Verify and get gift card balances","sidebarTitle":"Verify \u0026 get balance","href":"/reference/gift-cards/list-gift-card-balances"},{"openapi":"openapi.speakeasy.json POST /gift-cards","title":"Create gift card","href":"/reference/gift-cards/new-gift-card"},{"openapi":"openapi.speakeasy.json GET /gift-cards/{gift_card_id}","title":"Get gift card","href":"/reference/gift-cards/get-gift-card"},{"openapi":"openapi.speakeasy.json DELETE /gift-cards/{gift_card_id}","title":"Delete a gift card","href":"/reference/gift-cards/delete-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/issuances","title":"Issue a gift card","href":"/reference/gift-cards/issue-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/activations","title":"Activate a gift card","href":"/reference/gift-cards/activate-gift-card"}]},{"group":"Payment methods","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/payment-methods","title":"List payment methods for a buyer","href":"/reference/payment-methods/list-buyer-payment-methods"},{"openapi":"openapi.speakeasy.json GET /payment-methods","title":"List all payment methods","href":"/reference/payment-methods/list-payment-methods"},{"openapi":"openapi.speakeasy.json POST /payment-methods","title":"Create payment method","href":"/reference/payment-methods/new-payment-method"},{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}","title":"Get payment method","href":"/reference/payment-methods/get-payment-method"},{"openapi":"openapi.speakeasy.json PUT /payment-methods/{payment_method_id}","title":"Update payment method","href":"/reference/payment-methods/update-payment-method"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}","title":"Delete payment method","href":"/reference/payment-methods/delete-payment-method"}]},{"group":"Payment method definitions","pages":[{"openapi":"openapi.speakeasy.json GET /payment-method-definitions","title":"List payment method definitions","href":"/reference/payment-method-definitions/list-payment-method-definitions"}]}]},{"group":"Vault","icon":"code","pages":[{"group":"Account updater","pages":[{"openapi":"openapi.speakeasy.json POST /account-updater/jobs","sidebarTitle":"Create a job","title":"Create account updater job","href":"/reference/account-updater/new-account-updater-job"}]},{"group":"Network tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/network-tokens","title":"List network tokens","href":"/reference/network-tokens/list-network-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens","title":"Provision network token","href":"/reference/network-tokens/provision-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram","title":"Provision network token cryptogram","href":"/reference/network-tokens/get-network-token-cryptogram"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend","title":"Suspend network token","href":"/reference/network-tokens/suspend-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume","title":"Resume network token","href":"/reference/network-tokens/resume-network-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/network-tokens/{network_token_id}","title":"Delete network token","href":"/reference/network-tokens/delete-network-token"}]},{"group":"Payment service tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/payment-service-tokens","title":"List payment service tokens","href":"/reference/payment-service-tokens/list-payment-service-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/payment-service-tokens","title":"Create payment service token","href":"/reference/payment-service-tokens/provision-payment-service-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}","title":"Delete payment service token","href":"/reference/payment-service-tokens/delete-payment-service-token"}]},{"group":"Vault Forward","pages":[{"openapi":"openapi.v1.json POST /vault-forward","title":"Forward PCI data","href":"/reference/vault-forwarding/make-vault-forward"}]},{"group":"Vault Forward endpoints","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs","sidebarTitle":"List endpoints","title":"List configured Vault Forward endpoints","href":"/reference/vault-forwarding/list-vault-forward-configs"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}","sidebarTitle":"Get endpoint","title":"Get configured Vault Forward endpoints","href":"/reference/vault-forwarding/get-vault-forward-config"}]},{"group":"Vault Forward authentication","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Get authentications","title":"List configured Vault Forward authentication methods","href":"/reference/vault-forwarding/list-vault-forward-authentications"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Get authentication","title":"Get Vault Forward authentication method","href":"/reference/vault-forwarding/get-vault-forward-authentication"},{"openapi":"openapi.v1.json POST /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Add authentication","title":"Adds new Vault Forward authentication method","href":"/reference/vault-forwarding/add-vault-forward-authentication"},{"openapi":"openapi.v1.json PUT /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Update authentication","title":"Update Vault Forward authentication method","href":"/reference/vault-forwarding/update-vault-forward-authentication"},{"openapi":"openapi.v1.json DELETE /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Remove authentication","title":"Remove a Vault Forward authentication method","href":"/reference/vault-forwarding/delete-vault-forward-authentication"}]}]},{"group":"PSPs \u0026 Gateways","icon":"code","pages":[{"group":"All services","pages":[{"openapi":"openapi.v1.json GET /connections","title":"List connections","href":"/reference/connections/list-connections"},{"openapi":"openapi.speakeasy.json GET /connection-definitions","title":null,"href":"/reference/connections/list-connection-definitions"}]},{"group":"Payment services","pages":[{"openapi":"openapi.speakeasy.json GET /payment-service-definitions/{payment_service_definition_id}","sidebarTitle":"Get service definition","title":"Get a payment service definition","href":"/reference/payment-service-definitions/get-payment-service-definition"},{"openapi":"openapi.speakeasy.json GET /payment-services","title":"List payment services","href":"/reference/payment-services/list-payment-services"},{"openapi":"openapi.speakeasy.json POST /payment-services","title":"Configure a payment service","href":"/reference/payment-services/new-payment-service"},{"openapi":"openapi.speakeasy.json GET /payment-services/{payment_service_id}","title":"Get payment service","href":"/reference/payment-services/get-payment-service"},{"openapi":"openapi.speakeasy.json PUT /payment-services/{payment_service_id}","title":"Update a configured payment service","href":"/reference/payment-services/update-payment-service"},{"openapi":"openapi.speakeasy.json DELETE /payment-services/{payment_service_id}","title":"Delete a configured payment service","href":"/reference/payment-services/delete-payment-service"},{"openapi":"openapi.speakeasy.json POST /payment-services/verify","sidebarTitle":"Verify credentials","title":"Verify payment service credentials","href":"/reference/payment-services/verify-payment-service"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json GET /digital-wallets","title":"List digital wallets","href":"/reference/digital-wallets/list-digital-wallets"},{"openapi":"openapi.speakeasy.json GET /digital-wallets/{digital_wallet_id}","title":"Get digital wallet","href":"/reference/digital-wallets/get-digital-wallet"},{"openapi":"openapi.speakeasy.json POST /digital-wallets","title":"Register digital wallet","href":"/reference/digital-wallets/register-digital-wallet"},{"openapi":"openapi.speakeasy.json PUT /digital-wallets/{digital_wallet_id}","title":"Update digital wallet","href":"/reference/digital-wallets/update-digital-wallet"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}","title":"Delete digital wallet","href":"/reference/digital-wallets/deregister-digital-wallet"},{"group":"Domain registration","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/{digital_wallet_id}/domains","title":"Register a digital wallet domain","href":"/reference/digital-wallets/new-digital-wallet-domain"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}/domains","title":"Remove a digital wallet domain","href":"/reference/digital-wallets/delete-digital-wallet-domain"}]},{"group":"Mobile Certificates (Apple Pay)","pages":[{"openapi":"openapi.v1.json GET /apple-pay-certificates","sidebarTitle":"List certificates","title":"List Apple Pay certificates","href":"/reference/digital-wallets/list-apple-pay-certificates"},{"openapi":"openapi.v1.json POST /apple-pay-certificates","sidebarTitle":"Create certificate","title":"New Apple Pay certificate","href":"/reference/digital-wallets/create-apple-pay-certificate"},{"openapi":"openapi.v1.json PUT /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Update certificate","title":"Update Apple Pay certificate","href":"/reference/digital-wallets/update-apple-pay-certificate"},{"openapi":"openapi.v1.json DELETE /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Delete certificate","title":"Remove Apple Pay certificate","href":"/reference/digital-wallets/delete-apple-pay-certificate"}]}]},{"group":"Anti-fraud services","pages":[{"openapi":"openapi.v1.json GET /anti-fraud-service-definitions/{anti_fraud_service_definition_id}","sidebarTitle":"Get service definition","title":"Get anti fraud service definition","href":"/reference/anti-fraud-services/get-anti-fraud-service-definition"},{"openapi":"openapi.v1.json POST /anti-fraud-services","title":"New anti-fraud service","href":"/reference/anti-fraud-services/new-anti-fraud-service"},{"openapi":"openapi.v1.json GET /anti-fraud-services/{anti_fraud_service_id}","title":"Get anti-fraud service","href":"/reference/anti-fraud-services/get-anti-fraud-service"},{"openapi":"openapi.v1.json PUT /anti-fraud-services/{anti_fraud_service_id}","title":"Update anti-fraud service","href":"/reference/anti-fraud-services/update-anti-fraud-service"},{"openapi":"openapi.v1.json DELETE /anti-fraud-services/{anti_fraud_service_id}","title":"Delete anti-fraud service","href":"/reference/anti-fraud-services/delete-anti-fraud-service"}]},{"group":"Gift-card services","pages":[{"openapi":"openapi.v1.json GET /gift-card-service-definitions/{gift_card_service_definition_id}","sidebarTitle":"Get service definition","title":"Get gift card service definition","href":"/reference/gift-card-services/get-gift-card-service-definition"},{"openapi":"openapi.v1.json POST /gift-card-services","title":"New gift card service","href":"/reference/gift-card-services/new-gift-card-service"},{"openapi":"openapi.v1.json GET /gift-card-services/{gift_card_service_id}","title":"Get gift card service","href":"/reference/gift-card-services/get-gift-card-service"},{"openapi":"openapi.v1.json PUT /gift-card-services/{gift_card_service_id}","title":"Update gift card service","href":"/reference/gift-card-services/update-gift-card-service"},{"openapi":"openapi.v1.json DELETE /gift-card-services/{gift_card_service_id}","title":"Delete gift card service","href":"/reference/gift-card-services/delete-gift-card-service"}]}]},{"group":"Errors","icon":"code","pages":[{"title":"Client-side errors (4XX)","sidebarTitle":"Client errors","href":"/reference/errors/client-errors"},{"title":"Server-side errors (5XX)","sidebarTitle":"Server errors","href":"/reference/errors/server-errors"},{"openapi":"openapi.v1.json GET /api-logs","title":"List 4XX errors","href":"/reference/logs/list-api-error-logs"}]},{"group":"Other","icon":"code","pages":[{"group":"API keys","pages":[{"openapi":"openapi.speakeasy.json GET /api-key-pairs","sidebarTitle":"List API keys","title":"List all API key pairs","href":"/reference/api-key-pairs/list-api-key-pairs"},{"openapi":"openapi.speakeasy.json POST /api-key-pairs","sidebarTitle":"Create API key","title":"Create an API key pair","href":"/reference/api-key-pairs/new-api-key-pair"},{"openapi":"openapi.speakeasy.json GET /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Get API key","title":"Get an API key pair","href":"/reference/api-key-pairs/get-api-key-pair"},{"openapi":"openapi.speakeasy.json PUT /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Update API key","title":"Update an API key pair","href":"/reference/api-key-pairs/update-api-key-pair"},{"openapi":"openapi.speakeasy.json DELETE /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Delete API key","title":"Delete an API key pair","href":"/reference/api-key-pairs/delete-api-key-pair"}]},{"group":"3DS Configuration","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"List 3DS configuration","sidebarTitle":"List 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"Add 3DS configuration","sidebarTitle":"Add 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Update 3DS configuration","sidebarTitle":"Update 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration"},{"openapi":"openapi.speakeasy.json DELETE /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Delete 3DS configuration","sidebarTitle":"Delete 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration"}]},{"group":"3DS Scenarios","pages":[{"openapi":"openapi.speakeasy.json GET /three-ds-scenarios","title":"List 3DS scenario","href":"/reference/three-ds-scenarios/list-three-ds-scenarios"},{"openapi":"openapi.speakeasy.json POST /three-ds-scenarios","title":"Create a 3DS scenario","href":"/reference/three-ds-scenarios/new-three-ds-scenario"},{"openapi":"openapi.speakeasy.json PUT /three-ds-scenarios/{three_ds_scenario_id}","title":"Update a 3DS scenario","href":"/reference/three-ds-scenarios/update-three-ds-scenario"},{"openapi":"openapi.speakeasy.json DELETE /three-ds-scenarios/{three_ds_scenario_id}","title":"Delete a 3DS scenario","href":"/reference/three-ds-scenarios/delete-three-ds-scenario"}]},{"group":"Flow","pages":[{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","href":"/reference/flow/list-rules"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Get rule","href":"/reference/flow/get-rule"},{"openapi":"openapi.v1.json POST /flows/{flow}/actions/{action}/rules","title":"Create flow rule","href":"/reference/flow/new-rule"},{"openapi":"openapi.v1.json PUT /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Update flow rule","href":"/reference/flow/update-rule"},{"openapi":"openapi.v1.json DELETE /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Delete flow rule","href":"/reference/flow/delete-rule"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/outcomes","title":"List flow outcomes","href":"/reference/flow/list-outcomes"}]},{"group":"Merchant accounts","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts","title":"List all merchant accounts","href":"/reference/merchant-accounts/list-merchant-accounts"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts","title":"Create a merchant account","href":"/reference/merchant-accounts/new-merchant-account"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}","title":"Update a merchant account","href":"/reference/merchant-accounts/update-merchant-account"}]},{"group":"Reports","pages":[{"openapi":"openapi.speakeasy.json GET /reports","title":"List configured reports","href":"/reference/reports/list-reports"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}","title":"Get a report","href":"/reference/reports/get-report"},{"openapi":"openapi.speakeasy.json POST /reports","title":"Add a report","href":"/reference/reports/new-report"},{"openapi":"openapi.speakeasy.json PUT /reports/{report_id}","title":"Update a report","href":"/reference/reports/update-report"}]},{"group":"Report executions","pages":[{"openapi":"openapi.speakeasy.json GET /report-executions","title":"List executed reports","href":"/reference/reports/list-all-report-executions"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}/executions","title":"List executions for report","href":"/reference/reports/list-executions-for-report"},{"openapi":"openapi.speakeasy.json GET /report-executions/{report_execution_id}","title":"Get executed report","href":"/reference/reports/get-report-execution"},{"openapi":"openapi.speakeasy.json POST /reports/{report_id}/executions/{report_execution_id}/url","title":"Create URL for executed report","href":"/reference/reports/generate-download-url"}]},{"group":"Roles","pages":[{"openapi":"openapi.speakeasy.json GET /roles","sidebarTitle":"List roles","title":"List all roles","href":"/reference/roles/list-roles"}]},{"group":"Users","pages":[{"openapi":"openapi.speakeasy.json GET /audit-logs","title":"List audit log entries","href":"/reference/audit-logs/list-audit-logs"}]},{"group":"Webhook subscriptions","pages":[{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions","sidebarTitle":"List subscriptions","title":"List webhook subscriptions","href":"/reference/webhook-subscriptions/list-webhook-subscriptions"},{"openapi":"openapi.speakeasy.json POST /webhook-subscriptions","sidebarTitle":"New subscription","title":"Create webhook subscription","href":"/reference/webhook-subscriptions/new-webhook-subscription"},{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions/{subscription_id}","sidebarTitle":"Get subscription","title":"Get webhook subscription","href":"/reference/webhook-subscriptions/get-webhook-subscription"},{"openapi":"openapi.speakeasy.json PUT /webhook-subscriptions/{subscription_id}","sidebarTitle":"Update subscription","title":"Update webhook subscription","href":"/reference/webhook-subscriptions/update-webhook-subscription"},{"openapi":"openapi.speakeasy.json DELETE /webhook-subscriptions/{subscription_id}","sidebarTitle":"Delete subscription","title":"Delete webhook subscription","href":"/reference/webhook-subscriptions/delete-webhook-subscription"}]}]}]},{"tab":"Updates","icon":"bullhorn","pages":[{"title":"Updates","href":"/updates"}]}]},"title":"OpenAPI 3.1.0 Specification - Gr4vy","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":[],"chunks":[]}