{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Lightspark Docs","description":"Lightspark Grid is an API for global payments across fiat, stablecoins, and Bitcoin. This documentation helps developers understand the Grid API and integrate with it.","colors":{"primary":"#1A1A1A","light":"#f0f0ee","dark":"#00B3E0"},"logo":{"light":"https://mintcdn.com/agents-docs/YKCmEU4MWMlPER9B/logo/light.svg?fit=max\u0026auto=format\u0026n=YKCmEU4MWMlPER9B\u0026q=85\u0026s=94c3cecafe700f5f98421f0d9a80ed22","dark":"https://mintcdn.com/agents-docs/YKCmEU4MWMlPER9B/logo/dark.svg?fit=max\u0026auto=format\u0026n=YKCmEU4MWMlPER9B\u0026q=85\u0026s=585939b913aba9ee29e0ec1fd334d026"},"favicon":{"light":"https://mintcdn.com/agents-docs/qL8kqlSYbvexR8cg/favicon-light.svg?fit=max\u0026auto=format\u0026n=qL8kqlSYbvexR8cg\u0026q=85\u0026s=80b3d230ea38ea7b571ddcc0474e21fa","dark":"https://mintcdn.com/agents-docs/qL8kqlSYbvexR8cg/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qL8kqlSYbvexR8cg\u0026q=85\u0026s=25bab6c1495aa2f1d260567d46638ac0"},"api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","kotlin"],"prefill":true}},"background":{"color":{"light":"#F8F8F7","dark":"#000000"}},"navbar":{"links":[{"icon":"github","href":"https://github.com/lightsparkdev/grid-api","label":"GitHub"},{"href":"https://www.lightspark.com/contact","label":"Book a live demo"},{"href":"https://app.lightspark.com/login","label":"Dashboard"}]},"footer":{},"seo":{},"fonts":{"heading":{"family":"Suisse Intl","weight":500,"source":"fonts/suisse-intl/SuisseIntl-Medium.woff2","format":"woff2"},"body":{"family":"Suisse Intl","weight":400,"source":"fonts/suisse-intl/SuisseIntl-Regular.woff2","format":"woff2"}},"integrations":{"amplitude":{"apiKey":"7f2e340589501177fa6f8a5cc7b6bc51"},"gtm":{"tagId":"GTM-5R5NP3DS"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/agents-docs/YKCmEU4MWMlPER9B/images/og/og-api-reference-generic.png?fit=max\u0026auto=format\u0026n=YKCmEU4MWMlPER9B\u0026q=85\u0026s=d99cb0beb6266d8bff4e9c34a1612ec6"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"agents-docs","hasAudioNarration":false,"actualSubdomain":"agents-docs","customDomains":["agents-docs.lightspark.com"],"gitSource":{"type":"github","owner":"lightsparkdev","repo":"grid-api","deployBranch":"lightspark-agents","contentDirectory":"mintlify","isPrivate":false,"mountPath":"","label":"","_id":"6af61615a14da7b1b52e01b9"},"entitlements":{},"buildId":"6af61a6ff3f9153be45c6d67","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API reference","count":267},{"language":"default","tag":"API documentation","count":261},{"language":"default","tag":"Agent Operations","count":47},{"language":"default","tag":"Cards","count":35},{"language":"default","tag":"Payouts \u0026 B2B","count":30},{"language":"default","tag":"Overview","count":28},{"language":"default","tag":"Global Accounts","count":25},{"language":"default","tag":"Agent Management","count":25},{"language":"default","tag":"Global P2P","count":23},{"language":"default","tag":"Strong Customer Authentication","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/agents-docs/1d0cf883a2567caa/style.css"}],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","icon":"/images/icons/key2.svg","og:image":"/images/og/og-api-reference.png","description":null,"href":"/api-reference/authentication"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const topLevelProductName=`Grid`;function _createMdxContent(props){const _components={br:`br`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[topLevelProductName,` API uses HTTP Basic Authentication with your client ID as the username and your client secret as the password.`,_jsx(_components.br,{}),`\n`,_jsx(Note,{children:`Your API tokens are scoped to either your production or sandbox environment.`})]}),`\n`,_jsx(CodeBlock,{filename:``,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:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -u`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{client_id}:{client_secret}\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.lightspark.com/grid/2025-10-13...`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{topLevelProductName,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Authentication","icon":"/images/icons/key2.svg","og:image":"/images/og/og-api-reference.png","description":null,"href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[497,530,"`Grid`,` API uses HT"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/agents-docs/da7b02c7798913d5/corridor-fields.js","/_mintlify/custom/agents-docs/46fa8cc4a502b704/css-perf-patch.js","/_mintlify/custom/agents-docs/7ebeec8d40dffb19/homepage.js","/_mintlify/custom/agents-docs/a16fef7178995133/sidebar-toggle.js"],"subdomain":"agents-docs","siteName":"Lightspark Docs","title":"Authentication - Lightspark Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T19:59:08.403Z","originalFileLocation":"api-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=\"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=\"Lightspark Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_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/agents-docs/e3zkJp4JfPOIuMQu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Lightspark Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lightspark Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://agents-docs.lightspark.com/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agents-docs.mintlify.site/images/og/og-api-reference.png\">\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 - Lightspark Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agents-docs.mintlify.site/images/og/og-api-reference.png\">\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/agents-docs/e3zkJp4JfPOIuMQu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lightspark Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://agents-docs.lightspark.com/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://agents-docs.lightspark.com/#organization\",\"name\":\"Lightspark Docs\",\"url\":\"https://agents-docs.lightspark.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/agents-docs/YKCmEU4MWMlPER9B/logo/light.svg?fit=max\u0026auto=format\u0026n=YKCmEU4MWMlPER9B\u0026q=85\u0026s=94c3cecafe700f5f98421f0d9a80ed22\"}},{\"@type\":\"WebSite\",\"@id\":\"https://agents-docs.lightspark.com#website\",\"name\":\"Lightspark Docs\",\"url\":\"https://agents-docs.lightspark.com\",\"publisher\":{\"@id\":\"https://agents-docs.lightspark.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://agents-docs.lightspark.com/api-reference/authentication#webpage\",\"url\":\"https://agents-docs.lightspark.com/api-reference/authentication\",\"name\":\"Authentication\",\"dateModified\":\"2026-11-12T19:59:08.403Z\",\"isPartOf\":{\"@id\":\"https://agents-docs.lightspark.com#website\"},\"breadcrumb\":{\"@id\":\"https://agents-docs.lightspark.com/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://agents-docs.lightspark.com/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Using the API\",\"item\":\"https://agents-docs.lightspark.com/api-reference/environments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://agents-docs.lightspark.com/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://agents-docs.lightspark.com/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"url\":\"https://agents-docs.lightspark.com/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://agents-docs.lightspark.com/api-reference/authentication#webpage\"},\"image\":\"https://agents-docs.lightspark.com/images/og/og-api-reference.png\",\"dateModified\":\"2026-11-12T19:59:08.403Z\",\"publisher\":{\"@id\":\"https://agents-docs.lightspark.com/#organization\"},\"isPartOf\":{\"@id\":\"https://agents-docs.lightspark.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lightspark Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Lightspark Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"Lightspark Docs","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Build your flow","pages":[{"title":"Build your flow","href":"/flow-builder"}]},{"tab":"Global Accounts","pages":[{"title":"Global Accounts","href":"/global-accounts/demo"}]},{"tab":"Agent Accounts","pages":[{"title":"Agent Accounts","href":"/agent-accounts/demo"}]},{"tab":"Payouts \u0026 B2B","pages":[{"title":"Payouts \u0026 B2B","href":"/payouts-and-b2b"}]},{"tab":"Ramps","pages":[{"title":"Ramps","href":"/ramps"}]},{"tab":"Global P2P","pages":[{"title":"Global P2P","href":"/global-p2p"}]},{"tab":"Cards","pages":[{"title":"Cards","href":"/cards/demo"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"API reference","groups":[{"group":"Using the API","pages":[{"title":"Environments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/globe.svg","href":"/api-reference/environments"},{"title":"Core Concepts","description":"Core concepts and terminology for the Grid API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/file-text.svg","href":"/api-reference/terminology"},{"title":"Authentication","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/key2.svg","href":"/api-reference/authentication"},{"title":"Webhooks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/bell.svg","description":"Learn how to receive and verify webhook notifications from the Grid API","href":"/api-reference/webhooks"},{"title":"Sandbox Testing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/hammer.svg","href":"/api-reference/sandbox-testing"},{"title":"CLI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/agents-docs/images/icons/code.svg","href":"/api-reference/cli"}]},{"group":"API documentation","pages":[{"group":"Platform Configuration","pages":[{"title":"Get platform configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /config","href":"/api-reference/platform-configuration/get-platform-configuration"},{"title":"Update platform configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /config","href":"/api-reference/platform-configuration/update-platform-configuration"}]},{"group":"Exchange Rates","pages":[{"title":"Get exchange rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange-rates","href":"/api-reference/exchange-rates/get-exchange-rates"}]},{"group":"Discoveries","pages":[{"title":"List available receiving institution names","deprecated":null,"version":null,"openapi":"/openapi.yaml get /discoveries","href":"/api-reference/discoveries/list-available-receiving-institution-names"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Add a new customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers","href":"/api-reference/customers/add-a-new-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Delete customer by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/{customerId}","href":"/api-reference/customers/delete-customer-by-id"},{"title":"Update customer by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /customers/{customerId}","href":"/api-reference/customers/update-customer-by-id"},{"title":"Add an individual customer from a reusable KYC share token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/share","href":"/api-reference/customers/add-an-individual-customer-from-a-reusable-kyc-share-token"},{"title":"List the current Grid agreement documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/agreements","href":"/api-reference/customers/list-the-current-grid-agreement-documents"},{"title":"Get the current Grid End User Terms","deprecated":true,"version":null,"openapi":"/openapi.yaml get /customers/end-user-terms","href":"/api-reference/customers/get-the-current-grid-end-user-terms"},{"title":"Upload customers via CSV file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/bulk/csv","href":"/api-reference/customers/upload-customers-via-csv-file"},{"title":"Get bulk import job status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/bulk/jobs/{jobId}","href":"/api-reference/customers/get-bulk-import-job-status"}]},{"group":"KYC/KYB Verifications","pages":[{"title":"Generate a hosted KYC/KYB link for an existing customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/kyc-link","href":"/api-reference/kyckyb-verifications/generate-a-hosted-kyckyb-link-for-an-existing-customer"},{"title":"List beneficial owners","deprecated":null,"version":null,"openapi":"/openapi.yaml get /beneficial-owners","href":"/api-reference/kyckyb-verifications/list-beneficial-owners"},{"title":"Create a beneficial owner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /beneficial-owners","href":"/api-reference/kyckyb-verifications/create-a-beneficial-owner"},{"title":"Get a beneficial owner","deprecated":null,"version":null,"openapi":"/openapi.yaml get /beneficial-owners/{beneficialOwnerId}","href":"/api-reference/kyckyb-verifications/get-a-beneficial-owner"},{"title":"Delete a beneficial owner","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /beneficial-owners/{beneficialOwnerId}","href":"/api-reference/kyckyb-verifications/delete-a-beneficial-owner"},{"title":"Update a beneficial owner","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /beneficial-owners/{beneficialOwnerId}","href":"/api-reference/kyckyb-verifications/update-a-beneficial-owner"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /verifications","href":"/api-reference/kyckyb-verifications/list-verifications"},{"title":"Submit customer for verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /verifications","href":"/api-reference/kyckyb-verifications/submit-customer-for-verification"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /verifications/{verificationId}","href":"/api-reference/kyckyb-verifications/get-a-verification"}]},{"group":"Agent Management","pages":[{"title":"List stored cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customerId}/stored-cards","href":"/api-reference/agent-management/list-stored-cards"},{"title":"Store a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/stored-cards","href":"/api-reference/agent-management/store-a-card"},{"title":"Get a stored card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customerId}/stored-cards/{storedCardId}","href":"/api-reference/agent-management/get-a-stored-card"},{"title":"Remove a stored card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/{customerId}/stored-cards/{storedCardId}","href":"/api-reference/agent-management/remove-a-stored-card"},{"title":"Let an agent use a stored card","deprecated":null,"version":null,"openapi":"/openapi.yaml put /customers/{customerId}/stored-cards/{storedCardId}/agents/{agentId}","href":"/api-reference/agent-management/let-an-agent-use-a-stored-card"},{"title":"Stop an agent using a stored card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/{customerId}/stored-cards/{storedCardId}/agents/{agentId}","href":"/api-reference/agent-management/stop-an-agent-using-a-stored-card"},{"title":"Reveal a stored card to its owner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/stored-cards/{storedCardId}/reveal","href":"/api-reference/agent-management/reveal-a-stored-card-to-its-owner"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents","href":"/api-reference/agent-management/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents","href":"/api-reference/agent-management/create-an-agent"},{"title":"List agent transaction approval requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/approvals","href":"/api-reference/agent-management/list-agent-transaction-approval-requests"},{"title":"List spending pools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /spending-pools","href":"/api-reference/agent-management/list-spending-pools"},{"title":"Create a spending pool","deprecated":null,"version":null,"openapi":"/openapi.yaml post /spending-pools","href":"/api-reference/agent-management/create-a-spending-pool"},{"title":"Get a spending pool","deprecated":null,"version":null,"openapi":"/openapi.yaml get /spending-pools/{spendingPoolId}","href":"/api-reference/agent-management/get-a-spending-pool"},{"title":"Archive a spending pool","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /spending-pools/{spendingPoolId}","href":"/api-reference/agent-management/archive-a-spending-pool"},{"title":"Update a spending pool","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /spending-pools/{spendingPoolId}","href":"/api-reference/agent-management/update-a-spending-pool"},{"title":"Get agent by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}","href":"/api-reference/agent-management/get-agent-by-id"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}","href":"/api-reference/agent-management/delete-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}","href":"/api-reference/agent-management/update-agent"},{"title":"Update agent policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/policy","href":"/api-reference/agent-management/update-agent-policy"},{"title":"Regenerate a device code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/device-codes","href":"/api-reference/agent-management/regenerate-a-device-code"},{"title":"Hand a deleted agent's card to an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/card-handover","href":"/api-reference/agent-management/hand-a-deleted-agents-card-to-an-agent"},{"title":"Approve an agent action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/actions/{actionId}/approve","href":"/api-reference/agent-management/approve-an-agent-action"},{"title":"Reject an agent action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/actions/{actionId}/reject","href":"/api-reference/agent-management/reject-an-agent-action"},{"title":"Get device code status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/device-codes/status","href":"/api-reference/agent-management/get-device-code-status"},{"title":"Redeem device code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/device-codes/redeem","href":"/api-reference/agent-management/redeem-device-code"}]},{"group":"Contact Verification","pages":[{"title":"Send an email verification code to a customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/verify-email","href":"/api-reference/contact-verification/send-an-email-verification-code-to-a-customer"},{"title":"Confirm a customer's email verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/verify-email/confirm","href":"/api-reference/contact-verification/confirm-a-customers-email-verification-code"},{"title":"Send a phone verification code to a customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/verify-phone","href":"/api-reference/contact-verification/send-a-phone-verification-code-to-a-customer"},{"title":"Confirm a customer's phone verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customerId}/verify-phone/confirm","href":"/api-reference/contact-verification/confirm-a-customers-phone-verification-code"}]},{"group":"Strong Customer Authentication","pages":[{"title":"List enrolled SCA factors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sca/factors","href":"/api-reference/strong-customer-authentication/list-enrolled-sca-factors"},{"title":"Start SCA factor enrollment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/factors","href":"/api-reference/strong-customer-authentication/start-sca-factor-enrollment"},{"title":"Confirm SCA factor enrollment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/factors/confirm","href":"/api-reference/strong-customer-authentication/confirm-sca-factor-enrollment"},{"title":"Delete an enrolled SCA factor","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /sca/factors/{credentialId}","href":"/api-reference/strong-customer-authentication/delete-an-enrolled-sca-factor"},{"title":"Start an SCA login","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/login/start","href":"/api-reference/strong-customer-authentication/start-an-sca-login"},{"title":"Complete an SCA login","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/login/complete","href":"/api-reference/strong-customer-authentication/complete-an-sca-login"},{"title":"Record a security event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/record-event","href":"/api-reference/strong-customer-authentication/record-a-security-event"},{"title":"Start a 2FA reset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/factors/reset","href":"/api-reference/strong-customer-authentication/start-a-2fa-reset"},{"title":"Get 2FA reset status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sca/factors/reset/{resetId}","href":"/api-reference/strong-customer-authentication/get-2fa-reset-status"},{"title":"Complete a 2FA reset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sca/factors/reset/{resetId}/complete","href":"/api-reference/strong-customer-authentication/complete-a-2fa-reset"},{"title":"Start trusting a beneficiary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/trust","href":"/api-reference/strong-customer-authentication/start-trusting-a-beneficiary"},{"title":"Confirm trusting a beneficiary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/trust/confirm","href":"/api-reference/strong-customer-authentication/confirm-trusting-a-beneficiary"},{"title":"Start untrusting a beneficiary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/untrust","href":"/api-reference/strong-customer-authentication/start-untrusting-a-beneficiary"},{"title":"Confirm untrusting a beneficiary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/untrust/confirm","href":"/api-reference/strong-customer-authentication/confirm-untrusting-a-beneficiary"},{"title":"Authorize a quote's SCA challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quotes/{quoteId}/authorize","href":"/api-reference/strong-customer-authentication/authorize-a-quotes-sca-challenge"},{"title":"Resend a quote's SCA challenge code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quotes/{quoteId}/authorize/resend","href":"/api-reference/strong-customer-authentication/resend-a-quotes-sca-challenge-code"}]},{"group":"Internal Accounts","pages":[{"title":"Create an internal account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts","href":"/api-reference/internal-accounts/create-an-internal-account"},{"title":"List Customer internal accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/internal-accounts","href":"/api-reference/internal-accounts/list-customer-internal-accounts"},{"title":"List platform internal accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /platform/internal-accounts","href":"/api-reference/internal-accounts/list-platform-internal-accounts"},{"title":"Update internal account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /internal-accounts/{id}","href":"/api-reference/internal-accounts/update-internal-account"},{"title":"Authorize a rule-based account's SCA challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts/{id}/authorize","href":"/api-reference/internal-accounts/authorize-a-rule-based-accounts-sca-challenge"},{"title":"Resend a rule-based account's SCA challenge code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts/{id}/authorize/resend","href":"/api-reference/internal-accounts/resend-a-rule-based-accounts-sca-challenge-code"},{"title":"Move a rule-based account's stranded funds","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts/{id}/stranded-funds/transfer","href":"/api-reference/internal-accounts/move-a-rule-based-accounts-stranded-funds"},{"title":"Export internal account wallet credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts/{id}/export","href":"/api-reference/internal-accounts/export-internal-account-wallet-credentials"}]},{"group":"External Accounts","pages":[{"title":"List Customer external accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/external-accounts","href":"/api-reference/external-accounts/list-customer-external-accounts"},{"title":"Add a new external account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts","href":"/api-reference/external-accounts/add-a-new-external-account"},{"title":"Get customer external account by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/get-customer-external-account-by-id"},{"title":"Delete customer external account by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/delete-customer-external-account-by-id"},{"title":"Start an ownership verification challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/challenge","href":"/api-reference/external-accounts/start-an-ownership-verification-challenge"},{"title":"Verify ownership with a wallet signature","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/external-accounts/{externalAccountId}/verify","href":"/api-reference/external-accounts/verify-ownership-with-a-wallet-signature"},{"title":"List platform external accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /platform/external-accounts","href":"/api-reference/external-accounts/list-platform-external-accounts"},{"title":"Add a new platform external account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /platform/external-accounts","href":"/api-reference/external-accounts/add-a-new-platform-external-account"},{"title":"Get platform external account by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /platform/external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/get-platform-external-account-by-id"},{"title":"Delete platform external account by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /platform/external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/delete-platform-external-account-by-id"},{"title":"Start an ownership verification challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /platform/external-accounts/{externalAccountId}/challenge","href":"/api-reference/external-accounts/start-an-ownership-verification-challenge-1"},{"title":"Verify ownership with a wallet signature","deprecated":null,"version":null,"openapi":"/openapi.yaml post /platform/external-accounts/{externalAccountId}/verify","href":"/api-reference/external-accounts/verify-ownership-with-a-wallet-signature-1"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /documents","href":"/api-reference/documents/list-documents"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /documents","href":"/api-reference/documents/upload-a-document"},{"title":"Get a document by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /documents/{documentId}","href":"/api-reference/documents/get-a-document-by-id"},{"title":"Replace a document","deprecated":null,"version":null,"openapi":"/openapi.yaml put /documents/{documentId}","href":"/api-reference/documents/replace-a-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /documents/{documentId}","href":"/api-reference/documents/delete-a-document"}]},{"group":"Same-Currency Transfers","pages":[{"title":"Create a transfer-in request","deprecated":true,"version":null,"openapi":"/openapi.yaml post /transfer-in","href":"/api-reference/same-currency-transfers/create-a-transfer-in-request"},{"title":"Create a transfer-out request","deprecated":true,"version":null,"openapi":"/openapi.yaml post /transfer-out","href":"/api-reference/same-currency-transfers/create-a-transfer-out-request"}]},{"group":"Cross-Currency Transfers","pages":[{"title":"Look up an UMA address for payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /receiver/uma/{receiverUmaAddress}","href":"/api-reference/cross-currency-transfers/look-up-an-uma-address-for-payment"},{"title":"Look up an external account for payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /receiver/external-account/{accountId}","href":"/api-reference/cross-currency-transfers/look-up-an-external-account-for-payment"},{"title":"Upload a payment document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-documents","href":"/api-reference/cross-currency-transfers/upload-a-payment-document"},{"title":"Get a payment document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-documents/{paymentDocumentId}","href":"/api-reference/cross-currency-transfers/get-a-payment-document"},{"title":"Get quote by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /quotes/{quoteId}","href":"/api-reference/cross-currency-transfers/get-quote-by-id"},{"title":"Create a transfer quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quotes","href":"/api-reference/cross-currency-transfers/create-a-transfer-quote"},{"title":"Execute a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quotes/{quoteId}/execute","href":"/api-reference/cross-currency-transfers/execute-a-quote"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions/{transactionId}","href":"/api-reference/transactions/get-transaction-by-id"},{"title":"Confirm receipt delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transactionId}/confirm","href":"/api-reference/transactions/confirm-receipt-delivery"},{"title":"Approve a pending incoming payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transactionId}/approve","href":"/api-reference/transactions/approve-a-pending-incoming-payment"},{"title":"Reject a pending incoming payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transactionId}/reject","href":"/api-reference/transactions/reject-a-pending-incoming-payment"},{"title":"Cancel a bank transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transactionId}/cancel","href":"/api-reference/transactions/cancel-a-bank-transfer"}]},{"group":"Cards","pages":[{"title":"List the disputes on a card transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions/{transactionId}/disputes","href":"/api-reference/cards/list-the-disputes-on-a-card-transaction"},{"title":"List card velocity limits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /card-velocity-limits","href":"/api-reference/cards/list-card-velocity-limits"},{"title":"Create a card velocity limit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /card-velocity-limits","href":"/api-reference/cards/create-a-card-velocity-limit"},{"title":"Get a card velocity limit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /card-velocity-limits/{id}","href":"/api-reference/cards/get-a-card-velocity-limit"},{"title":"Delete a card velocity limit","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /card-velocity-limits/{id}","href":"/api-reference/cards/delete-a-card-velocity-limit"},{"title":"List cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cards","href":"/api-reference/cards/list-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards","href":"/api-reference/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cards/{id}","href":"/api-reference/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /cards/{id}","href":"/api-reference/cards/update-a-card"},{"title":"Reveal card details","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards/{id}/reveal","href":"/api-reference/cards/reveal-card-details"},{"title":"Add a card to a digital wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards/{id}/tokenize","href":"/api-reference/cards/add-a-card-to-a-digital-wallet"},{"title":"Add a card to a digital wallet from a website","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards/{id}/web-tokenize","href":"/api-reference/cards/add-a-card-to-a-digital-wallet-from-a-website"},{"title":"Get a card dispute","deprecated":null,"version":null,"openapi":"/openapi.yaml get /card-disputes/{disputeId}","href":"/api-reference/cards/get-a-card-dispute"},{"title":"Set a card PIN","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards/{id}/set-pin","href":"/api-reference/cards/set-a-card-pin"},{"title":"Get a PIN-entry URL","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cards/{id}/pin-entry-url","href":"/api-reference/cards/get-a-pin-entry-url"},{"title":"Unblock a card PIN","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cards/{id}/pin/unblock","href":"/api-reference/cards/unblock-a-card-pin"}]},{"group":"Sandbox","pages":[{"title":"Send a test webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/test","href":"/api-reference/sandbox/send-a-test-webhook"},{"title":"Simulate sending funds","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/send","href":"/api-reference/sandbox/simulate-sending-funds"},{"title":"Simulate payment send to test receiving an UMA payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/uma/receive","href":"/api-reference/sandbox/simulate-payment-send-to-test-receiving-an-uma-payment"},{"title":"Simulate funding an internal account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/internal-accounts/{accountId}/fund","href":"/api-reference/sandbox/simulate-funding-an-internal-account"},{"title":"Simulate a card authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/authorization","href":"/api-reference/sandbox/simulate-a-card-authorization"},{"title":"Simulate a card clearing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/clearing","href":"/api-reference/sandbox/simulate-a-card-clearing"},{"title":"Simulate a card return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/return","href":"/api-reference/sandbox/simulate-a-card-return"},{"title":"Simulate a card balance inquiry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/balance_inquiry","href":"/api-reference/sandbox/simulate-a-card-balance-inquiry"},{"title":"Simulate a card credit authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/credit_authorization","href":"/api-reference/sandbox/simulate-a-card-credit-authorization"},{"title":"Simulate a card financial authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/financial_authorization","href":"/api-reference/sandbox/simulate-a-card-financial-authorization"},{"title":"Simulate a card financial credit authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/financial_credit_authorization","href":"/api-reference/sandbox/simulate-a-card-financial-credit-authorization"},{"title":"Simulate a card authorization advice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/authorization_advice","href":"/api-reference/sandbox/simulate-a-card-authorization-advice"},{"title":"Simulate a card credit authorization advice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/credit_authorization_advice","href":"/api-reference/sandbox/simulate-a-card-credit-authorization-advice"},{"title":"Simulate a card return reversal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/return_reversal","href":"/api-reference/sandbox/simulate-a-card-return-reversal"},{"title":"Simulate a card authorization reversal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/authorization_reversal","href":"/api-reference/sandbox/simulate-a-card-authorization-reversal"},{"title":"Simulate a card authorization expiry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/{id}/simulate/authorization_expiry","href":"/api-reference/sandbox/simulate-a-card-authorization-expiry"}]},{"group":"Invitations","pages":[{"title":"Create an UMA invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invitations","href":"/api-reference/invitations/create-an-uma-invitation"},{"title":"Get an UMA invitation by code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invitations/{invitationCode}","href":"/api-reference/invitations/get-an-uma-invitation-by-code"},{"title":"Claim an UMA invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invitations/{invitationCode}/claim","href":"/api-reference/invitations/claim-an-uma-invitation"},{"title":"Cancel an UMA invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invitations/{invitationCode}/cancel","href":"/api-reference/invitations/cancel-an-uma-invitation"}]},{"group":"API Tokens","pages":[{"title":"List tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tokens","href":"/api-reference/api-tokens/list-tokens"},{"title":"Create a new API token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tokens","href":"/api-reference/api-tokens/create-a-new-api-token"},{"title":"Get API token by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tokens/{tokenId}","href":"/api-reference/api-tokens/get-api-token-by-id"},{"title":"Delete API token by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tokens/{tokenId}","href":"/api-reference/api-tokens/delete-api-token-by-id"}]},{"group":"Periodic Statements","pages":[{"title":"List balance changes for a period","deprecated":null,"version":null,"openapi":"/openapi.yaml get /internal-accounts/{id}/balance-changes","href":"/api-reference/periodic-statements/list-balance-changes-for-a-period"},{"title":"Send a receipt for a periodic statement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /internal-accounts/{id}/confirm-statement","href":"/api-reference/periodic-statements/send-a-receipt-for-a-periodic-statement"}]},{"group":"Embedded Wallet Auth","pages":[{"title":"Add an administrator credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/admin-credentials","href":"/api-reference/embedded-wallet-auth/add-an-administrator-credential"},{"title":"Revoke an administrator's credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /auth/admin-credentials/{adminReference}","href":"/api-reference/embedded-wallet-auth/revoke-an-administrators-credentials"},{"title":"List authentication credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/credentials","href":"/api-reference/embedded-wallet-auth/list-authentication-credentials"},{"title":"Create an authentication credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/credentials","href":"/api-reference/embedded-wallet-auth/create-an-authentication-credential"},{"title":"Revoke an authentication credential","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /auth/credentials/{id}","href":"/api-reference/embedded-wallet-auth/revoke-an-authentication-credential"},{"title":"Verify an authentication credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/credentials/{id}/verify","href":"/api-reference/embedded-wallet-auth/verify-an-authentication-credential"},{"title":"Re-issue an authentication credential challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/credentials/{id}/challenge","href":"/api-reference/embedded-wallet-auth/re-issue-an-authentication-credential-challenge"},{"title":"List active sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/sessions","href":"/api-reference/embedded-wallet-auth/list-active-sessions"},{"title":"Revoke an authentication session","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /auth/sessions/{id}","href":"/api-reference/embedded-wallet-auth/revoke-an-authentication-session"},{"title":"Refresh an authentication session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/sessions/{id}/refresh","href":"/api-reference/embedded-wallet-auth/refresh-an-authentication-session"},{"title":"List delegated signing keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/delegated-keys","href":"/api-reference/embedded-wallet-auth/list-delegated-signing-keys"},{"title":"Create a delegated signing key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/delegated-keys","href":"/api-reference/embedded-wallet-auth/create-a-delegated-signing-key"},{"title":"Get a delegated signing key","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/delegated-keys/{id}","href":"/api-reference/embedded-wallet-auth/get-a-delegated-signing-key"},{"title":"Revoke a delegated signing key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /auth/delegated-keys/{id}","href":"/api-reference/embedded-wallet-auth/revoke-a-delegated-signing-key"}]},{"group":"Agent Operations","pages":[{"title":"Get current agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me","href":"/api-reference/agent-operations/get-current-agent"},{"title":"Get agent customer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/customer","href":"/api-reference/agent-operations/get-agent-customer"},{"title":"Update agent customer","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/me/customer","href":"/api-reference/agent-operations/update-agent-customer"},{"title":"Submit agent customer for verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/verifications","href":"/api-reference/agent-operations/submit-agent-customer-for-verification"},{"title":"Generate an agent customer KYC link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/kyc-link","href":"/api-reference/agent-operations/generate-an-agent-customer-kyc-link"},{"title":"Create an agent deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/deposits","href":"/api-reference/agent-operations/create-an-agent-deposit"},{"title":"Get an agent deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/deposits/{depositId}","href":"/api-reference/agent-operations/get-an-agent-deposit"},{"title":"List agent transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/transactions","href":"/api-reference/agent-operations/list-agent-transactions"},{"title":"Get agent transaction by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/transactions/{transactionId}","href":"/api-reference/agent-operations/get-agent-transaction-by-id"},{"title":"Create a transfer quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/quotes","href":"/api-reference/agent-operations/create-a-transfer-quote"},{"title":"Get agent quote by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/quotes/{quoteId}","href":"/api-reference/agent-operations/get-agent-quote-by-id"},{"title":"Execute a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/quotes/{quoteId}/execute","href":"/api-reference/agent-operations/execute-a-quote"},{"title":"List agent's own actions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/actions","href":"/api-reference/agent-operations/list-agents-own-actions"},{"title":"Get an agent action","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/actions/{actionId}","href":"/api-reference/agent-operations/get-an-agent-action"},{"title":"List agent's internal accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/internal-accounts","href":"/api-reference/agent-operations/list-agents-internal-accounts"},{"title":"List agent external accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/external-accounts","href":"/api-reference/agent-operations/list-agent-external-accounts"},{"title":"Add an external account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/external-accounts","href":"/api-reference/agent-operations/add-an-external-account"},{"title":"Get agent external account by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/external-accounts/{externalAccountId}","href":"/api-reference/agent-operations/get-agent-external-account-by-id"},{"title":"Delete agent external account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/me/external-accounts/{externalAccountId}","href":"/api-reference/agent-operations/delete-agent-external-account"},{"title":"List claimable payouts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/claimable-payouts","href":"/api-reference/agent-operations/list-claimable-payouts"},{"title":"Send a claimable payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/claimable-payouts","href":"/api-reference/agent-operations/send-a-claimable-payout"},{"title":"Get a claimable payout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/claimable-payouts/{claimablePayoutId}","href":"/api-reference/agent-operations/get-a-claimable-payout"},{"title":"Cancel a claimable payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/claimable-payouts/{claimablePayoutId}/cancel","href":"/api-reference/agent-operations/cancel-a-claimable-payout"},{"title":"List payout runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/payout-runs","href":"/api-reference/agent-operations/list-payout-runs"},{"title":"Create a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/payout-runs","href":"/api-reference/agent-operations/create-a-payout-run"},{"title":"Preview a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/payout-runs/preview","href":"/api-reference/agent-operations/preview-a-payout-run"},{"title":"Get a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/payout-runs/{payoutRunId}","href":"/api-reference/agent-operations/get-a-payout-run"},{"title":"List the rows of a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/payout-runs/{payoutRunId}/rows","href":"/api-reference/agent-operations/list-the-rows-of-a-payout-run"},{"title":"Cancel a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/payout-runs/{payoutRunId}/cancel","href":"/api-reference/agent-operations/cancel-a-payout-run"},{"title":"Preview a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/settlement-rules/preview","href":"/api-reference/agent-operations/preview-a-settlement-rule"},{"title":"List settlement rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/settlement-rules","href":"/api-reference/agent-operations/list-settlement-rules"},{"title":"Create a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/settlement-rules","href":"/api-reference/agent-operations/create-a-settlement-rule"},{"title":"Get a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/settlement-rules/{settlementRuleId}","href":"/api-reference/agent-operations/get-a-settlement-rule"},{"title":"Delete a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/me/settlement-rules/{settlementRuleId}","href":"/api-reference/agent-operations/delete-a-settlement-rule"},{"title":"Update a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/me/settlement-rules/{settlementRuleId}","href":"/api-reference/agent-operations/update-a-settlement-rule"},{"title":"List the executions of a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/settlement-rules/{settlementRuleId}/executions","href":"/api-reference/agent-operations/list-the-executions-of-a-settlement-rule"},{"title":"Cancel a held execution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/settlement-rules/{settlementRuleId}/executions/{executionId}/cancel","href":"/api-reference/agent-operations/cancel-a-held-execution"},{"title":"List agent cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/cards","href":"/api-reference/agent-operations/list-agent-cards"},{"title":"Issue an agent card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/cards","href":"/api-reference/agent-operations/issue-an-agent-card"},{"title":"Get agent card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/cards/{cardId}","href":"/api-reference/agent-operations/get-agent-card"},{"title":"Tighten or freeze an agent card","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/me/cards/{cardId}","href":"/api-reference/agent-operations/tighten-or-freeze-an-agent-card"},{"title":"Reveal a purchase card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/cards/{cardId}/reveal","href":"/api-reference/agent-operations/reveal-a-purchase-card"},{"title":"Add the agent's card to a digital wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/cards/{cardId}/tokenize","href":"/api-reference/agent-operations/add-the-agents-card-to-a-digital-wallet"},{"title":"Increase a purchase card amount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/cards/{cardId}/increase","href":"/api-reference/agent-operations/increase-a-purchase-card-amount"},{"title":"List the stored cards the agent may use","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/me/stored-cards","href":"/api-reference/agent-operations/list-the-stored-cards-the-agent-may-use"},{"title":"Ask for a stored card's details","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/me/stored-cards/{storedCardId}/reveal","href":"/api-reference/agent-operations/ask-for-a-stored-cards-details"},{"title":"Open a stored card link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stored-card-reveals/{token}","href":"/api-reference/agent-operations/open-a-stored-card-link"}]},{"group":"Claimable Payouts","pages":[{"title":"Issue a claim token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /claimable-payouts/{claimablePayoutId}/claim-token","href":"/api-reference/claimable-payouts/issue-a-claim-token"},{"title":"Look up a claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /claimable-payouts/claim/lookup","href":"/api-reference/claimable-payouts/look-up-a-claim"},{"title":"List payout options for a claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /claimable-payouts/claim/options","href":"/api-reference/claimable-payouts/list-payout-options-for-a-claim"},{"title":"Quote a claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /claimable-payouts/claim/quote","href":"/api-reference/claimable-payouts/quote-a-claim"},{"title":"Confirm a claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /claimable-payouts/claim/confirm","href":"/api-reference/claimable-payouts/confirm-a-claim"}]},{"group":"Stablecoins","pages":[{"title":"List stablecoins","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoins","href":"/api-reference/stablecoins/list-stablecoins"},{"title":"Register an existing provider-created stablecoin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stablecoins","href":"/api-reference/stablecoins/register-an-existing-provider-created-stablecoin"},{"title":"Get a stablecoin","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoins/{stablecoinId}","href":"/api-reference/stablecoins/get-a-stablecoin"},{"title":"Request Grid enablement for a stablecoin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stablecoins/{stablecoinId}/request-grid-enablement","href":"/api-reference/stablecoins/request-grid-enablement-for-a-stablecoin"},{"title":"Create a stablecoin mint operation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stablecoins/{stablecoinId}/mints","href":"/api-reference/stablecoins/create-a-stablecoin-mint-operation"},{"title":"Create a stablecoin burn operation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stablecoins/{stablecoinId}/burns","href":"/api-reference/stablecoins/create-a-stablecoin-burn-operation"},{"title":"List stablecoin issuer operations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoins/{stablecoinId}/operations","href":"/api-reference/stablecoins/list-stablecoin-issuer-operations"},{"title":"Get a stablecoin issuer operation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoin-operations/{stablecoinOperationId}","href":"/api-reference/stablecoins/get-a-stablecoin-issuer-operation"},{"title":"List stablecoin provider account links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoin-provider-accounts","href":"/api-reference/stablecoins/list-stablecoin-provider-account-links"},{"title":"Link a stablecoin provider account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stablecoin-provider-accounts","href":"/api-reference/stablecoins/link-a-stablecoin-provider-account"},{"title":"Get a stablecoin provider account link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stablecoin-provider-accounts/{stablecoinProviderAccountId}","href":"/api-reference/stablecoins/get-a-stablecoin-provider-account-link"},{"title":"Revoke a stablecoin provider account link","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /stablecoin-provider-accounts/{stablecoinProviderAccountId}","href":"/api-reference/stablecoins/revoke-a-stablecoin-provider-account-link"}]},{"group":"Embedded Care","pages":[{"title":"Send a care chat message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /care/chats/{chatId}/messages","href":"/api-reference/embedded-care/send-a-care-chat-message"},{"title":"End a care chat","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /care/chats/{chatId}","href":"/api-reference/embedded-care/end-a-care-chat"}]},{"group":"Payout Runs","pages":[{"title":"Create a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payout-runs","href":"/api-reference/payout-runs/create-a-payout-run"},{"title":"Get a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payout-runs/{payoutRunId}","href":"/api-reference/payout-runs/get-a-payout-run"},{"title":"List the rows of a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payout-runs/{payoutRunId}/rows","href":"/api-reference/payout-runs/list-the-rows-of-a-payout-run"},{"title":"Cancel a payout run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payout-runs/{payoutRunId}/cancel","href":"/api-reference/payout-runs/cancel-a-payout-run"},{"title":"Export a payout run for reconciliation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payout-runs/{payoutRunId}/export","href":"/api-reference/payout-runs/export-a-payout-run-for-reconciliation"}]},{"group":"Settlement Rules","pages":[{"title":"List settlement rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /settlement-rules","href":"/api-reference/settlement-rules/list-settlement-rules"},{"title":"Create a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /settlement-rules","href":"/api-reference/settlement-rules/create-a-settlement-rule"},{"title":"Preview a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /settlement-rules/preview","href":"/api-reference/settlement-rules/preview-a-settlement-rule"},{"title":"Get a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /settlement-rules/{settlementRuleId}","href":"/api-reference/settlement-rules/get-a-settlement-rule"},{"title":"Delete a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /settlement-rules/{settlementRuleId}","href":"/api-reference/settlement-rules/delete-a-settlement-rule"},{"title":"Update a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /settlement-rules/{settlementRuleId}","href":"/api-reference/settlement-rules/update-a-settlement-rule"},{"title":"List the executions of a settlement rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /settlement-rules/{settlementRuleId}/executions","href":"/api-reference/settlement-rules/list-the-executions-of-a-settlement-rule"},{"title":"Cancel a held execution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /settlement-rules/{settlementRuleId}/executions/{executionId}/cancel","href":"/api-reference/settlement-rules/cancel-a-held-execution"}]},{"group":"Webhooks","pages":[{"title":"Agent action pending approval webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook agent-action","href":"/api-reference/webhooks/agent-action-pending-approval-webhook"},{"title":"Claimable payout webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook claimable-payout","href":"/api-reference/webhooks/claimable-payout-webhook"},{"title":"Incoming payment webhook and approval mechanism","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook incoming-payment","href":"/api-reference/webhooks/incoming-payment-webhook-and-approval-mechanism"},{"title":"Outgoing payment status webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook outgoing-payment","href":"/api-reference/webhooks/outgoing-payment-status-webhook"},{"title":"Test webhook for integration verification","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook test-webhook","href":"/api-reference/webhooks/test-webhook-for-integration-verification"},{"title":"Bulk upload status webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook bulk-upload","href":"/api-reference/webhooks/bulk-upload-status-webhook"},{"title":"Invitation claimed webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook invitation-claimed","href":"/api-reference/webhooks/invitation-claimed-webhook"},{"title":"Customer status change","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook customer-update","href":"/api-reference/webhooks/customer-status-change"},{"title":"Internal account status webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook internal-account-status","href":"/api-reference/webhooks/internal-account-status-webhook"},{"title":"External account webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook external-account-status","href":"/api-reference/webhooks/external-account-webhook"},{"title":"Verification status change","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook verification-update","href":"/api-reference/webhooks/verification-status-change"},{"title":"Card status change","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook card-status-change","href":"/api-reference/webhooks/card-status-change"},{"title":"Card pin status change","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook card-pin-status-change","href":"/api-reference/webhooks/card-pin-status-change"},{"title":"Card transaction","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook card-transaction","href":"/api-reference/webhooks/card-transaction"},{"title":"Card authorization request","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook card-authorization-request","href":"/api-reference/webhooks/card-authorization-request"},{"title":"Wallet operation completed or failed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook wallet-operation","href":"/api-reference/webhooks/wallet-operation-completed-or-failed"},{"title":"Payout run finished webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook payout-run","href":"/api-reference/webhooks/payout-run-finished-webhook"},{"title":"Settlement rule execution finished webhook","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook settlement-rule","href":"/api-reference/webhooks/settlement-rule-execution-finished-webhook"}]}]}]}]},"basePath":"","title":"Authentication - Lightspark Docs","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":[],"chunks":[]}
