CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta class="swiftype" name="page_type" data-type="enum" content="techref"/><title>Square API Reference</title><meta name="description" content="This API Reference has all the detailed API endpoint information you need to build with our APIs. Square APIs let you take payments securely, integrate your application with Square first-party products, and do so much more"/><meta name="environment" content="production"/><meta property="og:site_name" content="Square Developer"/><meta property="og:title" content="Square API Reference"/><meta property="og:description" content="This API Reference has all the detailed API endpoint information you need to build with our APIs. Square APIs let you take payments securely, integrate your application with Square first-party products, and do so much more"/><meta property="og:url" content="https://developer.squareup.com/reference/square"/><meta name="twitter:card" content="summary"/><meta name="twitter:site" content="@SquareDev"/><meta name="twitter:creator" content="@SquareDev"/><meta name="twitter:title" content="Square API Reference"/><meta name="twitter:url" content="https://developer.squareup.com/reference/square"/><meta name="twitter:description" content="This API Reference has all the detailed API endpoint information you need to build with our APIs. Square APIs let you take payments securely, integrate your application with Square first-party products, and do so much more"/><meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=1"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="preconnect" href="https://docs.connect.squareup.com" crossorigin="use-credentials"/><link rel="dns-prefetch" href="https://docs.connect.squareup.com"/><meta name="next-head-count" content="19"/><link rel="preconnect" href="https://dex-tech-fe-production-c.squarecdn.com/main"/><link rel="preconnect" href="https://square-fonts-production-f.squarecdn.com"/><link rel="preload" href="https://square-fonts-production-f.squarecdn.com/square-sans.min.css" as="style"/><link rel="stylesheet" href="https://square-fonts-production-f.squarecdn.com/square-sans.min.css"/><script id="sync-theme-from-storage" integrity="" type="text/javascript" data-nscript="beforeInteractive">var canUseLocalStorage = true; try { window.localStorage } catch (e) { canUseLocalStorage = false } var showDark = !1, storedVal = canUseLocalStorage && window.localStorage.getItem("themeSwitcher-isDark"); (showDark = storedVal ? "true" === storedVal : window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches) && !window.location.pathname.startsWith("/docs") && document.querySelector("html").classList.add("dark"); if(canUseLocalStorage && !storedVal) { window.localStorage.setItem("themeSwitcher-isDark", showDark); }</script><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/b67c827188bc994a.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/b67c827188bc994a.css" data-n-g=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/214e90f9c54d8b89.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/214e90f9c54d8b89.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/82555e8a009125dd.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/82555e8a009125dd.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script id="one-trust" src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" data-domain-script="c4657020-c7d1-4a14-a091-267a7ee4863e" defer="" data-nscript="beforeInteractive"></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/webpack-295bd8df079283c3.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/framework-e3cb3eb2d5f357d8.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/main-6bd61b5a73f90664.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/pages/_app-187c20f4337dae4c.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/32855e9f-1a692ea671250f50.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/4a680cfe-28e1260d8c6b8cc4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/6311-971c73fc3e6291d4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/4678-8aad20363577e47b.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/8834-a2fe10ea1e50d1e4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/6008-e6bf90c7cb0b44b8.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/8863-d8617f2f83cc6921.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/6588-e55325977561a5db.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/9063-38a392a89e56c446.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/9325-1784352290098579.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/2039-88960b68bff46222.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/pages/reference/%5Bsquare_version%5D-4add8d4376193745.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/b19e9bf6c2e7608b1a09ca60e575f7c7a0540e24/_buildManifest.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/b19e9bf6c2e7608b1a09ca60e575f7c7a0540e24/_ssgManifest.js" defer=""></script></head><body><market-context-manager></market-context-manager><div id="__next"><div id="user-interaction-publisher"><market-toaster></market-toaster><div class="app_app__T4olD"><div class="grid_dex-grid-container__ZLJnB grid_dex-app-grid-container__eYtzp page-layout_page-layout__IT_Oe"><div class="grid-item_grid-item-full__LsU8d page-layout_top-layout__lKpde"><div class="mobile-nav-helpers_vars__2Xk6M mobile-nav-helpers_shifter__7JF7H"><div><header class="dex-site-header svelte-180r00y noPadding" data-swiftype-index="false" type="button" data-test-selector="site-header"><div class="dex-nav__left-nav svelte-180r00y"><button class="dex-site-header__collapse-button dex-site-header__button-reset svelte-180r00y" aria-label="navigation menu"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 6a1 1 0 011-1h18a1 1 0 110 2H3a1 1 0 01-1-1zm0 6a1 1 0 011-1h18a1 1 0 110 2H3a1 1 0 01-1-1zm1 5a1 1 0 100 2h18a1 1 0 100-2H3z" fill="var(--dex-nav-nav-hamburger-color)"></path></svg></button> <a class="dex-site-header__link-outer dex-site-header__desktop-nav dex-site-header__logo svelte-180r00y noPadding" href="https://developer.squareup.com" data-test-selector="site-header-square-logo"><div class="dex-site-header__link-inner svelte-180r00y"><div class="dsgn-logo svelte-1afh84a"><svg role="presentation" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svelte-bffzqn"><path d="M7.526 7.866c-.026.08-.026.179-.026.376v3.516c0 .197 0 .296.026.376a.53.53 0 0 0 .34.34c.08.026.179.026.376.026h3.516c.197 0 .296 0 .376-.026a.53.53 0 0 0 .34-.34c.026-.08.026-.179.026-.376V8.242c0-.197 0-.296-.026-.376a.53.53 0 0 0-.34-.34c-.08-.026-.179-.026-.376-.026H8.242c-.197 0-.296 0-.376.026a.53.53 0 0 0-.34.34z" fill="var(--dex-nav-text-color-primary)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M0 4c0-.62 0-.929.041-1.188A3.333 3.333 0 0 1 2.811.04C3.072 0 3.382 0 4 0h12c.62 0 .929 0 1.188.041a3.333 3.333 0 0 1 2.771 2.77C20 3.072 20 3.382 20 4v12c0 .62 0 .929-.041 1.188a3.333 3.333 0 0 1-2.77 2.771C16.928 20 16.618 20 16 20H4c-.62 0-.929 0-1.188-.041a3.333 3.333 0 0 1-2.771-2.77C0 16.928 0 16.618 0 16V4zm4 .947C4 4.424 4.424 4 4.947 4h10.106c.523 0 .947.424.947.947v10.106a.947.947 0 0 1-.947.947H4.947A.947.947 0 0 1 4 15.053V4.947z" fill="var(--dex-nav-text-color-primary)"></path></svg></div> <div class="dsgn-logo-text svelte-1afh84a"><svg role="presentation" xmlns="http://www.w3.org/2000/svg" width="164" height="20" fill="none" aria-label="Square Developer" class="svelte-1afh84a"><path d="M16.675 0H3.376C1.483 0 0 1.483 0 3.325v13.299a3.318 3.318 0 0 0 3.325 3.325h13.3a3.318 3.318 0 0 0 3.324-3.325v-13.3C20 1.485 18.517 0 16.675 0Zm-.307 15.294a1.08 1.08 0 0 1-1.074 1.074H4.706a1.08 1.08 0 0 1-1.074-1.074V4.706c0-.614.46-1.074 1.074-1.074h10.64c.562 0 1.022.46 1.022 1.074v10.588Zm-4.245-2.557a.591.591 0 0 0 .614-.614V7.877a.591.591 0 0 0-.614-.614H7.877a.591.591 0 0 0-.614.614v4.246c0 .358.256.614.614.614h4.246Zm13.197-.307h2.2c.102 1.227.92 2.2 2.66 2.2 1.534 0 2.454-.768 2.454-1.893 0-1.075-.716-1.535-2.046-1.842l-1.688-.358c-1.841-.41-3.222-1.586-3.222-3.53 0-2.148 1.892-3.58 4.348-3.58 2.608 0 4.296 1.381 4.399 3.376h-2.098c-.255-.92-1.023-1.534-2.301-1.534-1.33 0-2.251.716-2.251 1.636 0 .921.818 1.484 2.2 1.79l1.687.359c1.842.409 3.07 1.534 3.07 3.478 0 2.455-1.842 3.939-4.502 3.939-3.12.102-4.757-1.535-4.91-4.041ZM42.455 20v-3.632l.154-1.585h-.154c-.511 1.125-1.534 1.79-2.966 1.79-2.302 0-3.99-1.893-3.99-4.757 0-2.865 1.688-4.757 3.99-4.757 1.432 0 2.404.665 2.966 1.688h.154V7.212H44.5V19.95h-2.046V20Zm.051-8.184C42.506 9.974 41.381 8.9 40 8.9c-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915Zm3.479.92V7.213h2.046v5.32c0 1.432.716 2.148 1.841 2.148 1.432 0 2.353-1.023 2.353-2.608v-4.86h2.046v9.156H52.38v-1.892h-.154c-.46 1.227-1.432 2.046-2.967 2.046-2.148.05-3.273-1.381-3.273-3.785Zm9.514 1.075c0-1.688 1.176-2.711 3.325-2.814l2.506-.153v-.716c0-.87-.614-1.381-1.74-1.381-1.022 0-1.636.511-1.79 1.227h-2.045c.204-1.841 1.739-2.915 3.836-2.915 2.353 0 3.785 1.023 3.785 2.915v6.394h-1.893V14.68h-.153c-.41 1.126-1.33 1.893-3.018 1.893-1.637 0-2.813-1.125-2.813-2.762Zm5.831-1.126v-.46l-2.046.154c-1.125.05-1.586.46-1.586 1.278 0 .716.563 1.177 1.381 1.177 1.433 0 2.251-.921 2.251-2.149Zm3.58 3.683V7.212h1.893v1.74h.154c.255-1.177 1.176-1.74 2.557-1.74h.92v1.842h-1.176c-1.33 0-2.301.87-2.301 2.455v4.86H64.91Zm14.783-4.194h-6.956c.102 1.688 1.278 2.609 2.608 2.609 1.126 0 1.79-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.71 0-4.603-1.995-4.603-4.757 0-2.711 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41 0 .665-.05.972Zm-1.944-1.381c-.05-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.86ZM84.962 16.368V3.888h3.99c3.631 0 6.086 2.301 6.086 6.24 0 3.938-2.455 6.24-6.087 6.24h-3.99Zm2.148-1.892h1.841c2.302 0 3.99-1.484 3.99-4.348 0-2.865-1.688-4.348-3.99-4.348H87.11v8.696ZM104.962 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c.051.41 0 .665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.25.767-2.455 2.148h4.859ZM108.389 16.368l-3.223-9.156h2.251l1.841 5.473.307 1.28h.154l.358-1.28 1.841-5.473h2.251l-3.376 9.156h-2.404ZM123.12 12.174h-6.956c.102 1.688 1.279 2.609 2.608 2.609 1.126 0 1.791-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.711 0-4.603-1.995-4.603-4.757 0-2.762 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41-.051.665-.051.972Zm-1.995-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.859ZM124.348 16.368V3.683h2.046v12.685h-2.046ZM127.57 11.816c0-2.762 1.842-4.757 4.604-4.757s4.552 1.944 4.552 4.757c0 2.813-1.841 4.757-4.552 4.757-2.813 0-4.604-1.995-4.604-4.757Zm7.059 0c0-1.893-1.125-2.916-2.506-2.916-1.381 0-2.507 1.023-2.507 2.916 0 1.892 1.126 2.915 2.507 2.915 1.381 0 2.506-1.023 2.506-2.915ZM137.903 7.263h1.893v1.535h.153c.563-1.074 1.534-1.74 2.967-1.74 2.302 0 3.989 1.893 3.989 4.758 0 2.864-1.687 4.757-3.989 4.757-1.433 0-2.456-.665-2.967-1.688h-.153l.153 1.534v3.376h-2.046V7.263Zm6.956 4.553c0-1.842-1.125-2.916-2.506-2.916-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915ZM156.829 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c0 .41-.051.665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.251.767-2.455 2.148h4.859ZM158.056 16.368V7.263h1.893v1.74h.153c.256-1.177 1.177-1.74 2.558-1.74h.921v1.842h-1.177c-1.33 0-2.302.87-2.302 2.455v4.808h-2.046Z" fill="var(--dex-nav-logo-color-primary)"></path></svg> </div></div></a> <button class="dex-site-header__link-outer dex-site-header__mobile-nav dex-site-header__button-reset svelte-180r00y"><div class="dex-site-header__link-inner svelte-180r00y"><div class="dsgn-logo svelte-1afh84a"><svg role="presentation" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svelte-bffzqn"><path d="M7.526 7.866c-.026.08-.026.179-.026.376v3.516c0 .197 0 .296.026.376a.53.53 0 0 0 .34.34c.08.026.179.026.376.026h3.516c.197 0 .296 0 .376-.026a.53.53 0 0 0 .34-.34c.026-.08.026-.179.026-.376V8.242c0-.197 0-.296-.026-.376a.53.53 0 0 0-.34-.34c-.08-.026-.179-.026-.376-.026H8.242c-.197 0-.296 0-.376.026a.53.53 0 0 0-.34.34z" fill="var(--dex-nav-text-color-primary)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M0 4c0-.62 0-.929.041-1.188A3.333 3.333 0 0 1 2.811.04C3.072 0 3.382 0 4 0h12c.62 0 .929 0 1.188.041a3.333 3.333 0 0 1 2.771 2.77C20 3.072 20 3.382 20 4v12c0 .62 0 .929-.041 1.188a3.333 3.333 0 0 1-2.77 2.771C16.928 20 16.618 20 16 20H4c-.62 0-.929 0-1.188-.041a3.333 3.333 0 0 1-2.771-2.77C0 16.928 0 16.618 0 16V4zm4 .947C4 4.424 4.424 4 4.947 4h10.106c.523 0 .947.424.947.947v10.106a.947.947 0 0 1-.947.947H4.947A.947.947 0 0 1 4 15.053V4.947z" fill="var(--dex-nav-text-color-primary)"></path></svg></div> <div class="dsgn-logo-text svelte-1afh84a"><svg role="presentation" xmlns="http://www.w3.org/2000/svg" width="164" height="20" fill="none" aria-label="Square Developer" class="svelte-1afh84a"><path d="M16.675 0H3.376C1.483 0 0 1.483 0 3.325v13.299a3.318 3.318 0 0 0 3.325 3.325h13.3a3.318 3.318 0 0 0 3.324-3.325v-13.3C20 1.485 18.517 0 16.675 0Zm-.307 15.294a1.08 1.08 0 0 1-1.074 1.074H4.706a1.08 1.08 0 0 1-1.074-1.074V4.706c0-.614.46-1.074 1.074-1.074h10.64c.562 0 1.022.46 1.022 1.074v10.588Zm-4.245-2.557a.591.591 0 0 0 .614-.614V7.877a.591.591 0 0 0-.614-.614H7.877a.591.591 0 0 0-.614.614v4.246c0 .358.256.614.614.614h4.246Zm13.197-.307h2.2c.102 1.227.92 2.2 2.66 2.2 1.534 0 2.454-.768 2.454-1.893 0-1.075-.716-1.535-2.046-1.842l-1.688-.358c-1.841-.41-3.222-1.586-3.222-3.53 0-2.148 1.892-3.58 4.348-3.58 2.608 0 4.296 1.381 4.399 3.376h-2.098c-.255-.92-1.023-1.534-2.301-1.534-1.33 0-2.251.716-2.251 1.636 0 .921.818 1.484 2.2 1.79l1.687.359c1.842.409 3.07 1.534 3.07 3.478 0 2.455-1.842 3.939-4.502 3.939-3.12.102-4.757-1.535-4.91-4.041ZM42.455 20v-3.632l.154-1.585h-.154c-.511 1.125-1.534 1.79-2.966 1.79-2.302 0-3.99-1.893-3.99-4.757 0-2.865 1.688-4.757 3.99-4.757 1.432 0 2.404.665 2.966 1.688h.154V7.212H44.5V19.95h-2.046V20Zm.051-8.184C42.506 9.974 41.381 8.9 40 8.9c-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915Zm3.479.92V7.213h2.046v5.32c0 1.432.716 2.148 1.841 2.148 1.432 0 2.353-1.023 2.353-2.608v-4.86h2.046v9.156H52.38v-1.892h-.154c-.46 1.227-1.432 2.046-2.967 2.046-2.148.05-3.273-1.381-3.273-3.785Zm9.514 1.075c0-1.688 1.176-2.711 3.325-2.814l2.506-.153v-.716c0-.87-.614-1.381-1.74-1.381-1.022 0-1.636.511-1.79 1.227h-2.045c.204-1.841 1.739-2.915 3.836-2.915 2.353 0 3.785 1.023 3.785 2.915v6.394h-1.893V14.68h-.153c-.41 1.126-1.33 1.893-3.018 1.893-1.637 0-2.813-1.125-2.813-2.762Zm5.831-1.126v-.46l-2.046.154c-1.125.05-1.586.46-1.586 1.278 0 .716.563 1.177 1.381 1.177 1.433 0 2.251-.921 2.251-2.149Zm3.58 3.683V7.212h1.893v1.74h.154c.255-1.177 1.176-1.74 2.557-1.74h.92v1.842h-1.176c-1.33 0-2.301.87-2.301 2.455v4.86H64.91Zm14.783-4.194h-6.956c.102 1.688 1.278 2.609 2.608 2.609 1.126 0 1.79-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.71 0-4.603-1.995-4.603-4.757 0-2.711 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41 0 .665-.05.972Zm-1.944-1.381c-.05-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.86ZM84.962 16.368V3.888h3.99c3.631 0 6.086 2.301 6.086 6.24 0 3.938-2.455 6.24-6.087 6.24h-3.99Zm2.148-1.892h1.841c2.302 0 3.99-1.484 3.99-4.348 0-2.865-1.688-4.348-3.99-4.348H87.11v8.696ZM104.962 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c.051.41 0 .665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.25.767-2.455 2.148h4.859ZM108.389 16.368l-3.223-9.156h2.251l1.841 5.473.307 1.28h.154l.358-1.28 1.841-5.473h2.251l-3.376 9.156h-2.404ZM123.12 12.174h-6.956c.102 1.688 1.279 2.609 2.608 2.609 1.126 0 1.791-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.711 0-4.603-1.995-4.603-4.757 0-2.762 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41-.051.665-.051.972Zm-1.995-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.859ZM124.348 16.368V3.683h2.046v12.685h-2.046ZM127.57 11.816c0-2.762 1.842-4.757 4.604-4.757s4.552 1.944 4.552 4.757c0 2.813-1.841 4.757-4.552 4.757-2.813 0-4.604-1.995-4.604-4.757Zm7.059 0c0-1.893-1.125-2.916-2.506-2.916-1.381 0-2.507 1.023-2.507 2.916 0 1.892 1.126 2.915 2.507 2.915 1.381 0 2.506-1.023 2.506-2.915ZM137.903 7.263h1.893v1.535h.153c.563-1.074 1.534-1.74 2.967-1.74 2.302 0 3.989 1.893 3.989 4.758 0 2.864-1.687 4.757-3.989 4.757-1.433 0-2.456-.665-2.967-1.688h-.153l.153 1.534v3.376h-2.046V7.263Zm6.956 4.553c0-1.842-1.125-2.916-2.506-2.916-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915ZM156.829 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c0 .41-.051.665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.251.767-2.455 2.148h4.859ZM158.056 16.368V7.263h1.893v1.74h.153c.256-1.177 1.177-1.74 2.558-1.74h.921v1.842h-1.177c-1.33 0-2.302.87-2.302 2.455v4.808h-2.046Z" fill="var(--dex-nav-logo-color-primary)"></path></svg> </div> <span class="chevron svelte-180r00y"><svg class="direction--down svelte-mcdwxn" width="10" height="12" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 4l4 4 4-4" stroke="var(--dex-nav-icon-color)" stroke-width="2" stroke-linecap="round"></path></svg></span></div></button></div> <div class="dex-site-header__search-container svelte-180r00y"><button class="dsgn__search-button svelte-ezc5q8" data-test-selector="search-button"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" fill="none"><path fill="var(--dex-nav-text-color-primary)" fill-opacity=".9" d="M5 9.667a4.639 4.639 0 0 0 2.787-.934l2.74 2.74.94-.94-2.74-2.74a4.61 4.61 0 0 0 .933-2.786A4.672 4.672 0 0 0 4.993.34 4.672 4.672 0 0 0 .327 5.007c0 2.573 2.1 4.66 4.673 4.66Zm0-8a3.335 3.335 0 0 1 0 6.666 3.335 3.335 0 0 1 0-6.666Z"></path></svg> <span class="dsgn-search__desktop-view dsgn-search__button-text svelte-ezc5q8">Search developer resources</span> <div data-testid="search-hot-key" class="dsgn-search__desktop-view dsgn-search__button-hotkey-container svelte-ezc5q8"><div class="dsgn-search__desktop-view dsgn-search__button-hotkey-text svelte-ezc5q8">/ </div></div> </button></div> <ul class="dex-site-header__right-nav svelte-180r00y"><li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1 highlighted">Docs & Tools</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1">SDKs</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1">Support</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><a data-test-selector="site-header-partnerships-link" class="dex-site-header__right-nav__link dex-site-header__link-outer svelte-180r00y" href="https://www.squareup.com/us/en/partnerships">Partnerships </a></li> <li class="dex-site-header__desktop-nav svelte-180r00y"><a data-test-selector="site-header-sign-in-link" class="dex-site-header__right-nav__link dex-site-header__link-outer sign-in-link svelte-180r00y" href="https://squareup.com/login?app=developer&return_to=https://developer.squareup.com/apps">Sign In </a></li> <li class="dex-site-header__mobile-nav svelte-180r00y"><a data-test-selector="site-header-sign-in-link" class="dex-site-header__right-nav__link dex-site-header__link-outer sign-in-link svelte-180r00y" href="https://squareup.com/login?app=developer&return_to=https://developer.squareup.com/apps">Sign In </a></li></ul></header> </div></div></div><div class="grid-item_grid-item-small__Xb5VI page-layout_nav-layout__gKFHZ"><div class="reference-navigation-container_container__Hq6ph"><nav data-testid="reference-navigation" class="navigation_navigation__dt3qG reference-sticky-navigation_nav___VJbp mobile-nav-helpers_vars__2Xk6M mobile-nav-helpers_navigation__W2z0J"><div data-testid="reference-sticky-container" class="reference-sticky-navigation_container__jPwvM"><ul class="box_m-l-1x__pTvFT box_m-r-1x__uw0iY box_p-b-1x__E6rAE navigation_list__YBshX"><li data-testid="Home" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-home" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Home</p></a></li><li data-testid="dev-essentials" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-dev-essentials" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/o-auth-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Dev Essentials</p></a></li><li data-testid="payments" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-payments" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/payments-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Payments</p></a></li><li data-testid="commerce" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-commerce" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/orders-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Commerce</p></a></li><li data-testid="customers" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-customers" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/customers-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Customers</p></a></li><li data-testid="staff" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-staff" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/labor-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Staff</p></a></li><li data-testid="merchants" data-test-active="false" class="box_m-b-05x__rKeET navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-merchants" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_item-a__mD4vP" href="/reference/square/merchants-api"><p class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 navigation-item_inner__Yvndt">Merchants</p></a></li><li><div class="box_m-l-2x__LAJLv box_m-r-5x__BMMG0 box_m-t-3x__rN_qC box_m-b-2x__nVJGZ box_p-t-1x__1ZOZv reference-navigation_divider___PicV"></div></li><li data-testid="Objects" data-test-active="false" class="navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-objects" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_sub-item__wVnbU navigation-item_item-a__mD4vP" href="/reference/square/objects"><p class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-05x__qWq6X box_p-b-05x__xZCSS box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-20__2lYBq navigation-item_inner__Yvndt">Objects & Enums</p></a></li><li data-testid="Webhooks" data-test-active="false" class="navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-webhooks" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_sub-item__wVnbU navigation-item_item-a__mD4vP" href="/reference/square/webhooks"><p class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-05x__qWq6X box_p-b-05x__xZCSS box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-20__2lYBq navigation-item_inner__Yvndt">Webhook Events</p></a></li><li data-testid="Deprecated" data-test-active="false" class="navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-deprecated" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_sub-item__wVnbU navigation-item_item-a__mD4vP" href="/reference/square/deprecated"><p class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-05x__qWq6X box_p-b-05x__xZCSS box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-20__2lYBq navigation-item_inner__Yvndt">Deprecated</p></a></li><li data-testid="SDKs" data-test-active="false" class="navigation-item_list-item___25FT"><a data-tracking-id="navigate-to-reference-sdks" target="_self" class="focus-ring-styles_focus-ring__5P6v0 navigation-item_sub-item__wVnbU navigation-item_item-a__mD4vP" href="/docs/sdks"><p class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-05x__qWq6X box_p-b-05x__xZCSS box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-20__2lYBq navigation-item_inner__Yvndt">SDKs</p></a></li></ul></div></nav></div><button data-testid="theme-switcher" data-tracking-id="toggle-theme-switcher" aria-label="Switch Theme" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 theme-switcher_theme-switcher__Jh0RK page-layout_page-layout-theme-switcher__6_vjn page-layout_theme-switcher__ufraT"><div class="theme-switcher_theme-switcher__inner__MI0wc"><div class="theme-switcher_theme-switcher__indicator__4T_El"><svg width="15" height="15" viewBox="0 0 15 15" fill="none" xmlns="http://www.w3.org/2000/svg" data-test-icon-sun="true" class="theme-switcher_theme-switcher__indicator__sun__jueCP"><rect x="15" y="7" width="1" height="15" rx=".5" transform="rotate(90 15 7)" fill="#FECE70"></rect><rect x="8" y="15" width="1" height="15" rx=".5" transform="rotate(-180 8 15)" fill="#FECE70"></rect><rect x="12.607" y="2" width="1" height="15" rx=".5" transform="rotate(45 12.607 2)" fill="#FECE70"></rect><path d="M12.804 12.097a.5.5 0 1 1-.707.707l-9.9-9.9a.5.5 0 1 1 .707-.707l9.9 9.9z" fill="#FECE70"></path><circle cx="7.5" cy="7.5" r="4" fill="#FFC961" stroke="#fff"></circle></svg><svg class="theme-switcher_theme-switcher__indicator__moon__Qkrbj" width="13" height="13" viewBox="0 0 13 13" fill="none" xmlns="http://www.w3.org/2000/svg" data-test-icon-moon="true"><path d="M9.745 8.67A5.414 5.414 0 0 1 5.006.636c.132-.238-.065-.54-.326-.463a6.549 6.549 0 1 0 8.146 8.148c.078-.26-.224-.457-.462-.326a5.39 5.39 0 0 1-2.619.675z" fill="#7BBFFF"></path></svg></div></div></button></div><div class="page-layout_page-main__tumKK grid-item_grid-item-medium__GhKvB"><div data-testid="reference-nav-mobile-veil" class="mobile-nav-helpers_vars__2Xk6M mobile-nav_veil__w57A1"><div class="icon-button_dropdown__e8K_5"><button data-tracking-id="close-mobile-nav" slot="trigger" class="box_m-l-2x__LAJLv box_m-t-4x__FOwYa box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" class="mobile-nav_close__vvqAB icon_icon-fill-current-color__IXS7u"><path d="M2.665 2.055a1.057 1.057 0 0 0-.614.634c-.067.196-.044.555.048.748.056.12.516.597 2.28 2.364l2.21 2.214-2.211 2.214c-1.566 1.568-2.231 2.253-2.279 2.349-.101.2-.115.56-.03.785a.993.993 0 0 0 .505.542.745.745 0 0 0 .428.098c.44 0 .327.096 2.806-2.384l2.191-2.193 2.207 2.205c2.399 2.397 2.323 2.33 2.707 2.375a.827.827 0 0 0 .388-.046c.189-.057.242-.091.403-.251.223-.224.299-.408.298-.726-.002-.423.1-.304-2.371-2.777L9.426 7.999l2.193-2.191c2.48-2.478 2.385-2.366 2.383-2.805a.998.998 0 0 0-.529-.889c-.147-.081-.184-.088-.46-.088-.256 0-.32.011-.435.071-.093.048-.831.765-2.349 2.281L8.015 6.589l-2.214-2.21C4.039 2.62 3.557 2.155 3.437 2.098c-.185-.088-.594-.111-.772-.043" fill-rule="evenodd"></path></svg></button></div></div><div class="grid_dex-grid-container__ZLJnB grid_dex-content-grid-container__rkD_K"><section class="reference-page_content__jkD9P"><div class="box_m-b-1x__b2HHn reference-page_eyebrow__PzRy1"><p class="text_base__bZ6a4 text_paragraph-30___agDz eyebrow_eyebrow__hWwRh">Square API</p><div class="reference-page_narrow__jqgcD"><div class="spec-version-picker_button-group__EUT_Z"><div class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN"><button data-testid="spec-version-picker" data-tracking-id="spec-version-picker-list" aria-haspopup="true" aria-expanded="false" aria-controls=":Rhd6el6:" aria-label="Pick API version" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 spec-version-picker_version-picker__PBVZF"><p class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-20__2lYBq">Version</p><p data-testid="version-picker-selected-version" class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-20__2lYBq">2024-11-20</p><svg class="icon_icon-spinner__I22SD" width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M15 8C15 4.13401 11.866 1 8 1C4.13401 1 1 4.13401 1 8C1 11.866 4.13401 15 8 15" stroke="black" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div></div></div></div><h1 class="heading_base__MS64u heading_display-20__LG6HX">API Reference</h1><div class="box_m-t-4x__FOwYa box_m-b-2x__nVJGZ"><p class="text_base__bZ6a4 text_paragraph-30___agDz"></p></div><div><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><p><span slot="trigger"><a data-tracking-id="markdown-link" href="/docs" class="nodes_markdown-link__1J6_a">Square API guides</a></span> have all the information you need to build for sellers of every size. Our guides also provide the context to understand how our SDKs and APIs work together with Square hardware, software, and the Square Online Store.</p><p>This API Reference has all the detailed API endpoint information you need to build with our APIs. Square APIs let you take payments securely, integrate your application with Square first-party products, and do so much more</p><p>Whether you鈥檙e customizing Square for your own business, publishing in the Square App Marketplace, or working one-on-one with Square sellers, the <span slot="trigger"><a data-tracking-id="markdown-link" href="/" class="nodes_markdown-link__1J6_a">Square Developer platform</a></span> has the resources you need.</p></article></div><div class="box_m-t-3x__rN_qC box_m-b-2x__nVJGZ"><div class="feedback-widget_inline__1cIgo"><div></div></div></div></section><aside data-testid="reference-page-aside" class="reference-page_aside__Et_dj"><div><div><div class="reference-item_inline__IpiFW"><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Dev Essentials</h2><div class="reference-item_desktop__3v33P"><div class="spec-version-picker_button-group__EUT_Z"><div class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN"><button data-testid="spec-version-picker" data-tracking-id="spec-version-picker-list" aria-haspopup="true" aria-expanded="false" aria-controls=":R4kml6el6:" aria-label="Pick API version" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 spec-version-picker_version-picker__PBVZF"><p class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-20__2lYBq">Version</p><p data-testid="version-picker-selected-version" class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-20__2lYBq">2024-11-20</p><svg class="icon_icon-spinner__I22SD" width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M15 8C15 4.13401 11.866 1 8 1C4.13401 1 1 4.13401 1 8C1 11.866 4.13401 15 8 15" stroke="black" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div></div></div></div><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Authenticate your app, provide secure delegated access to Square account data, and manage webhook subscriptions.</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/o-auth-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">OAuth</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Allow your application to gain programmatic access to other seller accounts.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/webhook-subscriptions-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Webhook subscriptions</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage webhook subscriptions.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/events-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Events</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Search for Square API events that occur within a 28-day timeframe.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Payments</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Take payments, process refunds, manage disputes, enable subscriptions, and get paid for your sales.</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/payments-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Payments</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">The Payments API lets developers take and manage payments.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/refunds-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Refunds</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Manage and issue refunds for payments made to Square sellers.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/checkout-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Checkout</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Accept payments through a pre-built, Square-hosted checkout page. No frontend required.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/terminal-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Terminal</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Requests a checkout from a paired Square Terminal.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/disputes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Disputes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Use the Disputes API to manage disputes (chargebacks).</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/invoices-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Invoices</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create, configure, and publish invoices for orders that were created using the Orders API.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/cards-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Cards</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Use the Cards API to save a credit or debit card on file.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/subscriptions-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Subscriptions</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage subscriptions.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/bank-accounts-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Bank accounts</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Get聽a list of a seller's bank accounts.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/payouts-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Payouts</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Get a list of deposits and withdrawals from a seller's bank accounts.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/mobile-authorization-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Mobile authorization</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Authorize Reader SDK applications to take in-person聽payments.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/devices-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Devices</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create device codes used to connect Square Terminal with a 3rd-party point of sale system, and get details about all connected Terminals. </p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/apple-pay-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Apple pay</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Apple Pay support APIs</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Commerce</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Process orders, manage catalogs, track inventory, book reservations, and manage vendors. </p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/orders-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Orders</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Get sales data for a Square seller, itemize payments, push orders to POS, and more.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/order-custom-attributes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Order custom attributes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage order-related custom attribute definitions and custom attributes.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/catalog-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Catalog</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Programmatically catalogs a Square seller鈥檚 products for sale and services for hire.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/inventory-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Inventory</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Programmatically manages a Square seller鈥檚 inventory of catalog items.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/bookings-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Bookings</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage bookings for Square sellers.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/booking-custom-attributes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Booking custom attributes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage booking-related custom attribute definitions and custom attributes.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/vendors-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Vendors</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Manages a seller's suppliers.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/sites-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Sites</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Get details about Square Online sites that belong to Square sellers.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/snippets-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Snippets</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Manage snippets for Square Online sites.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/cash-drawers-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Cash drawers</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Get details about cash drawer shifts.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Customers</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Securely manage customer data and integrate engagement features to increase repeat business and attract new customers.</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/customers-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Customers</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage customer profiles and sync CRM systems with Square.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/customer-custom-attributes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Customer custom attributes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage customer-related custom attribute definitions and custom attributes.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/customer-groups-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Customer groups</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage customer groups to streamline and automate workflows and help personalize customer interactions.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/customer-segments-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Customer segments</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Retrieve customer segments (also called smart groups) in a business account.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/loyalty-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Loyalty</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Enroll buyers in a Square loyalty program, view program settings, manage and track loyalty activity, and create and manage promotions.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/gift-cards-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Gift cards</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and retrieve gift cards and manage gift cards on file.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/gift-card-activities-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Gift card activities</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and retrieve gift card activities.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Staff</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Manage your team of employees and track shift hours.</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/labor-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Labor</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Manage shifts, breaks, and wages for employees in Square Point of Sale.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/team-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Team</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Pull employee data into accounting and payroll systems with the Team API.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Merchants</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Manage a seller's core business information used for business, and suppliers.</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/merchants-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Merchants</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Retrieve information about an organization that sells with Square.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/merchant-custom-attributes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Merchant custom attributes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage merchant-related custom attribute definitions and custom attributes.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/locations-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Locations</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage the locations of a seller's business.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/location-custom-attributes-api"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Location custom attributes</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Create and manage location-related custom attribute definitions and custom attributes.</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div><div><h2 class="box_m-t-5x__L06CC heading_base__MS64u heading_heading-30__MH4YZ">Additional Resources</h2><p class="box_m-t-1x__GR9iT box_m-b-2x__nVJGZ text_base__bZ6a4 text_paragraph-20__2lYBq">Other resources to help you build</p><div class="box_m-b-3x__A9ryy"></div></div><div class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ"><a data-testid="reference-card--link" data-tracking-id="navigate-to-reference-card" target="_self" class="focus-ring-styles_focus-ring__5P6v0 focus-ring-styles_focus-ring-12__6HVK3 reference-card_reference-link__Z_sx4" href="/reference/square/objects"><div class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-12__AAgzy reference-card_reference-card__9eX4i"><div class="reference-card_reference-card__details__zTPOg"><h3 class="box_m-b-05x__rKeET heading_base__MS64u heading_heading-20__RIpnh">Object Index</h3><div><p data-testid="reference-card--description" class="text_base__bZ6a4 text_paragraph-20__2lYBq reference-card_description__g_OFb">Browse through all datatypes of the Square API</p></div></div><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="reference-card_reference-card__chevron-right-icon__ujyxX"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></div></a></div></div></aside></div></div><div class="grid-item_grid-item-full__LsU8d"><div class="mobile-nav-helpers_vars__2Xk6M mobile-nav-helpers_shifter__7JF7H"><div><div class="footer-wrapper svelte-ytvx2v"><footer class="dex-site-footer svelte-ytvx2v" data-swiftype-index="false"><div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="Development">Development </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs" data-test-site-footer-section-link="Guides" class="svelte-ytvx2v">Guides</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/reference/square" data-test-site-footer-section-link="API Reference" class="svelte-ytvx2v">API Reference</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/explorer" data-test-site-footer-section-link="API Explorer" class="svelte-ytvx2v">API Explorer</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs/sdks" data-test-site-footer-section-link="SDKs" class="svelte-ytvx2v">SDKs</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs/sample-apps" data-test-site-footer-section-link="Sample apps" class="svelte-ytvx2v">Sample apps</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://www.issquareup.com/" data-test-site-footer-section-link="System status" class="svelte-ytvx2v">System status</a> </li></ul></div> <div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="Support">Support </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://developer.squareup.com/forums/" data-test-site-footer-section-link="Developer forums" class="svelte-ytvx2v">Developer forums</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/help/contact?panel=BF53A9C8EF68" data-test-site-footer-section-link="Contact support" class="svelte-ytvx2v">Contact support</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/blog" data-test-site-footer-section-link="Developer blog" class="svelte-ytvx2v">Developer blog</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://discord.gg/squaredev" data-test-site-footer-section-link="Discord community" class="svelte-ytvx2v">Discord community</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://www.youtube.com/channel/UC1N2X6PEMGo2xjJY1Pm0vng" data-test-site-footer-section-link="YouTube" class="svelte-ytvx2v">YouTube</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://twitter.com/SquareDev" data-test-site-footer-section-link="X" class="svelte-ytvx2v">X</a> </li></ul></div> <div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="More">More </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com" data-test-site-footer-section-link="Square Home" class="svelte-ytvx2v">Square Home</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://developer.squareup.com" data-test-site-footer-section-link="Square Developer" class="svelte-ytvx2v">Square Developer</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/app-marketplace" data-test-site-footer-section-link="App Marketplace" class="svelte-ytvx2v">App Marketplace</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/partnerships" data-test-site-footer-section-link="Partner with Square" class="svelte-ytvx2v">Partner with Square</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/partnerships/solutions-partner-program" data-test-site-footer-section-link="Solutions Partner Program" class="svelte-ytvx2v">Solutions Partner Program</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/pricing" data-test-site-footer-section-link="Pricing" class="svelte-ytvx2v">Pricing</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/sales" data-test-site-footer-section-link="Sales" class="svelte-ytvx2v">Sales</a> </li></ul></div> <div class="dex-site-footer__square-container svelte-ytvx2v"><p class="dex-site-footer__square-text svelte-ytvx2v">漏 2024 Square, Inc. </p> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/developers" data-test-site-footer-section-link="Developer terms of service" class="svelte-ytvx2v">Developer terms of service</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/global-developer-integration-marketing-agreement" data-test-site-footer-section-link="Developer Integration and Marketing Agreement" class="svelte-ytvx2v">Developer Integration and Marketing Agreement</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/privacy" data-test-site-footer-section-link="Privacy policy" class="svelte-ytvx2v">Privacy policy</a> </li> </ul></div></footer> </div></div></div></div></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"headers":{"host":"developer.squareup.com","x-forwarded-port":"443","x-amzn-trace-id":"Root=1-674c09eb-189fb5e013e2d9ec51e12716","cf-worker":"developer.squareup.com","cf-ipcountry":"SG","accept-encoding":"gzip","cf-ray":"8eb1359d62a348d6-SIN","cf-visitor":"{\"scheme\":\"https\"}","cf-ew-via":"15","cdn-loop":"cloudflare; loops=1; subreqs=1","accept":"*/*","user-agent":"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; .NET CLR 3.5.21022; .NET CLR 1.0.3705; .NET CLR 1.1.4322)","cdn-client-ip":"8.222.208.146","cf-connecting-ip":"8.222.208.146","x-cdn-bot-score":"1","x-cdn-geoip-asnum":"45102","x-cdn-geoip-continent":"AS","x-cdn-ip-threat-score":"0","x-cdn-ja3-hash":"535aca3d99fc247509cd50933cd71d37","x-cdn-lat":"1.36730","x-cdn-lon":"103.80140","x-cdn-trace-id":"CDN-0e7354e4-9207-40a9-9850-779b1dfc3307","x-cdn-verified-bot":"false","x-real-bot-score":"1","x-speleo-trace-id":"CDN-0e7354e4-9207-40a9-9850-779b1dfc3307","x-request-id":"281f71fa-e707-47af-982c-3e09e18f127e","cdn-auth-header-status":"present_and_match","client-ip":"8.222.208.146","x-forwarded-for":"8.222.208.146","x-square-tls-version":"TLSv1.2","traceparent":"00-674c09eb00000000293a6f32c9f8b5a7-293a6f32c9f8b5a7-00","tracestate":"dd=s:-1;p:293a6f32c9f8b5a7","x-forwarded-client-cert":"By=spiffe://production.ski.squarecloudservices.com/dex-tech-fe;Hash=549c2545b24a01cf2f2e1cd7932bb4bb0950790a15a084fe5b20bb44788143a5;Cert=\"-----BEGIN%20CERTIFICATE-----%0AMIIDLTCCAtSgAwIBAgIRAL2zc5go%2Bqtmw1%2BXEkLpM2MwCgYIKoZIzj0EAwIwYDEL%0AMAkGA1UEBhMCVVMxEzARBgNVBAoMCkJsb2NrLCBJbmMxKDAmBgNVBAMMH1NLSSBB%0AV1MgTmF0aXZlIENBIHByb2R1Y3Rpb24gRzAxEjAQBgNVBAcMCXVzLWVhc3QtMTAe%0AFw0yNDExMjYyMDE3MTFaFw0yNDEyMjYxMzAxMDBaMEMxQTA%2FBgNVBAMTOFNxdWFy%0AZS1BV1MtcHJvZHVjdGlvbi5za2kuc3F1YXJlY2xvdWRzZXJ2aWNlcy5jb20tdHJh%0AY29uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2TO9yVxDpWoC1Pgd%0A7oqbzd9emehBLaoxmkrXihnfkO%2FIJGqPFChbbBqcuk8f%2BU4A9RE09JTbWbhSw7GY%0AyWbfy57Ok3BOJWM07LpbVpQT0yYM8A3RS9oZYtpa7tL9zw1QYf31zyief7eU7%2BHY%0APpMPu7M1h5dpLgeoc6qoyZ3J4UFF9v%2BJHqBmFqag9K3%2B5PfdzpcTInUeeVz5DV9X%0ARzPL0G0JrdMyLczjTNea6jFWyhZBhK3C%2B3MIasraPlcBvBL8JhXHUQ7muJIbrK17%0Aiay1BT0OOxzO2WXTl5a9OZtu%2FdD4qeWYCWiAlPgoxbNuj0kBOFC20WxvPTCmAi1i%0A5mm8EQIDAQABo4HAMIG9MEEGA1UdEQQ6MDiGNnNwaWZmZTovL3Byb2R1Y3Rpb24u%0Ac2tpLnNxdWFyZWNsb3Vkc2VydmljZXMuY29tL3RyYWNvbjAJBgNVHRMEAjAAMB8G%0AA1UdIwQYMBaAFMGl%2F3xrOtgSFgx8PWuMOeX5r9F6MB0GA1UdDgQWBBSTqR3SxWgo%0AuJJz5P9yhXMiiHTdATAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUH%0AAwEGCCsGAQUFBwMCMAoGCCqGSM49BAMCA0cAMEQCIAj%2BrmxQJunh41gyBPfS1Nlp%0AdyQoGlLX2mvtXL%2FnpsxLAiBzrfWhObXjIJV3Q5qfp40oToWCQ3OIen8CyKOkiRfc%0AnA%3D%3D%0A-----END%20CERTIFICATE-----%0A\"","x-sq-peer-spiffe-id":"spiffe://production.ski.squarecloudservices.com/tracon","x-sq-caller-spiffe-id":"spiffe://production.ski.squarecloudservices.com/tracon","x-sq-caller-app-name":"tracon","x-sq-multipass-http-code":"OK","x-sq-envoy-safe-auth-decision":"AUTHORIZED","x-forwarded-proto":"https","x-sq-mesh":"envoy-ingress","x-datadog-trace-id":"2970809168131831207","x-datadog-parent-id":"6840105784567667271","x-datadog-sampling-priority":"-1","x-b3-traceid":"674c09eb00000000293a6f32c9f8b5a7","x-b3-spanid":"5eeceff87b401a47","x-b3-sampled":"0","x-datadog-tags":"_dd.p.tid=674c09eb00000000"},"cookies":{"_savt":"63f62040-b86e-4f8c-bcb1-042afc66c156"},"requestId":"06d7448a-eb44-4f1d-a6d5-696547bda24a","data":{"getFlags":{"data":{"addons_page_devs_console":false,"api_explorer_in_explorer_ui":false,"api_explorer_input_retention":true,"api_explorer_null_fields":true,"api_explorer_sdk_visibility":true,"api_explorer_share_link":true,"api_explorer_standalone_navigation":true,"api_keys_enabled":false,"api_logger_alpha":true,"api_logs_opt_in_enabled":false,"api_logs_to_explorer_share_link":true,"api_ref_rewrite_proxy_enabled":true,"api_version_migrator_alpha":false,"app_launch_beta":true,"app_launch_comment_history_revamp":true,"app_launch_video_submissions":true,"ccpa_enabled":true,"code_blocks_to_explorer_share_link":true,"dev_portal_app_marketplace_listings":true,"dev_portal_overview_page":false,"developer_data_feedback_param_validation":true,"developer_feedback_phase_one":true,"developer_onboarding":true,"developer_onboarding_questions":true,"developer_onboarding_variant":"V0_0","developer_rbac_permissions":false,"developer_recommendations":true,"devplat/api_explorer_in_explorer_ui":false,"devplat/api_explorer_standalone_navigation":true,"devplat/api_logger_alpha":true,"devplat/dev_portal_app_marketplace_listings":true,"devplat/firestorm_api_explorer":true,"devplat/firestorm_api_explorer_sdk_examples":true,"devplat/firestorm_connect_v1":true,"devplat/firestorm_docs_api_explorer_ga":true,"devplat/firestorm_docs_ga":true,"devplat/firestorm_docs_php_examples":false,"devplat/firestorm_static_lang_examples":true,"devs_console_app_marketplace_reviews_page":true,"devs_console_app_reviews_page":false,"devs_console_app_submissions":false,"devs_console_app_subscription_pages":true,"devs_console_app_subscription_plan_management":true,"devs_console_apps_page":true,"devs_console_incomplete_features":false,"devs_console_locations_page":true,"devs_console_oauth_page":true,"devs_console_settings_pages":false,"devs_console_webhook_subscriptions":false,"dex/addons_page_devs_console":false,"dex/api_explorer_input_retention":true,"dex/api_explorer_null_fields":true,"dex/api_explorer_sdk_visibility":true,"dex/api_explorer_share_link":true,"dex/api_keys_enabled":false,"dex/api_logs_opt_in_enabled":false,"dex/api_logs_to_explorer_share_link":true,"dex/api_ref_rewrite_proxy_enabled":true,"dex/api_version_migrator_alpha":false,"dex/app_launch_beta":true,"dex/app_launch_comment_history_revamp":true,"dex/app_launch_video_submissions":true,"dex/ccpa_enabled":true,"dex/code_blocks_to_explorer_share_link":true,"dex/dev_portal_overview_page":false,"dex/developer_data_feedback_param_validation":true,"dex/developer_feedback_phase_one":true,"dex/developer_onboarding":true,"dex/developer_onboarding_questions":true,"dex/developer_onboarding_variant":"V0_0","dex/developer_rbac_permissions":false,"dex/developer_recommendations":true,"dex/devs_console_app_marketplace_reviews_page":true,"dex/devs_console_app_reviews_page":false,"dex/devs_console_app_submissions":false,"dex/devs_console_app_subscription_pages":true,"dex/devs_console_app_subscription_plan_management":true,"dex/devs_console_apps_page":true,"dex/devs_console_incomplete_features":false,"dex/devs_console_locations_page":true,"dex/devs_console_oauth_page":true,"dex/devs_console_settings_pages":false,"dex/doc_link_preview":false,"dex/docs_link_preview":false,"dex/explorer_to_logger_link":false,"dex/fetch_devs_content_connectv2":true,"dex/fetch_devs_content_files":true,"dex/fetch_devs_content_sparkplug":true,"dex/firestorm_docs_access_token_input_ux_changes":false,"dex/firestorm_docs_changelog":false,"dex/firestorm_docs_links_to_longform":true,"dex/firestorm_docs_multiple_examples":true,"dex/firestorm_docs_new_left_nav":true,"dex/firestorm_docs_sandbox_access_tokens":true,"dex/firestorm_docs_webhooks":true,"dex/global_nav_phase_one":true,"dex/global_search_frontend":true,"dex/graphql_explorer_alpha":true,"dex/graphql_explorer_production":true,"dex/heartbeat_monitor_enabled":true,"dex/ignition_nodejs_examples":true,"dex/ignition_php_examples":true,"dex/lfd_migration_enabled":true,"dex/markdown_link_preview":true,"dex/mobile_payments_sdk_docs_enabled":true,"dex/narrow_property_table":true,"dex/onetrust_enabled":true,"dex/payment_supported_countries":false,"dex/person_based_rbac":false,"dex/remarkability_feb_2022":false,"dex/remarkability_jul_2022":true,"dex/scenario_builder_mvp":false,"dex/smart_code_block_enabled":true,"dex/square_labs_allowed":false,"dex/use_split_users_endpoint":true,"dex/web_app_log_to_cdp":true,"dex/web_app_log_to_es2":true,"dex/web_payments_sdk_ga":true,"doc_link_preview":false,"docs_link_preview":false,"dpw/devs_console_webhook_subscriptions":false,"dpw/flagged_resubmission":false,"dpw/legacy_app_marketplace_partners":false,"explorer_to_logger_link":false,"fetch_devs_content_connectv2":true,"fetch_devs_content_files":true,"fetch_devs_content_sparkplug":true,"firestorm_api_explorer":true,"firestorm_api_explorer_sdk_examples":true,"firestorm_connect_v1":true,"firestorm_docs_access_token_input_ux_changes":false,"firestorm_docs_api_explorer_ga":true,"firestorm_docs_changelog":false,"firestorm_docs_ga":true,"firestorm_docs_links_to_longform":true,"firestorm_docs_multiple_examples":true,"firestorm_docs_new_left_nav":true,"firestorm_docs_php_examples":false,"firestorm_docs_sandbox_access_tokens":true,"firestorm_docs_webhooks":true,"firestorm_static_lang_examples":true,"flagged_resubmission":false,"global_nav_phase_one":true,"global_search_frontend":true,"graphql_explorer_alpha":true,"graphql_explorer_production":true,"heartbeat_monitor_enabled":true,"ignition_nodejs_examples":true,"ignition_php_examples":true,"legacy_app_marketplace_partners":false,"lfd_migration_enabled":true,"markdown_link_preview":true,"mobile_payments_sdk_docs_enabled":true,"narrow_property_table":true,"onetrust_enabled":true,"payment_supported_countries":false,"person_based_rbac":false,"remarkability_feb_2022":false,"remarkability_jul_2022":true,"sandbox_account_limit":"INT64_10","sandcastle/sandbox_account_limit":"INT64_10","scenario_builder_mvp":false,"smart_code_block_enabled":true,"square_labs_allowed":false,"use_split_users_endpoint":true,"web_app_log_to_cdp":true,"web_app_log_to_es2":true,"web_payments_sdk_ga":true},"meta":{"headers":{}}}},"_sentryTraceData":"0869f946e0bd43a189b7b3dd54f57062-bef148a44eb6a8c2-1","_sentryBaggage":"sentry-environment=production,sentry-release=b19e9bf6c2e7608b1a09ca60e575f7c7a0540e24,sentry-public_key=94d09c8eb5834eb282d762cecbbd40e6,sentry-trace_id=0869f946e0bd43a189b7b3dd54f57062,sentry-sample_rate=1,sentry-transaction=%2Freference%2F%5Bsquare_version%5D,sentry-sampled=true"}},"page":"/reference/[square_version]","query":{"square_version":"square"},"buildId":"b19e9bf6c2e7608b1a09ca60e575f7c7a0540e24","assetPrefix":"https://dex-tech-fe-production-c.squarecdn.com/main","isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>