CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta class="swiftype" name="page_type" data-type="enum" content="techref"/><title>Gift Cards API and Gift Card Activities API</title><meta name="description" content="Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards that help sellers increase sales and attract new customers."/><meta name="environment" content="production"/><meta property="og:site_name" content="Square Developer"/><meta property="og:title" content="Gift Cards API and Gift Card Activities API"/><meta property="og:description" content="Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards that help sellers increase sales and attract new customers."/><meta property="og:url" content="https://developer.squareup.com/docs/gift-cards/using-gift-cards-api"/><meta name="twitter:card" content="summary"/><meta name="twitter:site" content="@SquareDev"/><meta name="twitter:creator" content="@SquareDev"/><meta name="twitter:title" content="Gift Cards API and Gift Card Activities API"/><meta name="twitter:url" content="https://developer.squareup.com/docs/gift-cards/using-gift-cards-api"/><meta name="twitter:description" content="Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards that help sellers increase sales and attract new customers."/><meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=1"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="canonical" href="https://developer.squareup.com/docs/gift-cards/using-gift-cards-api"/><meta name="next-head-count" content="18"/><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/70848683cdb9616a.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/70848683cdb9616a.css" data-n-g=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/e8bb7e3362f33eab.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/e8bb7e3362f33eab.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/1ee312704ccd3658.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/1ee312704ccd3658.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/f46c8bc19c31c913.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/f46c8bc19c31c913.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-7c5eea35d4f1fb78.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-1a414ec8d41ddcb6.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/6311-971c73fc3e6291d4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/2924-d3627c1ecc4004cb.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-504e707da6a9a2bb.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/1402-33f546103c1d75f0.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/1295-101d67a30cba4c23.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/2172-89f2a2e74b732931.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/5576-d465ea75c332db87.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/9962-79649dc6204fcd7d.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/5958-812f26abc3363e73.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/pages/docs/%5B%5B...slug%5D%5D-a3f43387710e0848.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/45a671e198d332b37aa8aed10a78e8aa8544f793/_buildManifest.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/45a671e198d332b37aa8aed10a78e8aa8544f793/_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-docs-app-grid-container__k80cL page-layout_page-layout__M2lNk page-layout_fixed-layout__hOmlH"><div class="grid-item_grid-item-full__LsU8d page-layout_top-layout__ejnXB"><div class="mobile-nav-helpers_vars__2Xk6M mobile-nav-helpers_shifter__7JF7H mobile-nav-helpers_show-hamburger-tablet__fNdPX"><div><header class="dex-site-header svelte-180r00y slim 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-full__LsU8d"><div data-testid="top-nav-desktop" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_b-t-l-std__qC_VL box_b-b-l-std__q5XI3 top-nav_top-nav__aG_ui top-nav_desktop__iLo1X"><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Docs Home"}" href="/docs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Docs Home</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Dev Essentials"}" href="/docs/development-essentials" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Dev Essentials</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Payments"}" href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Payments</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Commerce"}" href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Commerce</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Customers"}" href="/docs/customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI top-nav-items_active__uF7_5 focus-ring-styles_focus-ring__5P6v0">Customers</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Staff"}" href="/docs/staff" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Staff</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Merchants"}" href="/docs/merchant-details" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Merchants</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Publish"}" href="/docs/app-marketplace" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Publish</a><div data-testid="top-nav-space" class="top-nav-items_space__H5jum"></div><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Release notes"}" href="/docs/release-notes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Release notes</a></div></div><div data-testid="docs-mobile-nav" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-3x__w9FzI box_p-b-3x__BcYHb mobile-nav_mobile-nav__VSQOx"><div class="mobile-nav_top__U5ub2"><div><h2 data-testid="mobile-nav-title" class="heading_base__MS64u heading_heading-30__MH4YZ">Docs</h2></div><button data-tracking-id="docs-mobile-nav-close-button" 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 mobile-nav_close-button__q8KNd"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="m6.71 18.71 5.29-5.3 5.29 5.3 1.42-1.42-5.3-5.29 5.3-5.29-1.42-1.42-5.29 5.3-5.29-5.3-1.42 1.42 5.3 5.29-5.3 5.29 1.42 1.42Z" fill="#7B61FF"></path></svg></button></div><div class="box_m-t-7x__d2nuT"><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Docs Home</a></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/development-essentials" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Dev Essentials</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Payments</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Commerce</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe mobile-nav_active__23Zu_">Customers</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/staff" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Staff</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/merchant-details" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Merchants</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/app-marketplace" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Publish</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/release-notes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Release notes</a><button data-tracking-id="mobile-nav-step-into" 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"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><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></button></div></div></div></div><div data-testid="left-layout" class="page-layout_page-layout__M2lNk page-layout_fixed-layout__hOmlH page-layout_left-layout__rxzHd"><button data-testid="left-nav-toggle" data-tracking-id="left-nav-toggle" aria-label="Toggle left navigation" 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 left-nav_left-nav-toggle__M_yBT"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="24" viewBox="0 0 16 12" fill="none"><path fill="#7B61FF" fill-rule="evenodd" d="M0.292893 5.29282L5.29289 0.292818L6.70711 1.70703L3.41421 4.99992L6.5 4.99992L11.5 4.99992L11.5 6.99992L6.5 6.99992L3.41421 6.99992L6.70711 10.2928L5.29289 11.707L0.292893 6.70703C-0.0976315 6.31651 -0.0976315 5.68334 0.292893 5.29282ZM16 -6.99382e-07L14 -6.11959e-07L14 12L16 12L16 -6.99382e-07Z" clip-rule="evenodd"></path></svg></button><div data-testid="left-nav" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-l-std__Q4dy4 left-nav_left-nav__tj2rk"><div class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Overview"}" href="/docs/customers" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Overview</a></div><div aria-expanded="false" aria-controls=":R59l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Technical Scenarios"}" href="/docs/customers/scenarios" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Technical Scenarios</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R59l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Build a Tip Report"}" href="/docs/customers/scenarios/tip-reporting" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Build a Tip Report</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Split an Online Payment"}" href="/docs/customers/scenarios/split-online-payment" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Split an Online Payment</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Build a Sales Report"}" href="/docs/customers/scenarios/simple-sales-report" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Build a Sales Report</a></div></div></div><div aria-expanded="false" aria-controls=":R79l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customers"}" href="/docs/customers-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customers</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R79l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customers API Workflows"}" href="/docs/customers-api/how-it-works" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Customers API Workflows</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Profiles"}" href="/docs/customers-api/use-the-api/keep-records" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Customer Profiles"}" href="/docs/customers-api/use-the-api/retrieve-profiles" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Search for Customer Profiles"}" href="/docs/customers-api/use-the-api/search-customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Search for Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Integrate with Other Services"}" href="/docs/customers-api/use-the-api/integrate-with-other-services" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Integrate with Other Services</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Webhooks"}" href="/docs/customers-api/use-the-api/customer-webhooks" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Webhooks</a></div></div></div><div aria-expanded="false" aria-controls=":R99l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Custom Attributes"}" href="/docs/customer-custom-attributes-api/overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Custom Attributes</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R99l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Custom Attribute Definitions"}" href="/docs/customer-custom-attributes-api/custom-attribute-definitions" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Custom Attribute Definitions</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Custom Attributes"}" href="/docs/customer-custom-attributes-api/custom-attributes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Custom Attributes</a></div></div></div><div aria-expanded="false" aria-controls=":Rb9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Groups"}" href="/docs/customer-groups-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Groups</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rb9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Groups"}" href="/docs/customer-groups-api/how-to-use-it" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Groups</a></div></div></div><div aria-expanded="false" aria-controls=":Rd9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Segments"}" href="/docs/customer-segments-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Segments</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rd9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Segments"}" href="/docs/customer-segments-api/how-to-use-it" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Segments</a></div></div></div><div aria-expanded="false" aria-controls=":Rf9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty"}" href="/docs/loyalty-api/overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Loyalty</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rf9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Program Overview"}" href="/docs/loyalty/overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Program Overview</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Loyalty Program"}" href="/docs/loyalty-api/loyalty-programs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Promotions"}" href="/docs/loyalty-api/loyalty-promotions" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Promotions</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Create and Retrieve Loyalty Accounts"}" href="/docs/loyalty-api/loyalty-accounts" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Create and Retrieve Loyalty Accounts</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Points"}" href="/docs/loyalty-api/loyalty-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Rewards"}" href="/docs/loyalty-api/loyalty-rewards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Rewards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Search for Loyalty Events"}" href="/docs/loyalty-api/loyalty-events" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Search for Loyalty Events</a></div><div aria-expanded="false" aria-controls=":R25f9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Walkthrough 1"}" href="/docs/loyalty-api/walkthrough1" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Walkthrough 1</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R25f9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Set up a Loyalty Program"}" href="/docs/loyalty-api/walkthrough1/setup-loyalty-program" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Set up a Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Enroll a Buyer"}" href="/docs/loyalty-api/walkthrough1/enroll-buyer" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Enroll a Buyer</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Accumulate Points"}" href="/docs/loyalty-api/walkthrough1/accrue-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Accumulate Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Points"}" href="/docs/loyalty-api/walkthrough1/redeem-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Redeem Points</a></div></div></div><div aria-expanded="false" aria-controls=":R2df9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Walkthrough 2"}" href="/docs/loyalty-api/walkthrough2" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Walkthrough 2</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R2df9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Set up a Loyalty Program"}" href="/docs/loyalty-api/walkthrough2-setup-loyalty-program" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Set up a Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Enroll a Buyer"}" href="/docs/loyalty-api/walkthrough2-enroll-buyer" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Enroll a Buyer</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Adjust Points"}" href="/docs/loyalty-api/walkthrough2-accrue-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Adjust Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Points"}" href="/docs/loyalty-api/walkthrough2-redeem-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Redeem Points</a></div></div></div></div></div><div aria-expanded="true" aria-controls=":Rh9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Gift Cards"}" id="left-nav-active-item" href="/docs/gift-cards/using-gift-cards-api" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_active__X6xck left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Gift Cards</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd recursive-nav-item_expanded__VQNoM"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rh9l6:" role="region" class="recursive-nav-item_items-container__BBrAQ recursive-nav-item_expanded__VQNoM"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell Gift Cards"}" href="/docs/gift-cards/sell-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Sell Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Reload Gift Cards"}" href="/docs/gift-cards/reload-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Reload Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Gift Cards"}" href="/docs/gift-cards/redeem-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Redeem Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Gift Cards and Track Activity"}" href="/docs/gift-cards/retrieve-gift-cards-and-activities" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Gift Cards and Track Activity</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Gift Cards on File"}" href="/docs/gift-cards/manage-gift-cards-on-file" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Gift Cards on File</a></div><div aria-expanded="false" aria-controls=":R1lh9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Walkthrough 1: Sell a Gift Card"}" href="/docs/gift-cards/walkthrough-1" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Walkthrough 1: Sell a Gift Card</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R1lh9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell a Gift Card (Orders API Integration)"}" href="/docs/gift-cards/walkthrough-1-with-orders-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Sell a Gift Card (Orders API Integration)</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell a Gift Card (Custom Processing System)"}" href="/docs/gift-cards/walkthrough-1-without-orders-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Sell a Gift Card (Custom Processing System)</a></div></div></div><div aria-expanded="false" aria-controls=":R1th9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Walkthrough 2: Use a Gift Card"}" href="/docs/gift-cards/walkthrough-2" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Walkthrough 2: Use a Gift Card</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" 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 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R1th9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use a Gift Card (Orders and Payments APIs Integration)"}" href="/docs/gift-cards/walkthrough-2-orders-and-payments-integration" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Use a Gift Card (Orders and Payments APIs Integration)</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use a Gift Card (Custom Processing System)"}" href="/docs/gift-cards/walkthrough-2-custom-processing-system" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Use a Gift Card (Custom Processing System)</a></div></div></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Webhooks"}" href="/docs/gift-cards/webhooks" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Webhooks</a></div></div></div></div></div><div class="grid_dex-grid-container__ZLJnB grid_dex-docs-app-grid-container__k80cL page-layout_page-layout__M2lNk page-layout_static-layout__CfHWZ"><div class="grid-item_grid-item-small__Xb5VI page-layout_left-nav__gfhJ2"></div><div class="box_m-t-6x__LvLNv box_m-b-6x__RhdjX page-layout_page-main__W1JTS grid-item_grid-item-medium__GhKvB"><div data-testid="docs-content-layout" class="grid_dex-grid-container__ZLJnB grid_dex-docs-content-grid-container__diyxN"><div class="page-layout_content-main-grid-item__VRqbw page-layout_grid-item-column-autosizing__PtGh2 grid-item_grid-item-medium__GhKvB page-layout_limit-width__VDAgU"><div data-testid="doc-page-heading-breadcrumbs" class="box_m-b-05x__rKeET doc-breadcrumb_container__l80u_"><a aria-label="Documentation homepage" href="/docs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 doc-breadcrumb_breadcrumb__xyMjK focus-ring-styles_focus-ring__5P6v0"><svg width="10" height="20" viewBox="0 0 10 22" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M.5 16a.5.5 0 0 1-.5-.5V9.02a1 1 0 0 1 .427-.819l4-2.8a1 1 0 0 1 1.146 0l4 2.8a1 1 0 0 1 .427.82V15.5a.5.5 0 0 1-.5.5H6v-4H4v4H.5Z" fill="#000" fill-opacity="0.55"></path></svg></a><p class="box_m-l-05x__zb9MT box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-10__9t3Cn text_color-30__dpPZ4">/</p><a href="/docs/customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 doc-breadcrumb_breadcrumb__xyMjK focus-ring-styles_focus-ring__5P6v0">Customers</a></div><h1 data-testid="doc-page-heading" class="box_m-b-3x__A9ryy heading_base__MS64u heading_display-10__HZsS7 content_heading__9PVgB">Gift Cards API and Gift Card Activities API</h1><div><div><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><p><strong>Applies to:</strong> <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-cards-api" class="nodes_markdown-link__1J6_a">Gift Cards API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-card-activities-api" class="nodes_markdown-link__1J6_a">Gift Card Activities API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/orders-api/what-it-does" class="nodes_markdown-link__1J6_a">Orders API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payments-refunds" class="nodes_markdown-link__1J6_a">Payments API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/refunds-api/overview" class="nodes_markdown-link__1J6_a">Refunds API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/customers-api/what-it-does" class="nodes_markdown-link__1J6_a">Customers API</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/web-payments/overview" class="nodes_markdown-link__1J6_a">Web Payments SDK</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/in-app-payments-sdk/what-it-does" class="nodes_markdown-link__1J6_a">In-App Payments SDK</a></span> | <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/devtools/graphql" class="nodes_markdown-link__1J6_a">GraphQL</a></span></p><p><span class="box_m-t-1x__GR9iT text_base__bZ6a4 text_paragraph-30___agDz markdown-subheading_subheading__g4TR2">Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards.</span></p><div data-testid="toc-narrow" class="box_m-t-3x__rN_qC box_m-b-6x__RhdjX markdown-toc_narrow__ErCJb"><button data-tracking-id="toc-accordion-clicked" aria-expanded="true" aria-controls=":R21mcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn 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 accordion_accordion__vbQko"><h5 class="box_p-t-1x__1ZOZv box_p-b-1x__E6rAE heading_base__MS64u heading_heading-5__lcRR4">On this page</h5><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m12 11.414-4-4-4 4L2.586 10 8 4.586 13.414 10 12 11.414Z" fill="#7B61FF"></path></svg></button><div role="region" id=":R21mcpddl6:" class="accordion_container__Q6e6I accordion_expanded__gzqmt"><div class="accordion_content__zl9fW"><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Overview</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#requirements-and-limitations" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Requirements and limitations</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#gift-cards-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Gift Cards API</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#gift-card-activities-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Gift Card Activities API</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#integration-with-square-apis" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Integration with Square APIs</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#custom-gans" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Custom GANs</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#qr-code-and-barcode-scanning" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">QR code and barcode scanning</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#physical-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Physical gift cards</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#third-party-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Third-party gift cards</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#sandbox-testing" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Sandbox testing</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#compliance-limits" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Compliance limits</a></div><div class="box_m-b-1x__b2HHn"><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#migration-notes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">Migration notes</a></div><div><a data-tracking-id="sidebar-link-clicked" href="/docs/gift-cards/using-gift-cards-api#see-also" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_">See also</a></div></div></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#overview" id="overview" aria-label="anchor link for overview" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for overview" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Overview</h2></div></div><p><span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/gift-cards" class="nodes_markdown-link__1J6_a">Square gift cards</a></span> allow sellers to offer a complete gifting program that can boost sales and attract new customers. Gift cards can be purchased online or in person and redeemed at all of the seller's locations. Buyers can send gift cards to friends and family to introduce them to a seller's business.</p><p>Developers use the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-cards-api" class="nodes_markdown-link__1J6_a">Gift Cards API</a></span> and <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-card-activities-api" class="nodes_markdown-link__1J6_a">Gift Card Activities API</a></span> to integrate gift cards into their applications. Watch the following video to see how the APIs work:</p><div data-testid="youtube-player" class="box_m-t-3x__rN_qC box_m-b-3x__A9ryy box_b-r-6__eFn6m markdown-youtube-player_container__JNB6d"><iframe class="markdown-youtube-player_iframe__EU8IE" src="https://www.youtube.com/embed/2tUbxgkjjCo?si=B6AgXb08P2tdu9F3" title="Youtube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen=""></iframe></div><p>You can also send <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/devtools/graphql" class="nodes_markdown-link__1J6_a">Square GraphQL</a></span> queries for read-only access to gift card data and use <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/webhooks" class="nodes_markdown-link__1J6_a">webhook events</a></span> to keep track of activities.</p><div data-testid="aside" data-test-type="info" class="box_m-t-4x__FOwYa box_m-b-4x__jr_IJ box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m box_sh-10__rHmX2 aside_aside__hEkR5 aside_info__6S1z3"><h4 class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Note</h4><div data-testid="aside-content"><p>Sellers use <span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/point-of-sale" class="nodes_markdown-link__1J6_a">Square Point of Sale</a></span> and the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://app.squareup.com/dashboard/gift-cards" class="nodes_markdown-link__1J6_a">Square Dashboard</a></span> to sell, redeem, track, or reload Square gift cards. Sellers can publish an eGift Card Order Site where buyers can purchase gift cards.</p><p>Buyers can view and manage their gift cards from their <span slot="trigger"><a data-tracking-id="markdown-link" href="https://profile.squareup.com" class="nodes_markdown-link__1J6_a">Square profile</a></span>.</p></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#requirements-and-limitations" id="requirements-and-limitations" aria-label="anchor link for requirements-and-limitations" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for requirements-and-limitations" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Requirements and limitations</h2></div></div><p>The following requirements, limitations, and other considerations apply when working with the Gift Cards API and Gift Card Activities API:</p><ul><li><p><strong>OAuth permissions</strong> - Applications using OAuth require <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GIFTCARDS_READ</code> for read operations and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GIFTCARDS_WRITE</code> for write operations.</p><p>Additional permissions might be required in gift card flows. For example:</p><ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CUSTOMERS_READ</code> - To get a customer ID to link a gift card.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PAYMENTS_WRITE</code> - To <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/manage-gift-cards-on-file#take-gift-card-on-file-payment" class="nodes_markdown-link__1J6_a">charge a gift card on file</a></span>.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PAYMENTS_WRITE</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ORDERS_WRITE</code> - To activate or reload gift cards using Orders API integration.</li></ul><p>Learn more about <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/oauth-api/overview" class="nodes_markdown-link__1J6_a">OAuth</a></span> and <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/oauth-api/square-permissions##gift-cards" class="nodes_markdown-link__1J6_a">endpoint permission requirements</a></span>.</p></li><li><p><strong>Gift card delivery</strong> - The developer is responsible for <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/sell-gift-cards#deliver-gift-cards" class="nodes_markdown-link__1J6_a">delivering information for digital gift cards</a></span> created using the Gift Cards API.</p></li><li><p><strong>Security of custom GANs</strong> - The developer is responsible for ensuring the security of <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#custom-gans" class="nodes_markdown-link__1J6_a">custom GANs</a></span>. For example, to mitigate the risk of fraud, don't use repeatable patterns or GANs that are easy to guess (such as 12345678).</p></li><li><p><strong>No application fees</strong> - Developers cannot collect application fees for gift card payments.<code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreatePayment</code> returns a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">BAD_REQUEST</code> error if the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">app_fee_money</code> field is included in a request to create a Square gift card payment.</p></li></ul><span class="markdown-anchor_container__0qZni"><a id="load-fees" class="markdown-anchor_anchor__lBAV_"></a></span><ul><li><p><strong>Load fees</strong> - Sellers in the following countries pay 2.5% of the amount added to a Square gift card, in addition to standard payment processing rates:</p><ul><li>Australia</li><li>Canada</li><li>United States</li></ul><p>Load fees apply to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code>, <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code>, and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ADJUST_INCREMENT</code> activities. There are no fees when a gift card is redeemed or refunded. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payments-pricing#gift-cards-pricing" class="nodes_markdown-link__1J6_a">Gift cards pricing</a></span>.</p><p>Square deducts or refunds load fees in seller payouts. To see all load fee deductions and refunds for a given payout, call <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/payouts-api/list-payout-entries" class="nodes_markdown-link__1J6_a">ListPayoutEntries</a></span> and iterate through the results to find following entry types:</p><ul><li><span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payouts-api/list-payout-entries#gift_card_load_fee" class="nodes_markdown-link__1J6_a">GIFT_CARD_LOAD_FEE</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payouts-api/list-payout-entries#gift_card_load_fee_refund" class="nodes_markdown-link__1J6_a">GIFT_CARD_LOAD_FEE_REFUND</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payouts-api/list-payout-entries#undo_gift_card_load_fee_refund" class="nodes_markdown-link__1J6_a">UNDO_GIFT_CARD_LOAD_FEE_REFUND</a></span></li></ul></li><li><p><strong>Customer linking limits</strong> - When saving <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/manage-gift-cards-on-file" class="nodes_markdown-link__1J6_a">gift cards on file</a></span>:</p><ul><li>The maximum number of gift cards you can link to a customer profile is 50.</li><li>The maximum number of customer profiles you can link to a gift card is 10.</li></ul></li><li><p><strong>Square Dashboard reporting</strong> - When third-party applications use <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#integration-with-orders-api-and-payments-api" class="nodes_markdown-link__1J6_a">Orders API or Payments API integration</a></span> to reload or redeem a gift card, the Square Dashboard reports include these transactions. In contrast, there's no reporting when reloading and redeeming gift cards using non-Square APIs.</p><p>All activated gift cards are listed in the Square Dashboard regardless of the system used to process the gift card order. However, if the gift card order was processed with non-Square APIs, the <strong>Receipt</strong> link to the transaction isn't available from the gift card's <strong>Activity</strong> card in the <strong>Gift Cards</strong> section.</p></li><li><p><strong>Square API integration</strong> - Additional requirements and limitations apply when <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#integration-with-square-apis" class="nodes_markdown-link__1J6_a">integrating with other Square APIs</a></span>.</p></li><li><p><strong>Activity history</strong> - <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code>, <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CLEAR_BALANCE</code>, and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">IMPORT</code> activities that occurred before March 2, 2016, aren't included in <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListGiftCardActivities</code> results or when viewing the activity history in the Square Dashboard.</p></li></ul><span class="markdown-anchor_container__0qZni"><a id="giftcard" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#gift-cards-api" id="gift-cards-api" aria-label="anchor link for gift-cards-api" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for gift-cards-api" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Gift Cards API</h2></div></div><p>You can create gift cards, retrieve gift card information, and manage gift cards on file.</p><p>The following example <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCard</code> request creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">DIGITAL</code> gift card. You can also use this endpoint to register a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PHYSICAL</code> gift card.</p><div data-testid="tabset" role="tablist" class="box_m-b-4x__jr_IJ tab_tabset__c44HM markdown-tabset_tabset__G8lmz"><div class="box_b-t-l-std__qC_VL tab_tabset-underline__Wu7oW"></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"CreateGiftCard request"}" role="tab" aria-label="CreateGiftCard request" aria-selected="true" aria-controls="creategiftcard-request-panel" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7 tab_selected__c2f_5">CreateGiftCard request</p></button><div class="box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr box_b-bl-r-6__Z_gEo tab_underline__AUKDk"></div></div><div class="tab_tabset-item__6fS_h tab_last__LmwSF tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"GiftCard object in response"}" role="tab" aria-label="GiftCard object in response" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">GiftCard object in response</p></button></div></div><div role="tabpanel" id="creategiftcard-request-panel"><div data-testid="markdown-tab-CreateGiftCard request" class="box_m-t-3x__rN_qC markdown-tabset_tab__0c8OW"><div tabindex="-1" class="box_m-t-3x__rN_qC box_p-l-2x__0A2_9 box_p-r-1x__PmqSN box_p-t-1x__1ZOZv box_p-b-1x__E6rAE box_b-l-std__hNqJW box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr code-block_header__urOUF code-block_request__DDmE0 dark-mode-theme"><div><p class="text_base__bZ6a4 text_paragraph-20__2lYBq text_semi-bold-20__pPQeH">Create gift card</p></div><div><div class="code-block-action-button-group_button-group__QsOaL"><div><div class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN"><button data-testid="code-block-ignition-language-dropdown" data-tracking-id="code-block-actions-list" aria-haspopup="true" aria-expanded="false" aria-controls=":R1im9mcpddl6:" aria-label="Coding language dropdown selection" aria-description="A dropdown to select what coding language the request code block should be in." 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"><p class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-10__9t3Cn text_semi-bold-10__HOPCI">cURL</p><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div></div></div></div></div><div data-testid="code-block" data-language="curl" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-bl-r-6__Z_gEo box_b-br-r-6__rpqJb code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4 code-block_loading__crLab markdown-code-block_loading__dPYof"><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></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></div></div><p>New gift cards have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PENDING</code> state and zero balance. After creating a gift card, call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> to activate it with an initial balance before first use. For steps, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/sell-gift-cards" class="nodes_markdown-link__1J6_a">Sell Square Gift Cards</a></span>.</p><p>The <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">id</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan</code> fields are used in API requests. For example, use:</p><ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan</code> with the Web Payments SDK or In-App Payments SDK to generate a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">source_id</code> for a gift card payment in a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreatePayment</code> request.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">id</code> as the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">source_id</code> for a gift card on file payment in a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreatePayment</code> request.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">id</code> as the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">destination_id</code> when issuing store credit in a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateRefund</code> request. This is an alternative method for activating a gift card.</li></ul><span class="markdown-anchor_container__0qZni"><a id="giftcardactivity" class="markdown-anchor_anchor__lBAV_"></a></span><span class="markdown-anchor_container__0qZni"><a id="manage-balance-or-state" class="markdown-anchor_anchor__lBAV_"></a></span><span class="markdown-anchor_container__0qZni"><a id="managing-the-gift-card-balance-or-state" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#gift-card-activities-api" id="gift-card-activities-api" aria-label="anchor link for gift-card-activities-api" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for gift-card-activities-api" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Gift Card Activities API</h2></div></div><p>You can activate a gift card with a balance, load additional funds, redeem the gift card for purchases, and create other activities that change the gift card balance or state.</p><p>A <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> request defines a specific activity <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">type</code> and includes a corresponding <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY"><activity-type>_activity_details</code> field that provides the information needed to create the activity. The following example creates an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> type based on the provided <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">activate_activity_details</code>:</p><div data-testid="tabset" role="tablist" class="box_m-b-4x__jr_IJ tab_tabset__c44HM markdown-tabset_tabset__G8lmz"><div class="box_b-t-l-std__qC_VL tab_tabset-underline__Wu7oW"></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"CreateGiftCardActivity request"}" role="tab" aria-label="CreateGiftCardActivity request" aria-selected="true" aria-controls="creategiftcardactivity-request-panel" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7 tab_selected__c2f_5">CreateGiftCardActivity request</p></button><div class="box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr box_b-bl-r-6__Z_gEo tab_underline__AUKDk"></div></div><div class="tab_tabset-item__6fS_h tab_last__LmwSF tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"GiftCardActivity object in response"}" role="tab" aria-label="GiftCardActivity object in response" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">GiftCardActivity object in response</p></button></div></div><div role="tabpanel" id="creategiftcardactivity-request-panel"><div data-testid="markdown-tab-CreateGiftCardActivity request" class="box_m-t-3x__rN_qC markdown-tabset_tab__0c8OW"><div tabindex="-1" class="box_m-t-3x__rN_qC box_p-l-2x__0A2_9 box_p-r-1x__PmqSN box_p-t-1x__1ZOZv box_p-b-1x__E6rAE box_b-l-std__hNqJW box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr code-block_header__urOUF code-block_request__DDmE0 dark-mode-theme"><div><p class="text_base__bZ6a4 text_paragraph-20__2lYBq text_semi-bold-20__pPQeH">Create gift card activity</p></div><div><div class="code-block-action-button-group_button-group__QsOaL"><div><div class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN"><button data-testid="code-block-ignition-language-dropdown" data-tracking-id="code-block-actions-list" aria-haspopup="true" aria-expanded="false" aria-controls=":R1imemcpddl6:" aria-label="Coding language dropdown selection" aria-description="A dropdown to select what coding language the request code block should be in." 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"><p class="box_m-r-05x__m9ODf text_base__bZ6a4 text_paragraph-10__9t3Cn text_semi-bold-10__HOPCI">cURL</p><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div></div></div></div></div><div data-testid="code-block" data-language="curl" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-bl-r-6__Z_gEo box_b-br-r-6__rpqJb code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4 code-block_loading__crLab markdown-code-block_loading__dPYof"><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></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></div></div><p><span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#integration-with-square-apis" class="nodes_markdown-link__1J6_a">Built-in integration</a></span> with other Square APIs helps simplify activate, reload, redeem, and refund flows.</p><span class="markdown-anchor_container__0qZni"><a id="supported-activity-types" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="3" class="box_m-t-3x__rN_qC box_m-b-2x__nVJGZ"><a href="#supported-activity-types-for-creategiftcardactivity" id="supported-activity-types-for-creategiftcardactivity" aria-label="anchor link for supported-activity-types-for-creategiftcardactivity" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for supported-activity-types-for-creategiftcardactivity" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Supported activity types for CreateGiftCardActivity</h3></div></div><p>Gift card activities are used to manage a gift card's balance or state. You can use the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> endpoint to create the following activity types:</p><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:220px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Activity type </th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Description</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Activates a gift card with a balance. A gift card must be in the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVE</code> state to be used for any other activity. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/sell-gift-cards" class="nodes_markdown-link__1J6_a">Sell Square Gift Cards</a></span>.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityActivate" class="nodes_markdown-link__1J6_a">activate_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Loads a gift card with additional funds. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/reload-gift-cards" class="nodes_markdown-link__1J6_a">Reload Square Gift Cards</a></span>.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityLoad" class="nodes_markdown-link__1J6_a">load_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Redeems funds from a gift card after a gift card payment.</p><p>If your application uses the Payments API to make a gift card payment, Square automatically creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code> activity that updates the gift card balance after the payment is completed. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/redeem-gift-cards" class="nodes_markdown-link__1J6_a">Redeem Square Gift Cards</a></span>.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityRedeem" class="nodes_markdown-link__1J6_a">redeem_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CLEAR_BALANCE</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Sets a gift card balance to zero. This activity should be called before reusing a physical gift card.</p><p>When a physical gift card reaches a zero balance for any reason, Square automatically unlinks all customers from the gift card. This behavior helps keep the linked customer profile setting up to date if the card is reused.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityClearBalance" class="nodes_markdown-link__1J6_a">clear_balance_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">DEACTIVATE</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Permanently blocks a gift card from any future balance-changing activities. This activity should be called to prevent a gift card from being used (for example, before discarding a physical gift card or if the card is lost or stolen).</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityDeactivate" class="nodes_markdown-link__1J6_a">deactivate_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ADJUST_INCREMENT</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Increases a gift card balance when the adjustment isn't related to a gift card order or payment. To increase the balance based on gift card orders or payments, use the appropriate <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code>, <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code>, or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activity.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityAdjustIncrement" class="nodes_markdown-link__1J6_a">adjust_increment_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ADJUST_DECREMENT</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Decreases a gift card balance when the adjustment isn't related to a gift card payment. To decrease the balance based on a gift card payment, use the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code> activity.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityAdjustDecrement" class="nodes_markdown-link__1J6_a">adjust_decrement_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Adds money to a gift card from a refunded transaction. Refunds linked to a Square payment have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code>. Refunds to the same gift card used to make the payment have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">redeem_activity_id</code>.</p><p>If your application uses the Refunds API to refund a payment to a gift card, Square automatically creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity that updates the gift card balance. Applications that use a custom processing system for <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">same-method gift card refunds</span></span> must explicitly create a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity and specify the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">redeem_activity_id</code>.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityRefund" class="nodes_markdown-link__1J6_a">refund_activity_details</a></span></p></td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code></p></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><p>Adds money to a gift card from a refunded transaction that wasn't paid with the same gift card.</p><p>This activity type is used by applications that use a custom processing system for <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">cross-method gift card refunds</span></span>.</p><p>Details field: <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/objects/GiftCardActivityUnlinkedActivityRefund" class="nodes_markdown-link__1J6_a">unlinked_activity_refund_activity_details</a></span></p></td></tr></tbody></table></div></div><span class="markdown-anchor_container__0qZni"><a id="unsupported-activities" class="markdown-anchor_anchor__lBAV_"></a></span><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":Ri6cpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="4"><a href="#unsupported-activity-types" id="unsupported-activity-types" aria-label="anchor link for unsupported-activity-types" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for unsupported-activity-types" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Unsupported activity types</h4></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":Ri6cpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>You cannot use <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivities</code> to create the following activity types:</p><ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">BLOCK</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNBLOCK</code> - Square manages these activities while processing chargeback transactions for disputed payments.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">IMPORT</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">IMPORT_REVERSAL</code> - Sellers must work with Square Support to import <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#third-party-gift-cards" class="nodes_markdown-link__1J6_a">third-party gift cards</a></span> or reverse previously imported gift cards.</li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">TRANSFER_BALANCE_TO</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">TRANSFER_BALANCE_FROM</code> - Square creates these activities when a buyer transfers money between gift cards linked to their <span slot="trigger"><a data-tracking-id="markdown-link" href="https://profile.squareup.com" class="nodes_markdown-link__1J6_a">Square profile</a></span>.</li></ul><p>However, these activity types are included in <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListGiftCardActivities</code> results and invoke <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gift_card.activity.created</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gift_card.updated</code> <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/webhooks" class="nodes_markdown-link__1J6_a">webhook events</a></span>.</p></div></div><div data-testid="aside" data-test-type="info" class="box_m-t-4x__FOwYa box_m-b-4x__jr_IJ box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m box_sh-10__rHmX2 aside_aside__hEkR5 aside_info__6S1z3"><h4 class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Note</h4><div data-testid="aside-content"><p>You can call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListGiftCardActivities</code> to view all activities or a filtered set of activities. The response includes gift card activities initiated by sellers and buyers using Square products, third-party applications calling Square APIs, and Square. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/retrieve-gift-cards-and-activities#list-gift-card-activities" class="nodes_markdown-link__1J6_a">List gift card activities</a></span>.</p></div></div><span class="markdown-anchor_container__0qZni"><a id="integration-with-orders-api-and-payments-api" class="markdown-anchor_anchor__lBAV_"></a></span><span class="markdown-anchor_container__0qZni"><a id="integration-with-square-apis" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#integration-with-square-apis" id="integration-with-square-apis" aria-label="anchor link for integration-with-square-apis" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for integration-with-square-apis" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Integration with Square APIs</h2></div></div><p>Square provides integrated gift card workflows for applications that use the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/orders-api" class="nodes_markdown-link__1J6_a">Orders API</a></span>, <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/payments-api" class="nodes_markdown-link__1J6_a">Payments API</a></span>, or <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/refund-api" class="nodes_markdown-link__1J6_a">Refunds API</a></span>.</p><span class="markdown-anchor_container__0qZni"><a id="orders-api-integration" class="markdown-anchor_anchor__lBAV_"></a></span><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":Rlmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="3"><a href="#orders-api-integration-with-activate-and-load-activities" id="orders-api-integration-with-activate-and-load-activities" aria-label="anchor link for orders-api-integration-with-activate-and-load-activities" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for orders-api-integration-with-activate-and-load-activities" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Orders API integration with ACTIVATE and LOAD activities</h3></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":Rlmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>With Orders API integration, Square reads information from the order used to sell or reload a gift card. You provide an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">order_id</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">line_item_uid</code> (of the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GIFT_CARD</code> line item) when you create the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code> activity. The following are typical high-level flows:</p><ul><li><p><strong>Selling a gift card</strong> - Includes creating an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> activity:</p><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateOrder</code> -> <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreatePayment</code> -> <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCard</code> -> <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code></p></li><li><p><strong>Reloading a gift card</strong> - Includes creating a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code> activity:</p><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateOrder</code> -> <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreatePayment</code> -> <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code></p></li></ul><p>Resulting <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code> activities include the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">order_id</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">line_item_uid</code> you provided in the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> request, as shown in the following examples. The amount of the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GIFT_CARD</code> line item is added to the gift card balance.</p><div data-testid="tabset" role="tablist" class="box_m-b-4x__jr_IJ tab_tabset__c44HM markdown-tabset_tabset__G8lmz"><div class="box_b-t-l-std__qC_VL tab_tabset-underline__Wu7oW"></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"ACTIVATE activity"}" role="tab" aria-label="ACTIVATE activity" aria-selected="true" aria-controls="activate-activity-panel" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7 tab_selected__c2f_5">ACTIVATE activity</p></button><div class="box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr box_b-bl-r-6__Z_gEo tab_underline__AUKDk"></div></div><div class="tab_tabset-item__6fS_h tab_last__LmwSF tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"LOAD activity"}" role="tab" aria-label="LOAD activity" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">LOAD activity</p></button></div></div><div role="tabpanel" id="activate-activity-panel"><div data-testid="markdown-tab-ACTIVATE activity" class="box_m-t-3x__rN_qC markdown-tabset_tab__0c8OW"><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" data-test-expanded="false" aria-expanded="false" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:2ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"gift_card_activity"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"id"</span>: <span class="hljs-string">"gcact_c24da663c0d242f5a29837d8e165bf97"</span>, <span data-line-number=""></span> <span class="hljs-attr">"type"</span>: <span class="hljs-string">"ACTIVATE"</span>, <span data-line-number=""></span> <span class="hljs-attr">"location_id"</span>: <span class="hljs-string">"M8AKAD8160XGR"</span>, <span data-line-number=""></span> <span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"2024-08-11T19:01:14.000Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_id"</span>: <span class="hljs-string">"gftc:012440e514754c42990f3de4527498dc"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_gan"</span>: <span class="hljs-string">"7783320002382646"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_balance_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">2500</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"activate_activity_details"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">2500</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"order_id"</span>: <span class="hljs-string">"q8vfn99RLTr7FuMaUtuDG6RHdCcZY"</span>, <span data-line-number=""></span> <span class="hljs-attr">"line_item_uid"</span>: <span class="hljs-string">"syHOf0zv9OjS2vhkhFozVC"</span> <span data-line-number=""></span> } <span data-line-number=""></span> } <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><button data-testid="expand-bottom-code-block" data-tracking-id="expand-bottom-code-block" class="native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 code-block-footer_button__TNCq_ code-block-footer_round__rqS_d markdown-code-block_bar-position__B59Cr"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M16.414 13 12 17.414 7.586 13 9 11.586l2 2V7h2v6.586l2-2L16.414 13Z" fill="#7B61FF"></path></svg></button><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></div></div><p>For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/sell-gift-cards" class="nodes_markdown-link__1J6_a">Sell Square Gift Cards</a></span> and <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/reload-gift-cards" class="nodes_markdown-link__1J6_a">Reload Square Gift Cards</a></span>.</p><div data-markdown-heading="4" class="box_m-t-3x__rN_qC box_m-b-05x__rKeET"><a href="#requirements-and-limitations-for-orders-api-integration" id="requirements-and-limitations-for-orders-api-integration" aria-label="anchor link for requirements-and-limitations-for-orders-api-integration" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for requirements-and-limitations-for-orders-api-integration" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Requirements and limitations for Orders API integration</h4></div></div><ul><li><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">order_id</code> - The specified order must be in the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">COMPLETED</code> state before you can activate or load the gift card.</p></li><li><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">line_item_uid</code> - The specified line item with the gift card amount must explicitly set <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GIFT_CARD</code> as the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">item_type</code>. Otherwise, the order isn't processed as a gift card sale and you cannot use Orders API integration to activate or load the gift card.</p></li><li><p>If a gift card order is later refunded, the Refunds API doesn't automatically update the gift card balance. To deduct the funds from the balance, call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> and create an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ADJUST_DECREMENT</code> activity with the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PURCHASE_WAS_REFUNDED</code> reason. Note that the Refunds API does update the balance after refunding a payment to a gift card.</p></li></ul><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":R25lmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="4"><a href="#custom-order-processing-non-square-apis" id="custom-order-processing-non-square-apis" aria-label="anchor link for custom-order-processing-non-square-apis" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for custom-order-processing-non-square-apis" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Custom order processing (non-Square APIs)</h4></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":R25lmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>If your application doesn't use the Orders API to process orders, you must call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> to create the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LOAD</code> activity. Provide the following activity details in the request:</p><ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">amount_money</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">buyer_payment_instrument_ids</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">reference_id</code> (optional)</li></ul></div></div></div></div><span class="markdown-anchor_container__0qZni"><a id="payments-api-integration" class="markdown-anchor_anchor__lBAV_"></a></span><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":Rmmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="3"><a href="#payments-api-integration-with-redeem-activities" id="payments-api-integration-with-redeem-activities" aria-label="anchor link for payments-api-integration-with-redeem-activities" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for payments-api-integration-with-redeem-activities" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Payments API integration with REDEEM activities</h3></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":Rmmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>With Payments API integration, Square automatically creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code> activity that updates the gift card balance after the payment is processed. Your application doesn't need to call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code>.</p><p>Resulting <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code> activities have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code>, as shown in the following example. The payment amount is deducted from the gift card balance.</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" data-test-expanded="false" aria-expanded="false" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:2ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"gift_card_activity"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"id"</span>: <span class="hljs-string">"gcact_d31b4200f5174fc48cb7138aeae197d0"</span>, <span data-line-number=""></span> <span class="hljs-attr">"type"</span>: <span class="hljs-string">"REDEEM"</span>, <span data-line-number=""></span> <span class="hljs-attr">"location_id"</span>: <span class="hljs-string">"M8AKAD8160XGR"</span>, <span data-line-number=""></span> <span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"2024-08-15T15:57:43.000Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_id"</span>: <span class="hljs-string">"gftc:065fd3c6e1014c9293bd2d09475ea189"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_gan"</span>: <span class="hljs-string">"7783320009623257"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_balance_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">7450</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"redeem_activity_details"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">2550</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"payment_id"</span>: <span class="hljs-string">"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY"</span>, <span data-line-number=""></span> <span class="hljs-attr">"status"</span>: <span class="hljs-string">"COMPLETED"</span> <span data-line-number=""></span> } <span data-line-number=""></span> } <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><button data-testid="expand-bottom-code-block" data-tracking-id="expand-bottom-code-block" class="native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 code-block-footer_button__TNCq_ code-block-footer_round__rqS_d markdown-code-block_bar-position__B59Cr"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M16.414 13 12 17.414 7.586 13 9 11.586l2 2V7h2v6.586l2-2L16.414 13Z" fill="#7B61FF"></path></svg></button><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div><p>For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/redeem-gift-cards" class="nodes_markdown-link__1J6_a">Redeem Square Gift Cards</a></span>.</p><div data-markdown-heading="4" class="box_m-t-3x__rN_qC box_m-b-05x__rKeET"><a href="#gift-card-details-in-a-payment-object" id="gift-card-details-in-a-payment-object" aria-label="anchor link for gift-card-details-in-a-payment-object" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for gift-card-details-in-a-payment-object" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Gift card details in a Payment object</h4></div></div><p>For gift card payments, the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">card_brand</code> field is <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">SQUARE_GIFT_CARD</code>. Note that Square supports <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards" class="nodes_markdown-link__1J6_a">partial payment flows</a></span> using gift cards.</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" data-test-expanded="false" aria-expanded="false" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:2ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"payment"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"id"</span>: <span class="hljs-string">"JaHoTpbmK8dofR9cUheOJl9dQVcZY"</span>, <span data-line-number=""></span> <span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"2024-07-25T17:24:30.345Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"2024-07-25T17:24:30.444Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"amount_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">522</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"status"</span>: <span class="hljs-string">"COMPLETED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"delay_duration"</span>: <span class="hljs-string">"PT168H"</span>, <span data-line-number=""></span> <span class="hljs-attr">"source_type"</span>: <span class="hljs-string">"CARD"</span>, <span data-line-number=""></span> <span class="hljs-attr">"card_details"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"status"</span>: <span class="hljs-string">"CAPTURED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"card"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"card_brand"</span>: <span class="hljs-string">"SQUARE_GIFT_CARD"</span>, <span data-line-number=""></span> <span class="hljs-attr">"last_4"</span>: <span class="hljs-string">"1923"</span>, <span data-line-number=""></span> <span class="hljs-attr">"exp_month"</span>: <span class="hljs-number">12</span>, <span data-line-number=""></span> <span class="hljs-attr">"exp_year"</span>: <span class="hljs-number">2050</span>, <span data-line-number=""></span> <span class="hljs-attr">"fingerprint"</span>: <span class="hljs-string">"sq-1-y_yFcziMlsxVSomRNQZ7xBaW0F1xxE-6TbcGKl7KOoy3GI1mh094CY4_Ox5RzUN7Vg"</span>, <span data-line-number=""></span> <span class="hljs-attr">"card_type"</span>: <span class="hljs-string">"DEBIT"</span>, <span data-line-number=""></span> <span class="hljs-attr">"prepaid_type"</span>: <span class="hljs-string">"PREPAID"</span>, <span data-line-number=""></span> <span class="hljs-attr">"bin"</span>: <span class="hljs-string">"778332"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"entry_method"</span>: <span class="hljs-string">"KEYED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"auth_result_code"</span>: <span class="hljs-string">"0"</span>, <span data-line-number=""></span> <span class="hljs-attr">"card_payment_timeline"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"authorized_at"</span>: <span class="hljs-string">"2024-07-25T17:24:30.381Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"captured_at"</span>: <span class="hljs-string">"2024-07-25T17:24:30.444Z"</span> <span data-line-number=""></span> } <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"location_id"</span>: <span class="hljs-string">"M8AKAD8160XGR"</span>, <span data-line-number=""></span> <span class="hljs-attr">"order_id"</span>: <span class="hljs-string">"sYr0y9eUZBoXd2dmXhjvDGOW0e4F"</span>, <span data-line-number=""></span> <span class="hljs-attr">"total_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">522</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"approved_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">522</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"receipt_url"</span>: <span class="hljs-string">"https://squareupsandbox.com/receipt/preview/JaHoTpbmK8dofR9cUheOJl9dQVcZY"</span>, <span data-line-number=""></span> <span class="hljs-attr">"delay_action"</span>: <span class="hljs-string">"CANCEL"</span>, <span data-line-number=""></span> <span class="hljs-attr">"delayed_until"</span>: <span class="hljs-string">"2024-08-01T17:24:30.345Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"application_details"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"square_product"</span>: <span class="hljs-string">"ECOMMERCE_API"</span>, <span data-line-number=""></span> <span class="hljs-attr">"application_id"</span>: <span class="hljs-string">"sandbox-sq0idb-ioiyW39PwreFzwXoGyLtYg"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"version_token"</span>: <span class="hljs-string">"4WWgYqa7KXd6rIW82VkYxKF36EYkNyx4MGrq0Vxf5cm6o"</span> <span data-line-number=""></span> } <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><button data-testid="expand-bottom-code-block" data-tracking-id="expand-bottom-code-block" class="native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 code-block-footer_button__TNCq_ code-block-footer_round__rqS_d markdown-code-block_bar-position__B59Cr"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M16.414 13 12 17.414 7.586 13 9 11.586l2 2V7h2v6.586l2-2L16.414 13Z" fill="#7B61FF"></path></svg></button><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":R25mmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="4"><a href="#custom-payment-processing-non-square-apis" id="custom-payment-processing-non-square-apis" aria-label="anchor link for custom-payment-processing-non-square-apis" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for custom-payment-processing-non-square-apis" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Custom payment processing (non-Square APIs)</h4></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":R25mmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>If your application doesn't use the Payments API to process payments, you must call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> to create the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REDEEM</code> activity. Provide the following activity details in the request:</p><ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">amount_money</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">reference_id</code> (optional)</li></ul></div></div></div></div><span class="markdown-anchor_container__0qZni"><a id="refunds-api-integration" class="markdown-anchor_anchor__lBAV_"></a></span><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":Rnmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="3"><a href="#refunds-api-integration-with-refund-activities" id="refunds-api-integration-with-refund-activities" aria-label="anchor link for refunds-api-integration-with-refund-activities" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for refunds-api-integration-with-refund-activities" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Refunds API integration with REFUND activities</h3></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":Rnmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>With Refunds API integration, you can process <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">same-method gift card refunds</span></span> and <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">cross-method gift card refunds</span></span>. Square automatically creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity that updates the gift card balance after the refund is processed. Your application doesn't need to call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code>.</p><div data-testid="aside" data-test-type="info" class="box_m-t-4x__FOwYa box_m-b-4x__jr_IJ box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m box_sh-10__rHmX2 aside_aside__hEkR5 aside_info__6S1z3"><h4 class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Note</h4><div data-testid="aside-content"><p>You can issue a cross-method refund to a new gift card by first calling <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCard</code> to create the gift card and then refunding directly to the new gift card. Doing so automatically changes the state from <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PENDING</code> to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVE</code>.</p></div></div><p>Resulting <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activities include a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code> if the refund is linked to a payment processed by Square and a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">redeem_activity_id</code> if the payment was redeemed from the same gift card. The refund amount is added to the gift card balance.</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" data-test-expanded="false" aria-expanded="false" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:2ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"gift_card_activity"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"id"</span>: <span class="hljs-string">"gcact_5a877a9e75d840e990aae654173ed655"</span>, <span data-line-number=""></span> <span class="hljs-attr">"type"</span>: <span class="hljs-string">"REFUND"</span>, <span data-line-number=""></span> <span class="hljs-attr">"location_id"</span>: <span class="hljs-string">"M8AKAD8160XGR"</span>, <span data-line-number=""></span> <span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"2024-08-15T15:59:45.000Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_id"</span>: <span class="hljs-string">"gftc:065fd3c6e1014c9293bd2d09475ea189"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_gan"</span>: <span class="hljs-string">"7783320009623257"</span>, <span data-line-number=""></span> <span class="hljs-attr">"gift_card_balance_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">10000</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"refund_activity_details"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"redeem_activity_id"</span>: <span class="hljs-string">"gcact_d31b4200f5174fc48cb7138aeae197d0"</span>, <span data-line-number=""></span> <span class="hljs-attr">"amount_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">2550</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"payment_id"</span>: <span class="hljs-string">"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY"</span> <span data-line-number=""></span> } <span data-line-number=""></span> } <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><button data-testid="expand-bottom-code-block" data-tracking-id="expand-bottom-code-block" class="native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 code-block-footer_button__TNCq_ code-block-footer_round__rqS_d markdown-code-block_bar-position__B59Cr"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M16.414 13 12 17.414 7.586 13 9 11.586l2 2V7h2v6.586l2-2L16.414 13Z" fill="#7B61FF"></path></svg></button><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div><div data-markdown-heading="4" class="box_m-t-3x__rN_qC box_m-b-05x__rKeET"><a href="#gift-card-details-in-a-refund-object" id="gift-card-details-in-a-refund-object" aria-label="anchor link for gift-card-details-in-a-refund-object" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for gift-card-details-in-a-refund-object" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Gift card details in a Refund object</h4></div></div><p>The refund flow determines whether gift card details are included in the refund. For gift card transactions, the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">card_details.card.card_brand</code> field is set to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">SQUARE_GIFT_CARD</code>.</p><div data-testid="tabset" role="tablist" class="box_m-b-4x__jr_IJ tab_tabset__c44HM markdown-tabset_tabset__G8lmz"><div class="box_b-t-l-std__qC_VL tab_tabset-underline__Wu7oW"></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Same-method gift card refund"}" role="tab" aria-label="Same-method gift card refund" aria-selected="true" aria-controls="same-method-gift-card-refund-panel" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7 tab_selected__c2f_5">Same-method gift card refund</p></button><div class="box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr box_b-bl-r-6__Z_gEo tab_underline__AUKDk"></div></div><div class="tab_tabset-item__6fS_h tab_last__LmwSF tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Cross-method gift card refund"}" role="tab" aria-label="Cross-method gift card refund" 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"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">Cross-method gift card refund</p></button></div></div><div role="tabpanel" id="same-method-gift-card-refund-panel"><div data-testid="markdown-tab-Same-method gift card refund" class="box_m-t-3x__rN_qC markdown-tabset_tab__0c8OW"><p>Gift card details aren't included in a same-method refund. To get details about the gift card that made the payment and received the refund, call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GetPayment</code> using the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code> from the refund and check the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">card_details</code> field.</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:2ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"refund"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"id"</span>: <span class="hljs-string">"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY_JnAde8lQt5pt9MLAMZ4UgaXt0sN3ZGqr62Ohx23tGGH"</span>, <span data-line-number=""></span> <span class="hljs-attr">"status"</span>: <span class="hljs-string">"COMPLETED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"amount_money"</span>: { <span data-line-number=""></span> <span class="hljs-attr">"amount"</span>: <span class="hljs-number">1500</span>, <span data-line-number=""></span> <span class="hljs-attr">"currency"</span>: <span class="hljs-string">"USD"</span> <span data-line-number=""></span> }, <span data-line-number=""></span> <span class="hljs-attr">"payment_id"</span>: <span class="hljs-string">"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY"</span>, <span data-line-number=""></span> <span class="hljs-attr">"order_id"</span>: <span class="hljs-string">"kayuaH6E5v63RuuaXLSyJa8Qrc4F"</span>, <span data-line-number=""></span> <span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"2024-08-15T15:59:30.564Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"2024-08-15T15:59:45.590Z"</span>, <span data-line-number=""></span> <span class="hljs-attr">"location_id"</span>: <span class="hljs-string">"M8AKAD8160XGR"</span>, <span data-line-number=""></span> <span class="hljs-attr">"destination_type"</span>: <span class="hljs-string">"CARD"</span> <span data-line-number=""></span> } <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></div></div><p>Refunds to the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">SQUARE_GIFT_CARD</code> card brand don't affect a seller's payment processing balance. Note that a refund might take up to 14 days to complete. For more information about refund flows, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/payments-api/refund-payments" class="nodes_markdown-link__1J6_a">Refund Payments</a></span>.</p><div data-markdown-heading="4" class="box_m-t-3x__rN_qC box_m-b-05x__rKeET"><a href="#requirements-and-limitations-for-refunds-api-integration" id="requirements-and-limitations-for-refunds-api-integration" aria-label="anchor link for requirements-and-limitations-for-refunds-api-integration" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for requirements-and-limitations-for-refunds-api-integration" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Requirements and limitations for Refunds API integration</h4></div></div><ul><li>Square API version 2024-08-21 or later is required for the following features related to cross-method refunds:<ul><li>Using <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">RefundPayment</code> to create cross-method gift card refunds.</li><li>Using <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GetRefund</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListRefunds</code> to retrieve cross-method gift card refunds. When using earlier Square API versions, <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GetRefund</code> returns an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">API_VERSION_INCOMPATIBLE</code> error and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListRefunds</code> omits cross-method gift card refunds from the results.</li><li>Using <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GetPayment</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListPayments</code> to get <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">refunded_money</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">refund_ids</code> details related to the refund. When using earlier Square API versions, this information is omitted from the returned payments. Therefore, the payment IDs in corresponding <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity details aren't useful for tracking refund activity.</li></ul></li><li>Refunding to a new gift card activates the card by changing the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">PENDING</code> state to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVE</code> and adding an initial balance equal to the refund amount. This process creates a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity but doesn't create an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ACTIVATE</code> activity.</li><li>Gift cards with custom GANs cannot receive cross-method refunds using the Refunds API.</li></ul><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":R2tnmcpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="4"><a href="#custom-refund-processing-non-square-apis" id="custom-refund-processing-non-square-apis" aria-label="anchor link for custom-refund-processing-non-square-apis" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for custom-refund-processing-non-square-apis" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h4 class="heading_base__MS64u heading_heading-10__p_aLg">Custom refund processing (non-Square APIs)</h4></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":R2tnmcpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>If your application doesn't use the Refunds API to process refunds, you must call <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> to create the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> or <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activity.</p><ul><li>For <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">same-method gift card refunds</span></span> - Create a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity and provide the following activity details in the request:<ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">amount_money</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">redeem_activity_id</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">reference_id</code> (optional)</li></ul></li><li>For <span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">cross-method gift card refunds</span></span> - Create an <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activity and provide the following activity details in the request:<ul><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">amount_money</code></li><li><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">reference_id</code> (optional)</li></ul></li></ul><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activities created by custom processing systems don't have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code> because they aren't linked to a Square payment.</p></div></div></div></div></article><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><span class="markdown-anchor_container__0qZni"><a id="custom-gans" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#custom-gans" id="custom-gans" aria-label="anchor link for custom-gans" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for custom-gans" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Custom GANs</h2></div></div><p>The <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCard</code> endpoint allows you to specify a custom GAN when you create a gift card. The custom GAN that you provide in the request must meet the following requirements:</p><ul><li>The custom GAN must be unique for the Square seller account.</li><li>The custom GAN must contain 8 to 20 alphanumeric characters. Note that only numeric characters can be used if you want to generate <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#scanning" class="nodes_markdown-link__1J6_a">QR codes or barcodes</a></span>.</li><li>The custom GAN cannot start with:<ul><li>A bank identification number (BIN) pattern used by major credit cards (such as Visa, Mastercard, and American Express).</li><li>A BIN used by Square gift cards: 778273 (physical) or 778332 (digital).</li></ul></li></ul><p>Gift cards created with a custom GAN have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan_source</code> of <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">OTHER</code>.</p><div data-testid="aside" data-test-type="info" class="box_m-t-4x__FOwYa box_m-b-4x__jr_IJ box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m box_sh-10__rHmX2 aside_aside__hEkR5 aside_info__6S1z3"><h4 class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Note</h4><div data-testid="aside-content"><p>For an example <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCard</code> request that creates a gift card with a custom GAN, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/sell-gift-cards#create-gift-card" class="nodes_markdown-link__1J6_a">Create or register the gift card</a></span>.</p></div></div><p>Custom GANs can enable scenarios that aren't possible with Square-assigned GANs. For example, they can be used for gift card redemptions across multiple Square sellers and channels, to attach a value to non-gift-card items such as tickets, and to allow sellers to accept gift cards created by external sites. Gift cards with custom GANs can be redeemed just like gift cards with Square-assigned GANs.</p><p>Buyers use GANs to make gift card payments and check the gift card balance. It's the responsibility of the developer to ensure the security of their custom GANs. For example, to mitigate the risk of fraud, avoid using repeatable patterns or GANs that are easy to guess (such as 12345678).</p><p>You should be aware of the following limitation for gift cards with custom GANs:</p><ul><li>After using the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">LinkCustomerToGiftCard</code> endpoint to add a gift card on file for a customer profile, the customer ID is added to the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">customer_ids</code> field of the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gift_card</code> object. However, linked gift cards that have custom GANs aren't currently visible as a card on file for the customer in Square products, such as Square Point of Sale or the Square Dashboard.</li></ul><span class="markdown-anchor_container__0qZni"><a id="scanning" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#qr-code-and-barcode-scanning" id="qr-code-and-barcode-scanning" aria-label="anchor link for qr-code-and-barcode-scanning" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for qr-code-and-barcode-scanning" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">QR code and barcode scanning</h2></div></div><p>Although Square APIs don't provide native code-generation support, you can use a third-party solution to generate a QR code or barcode for digital gift cards. For example, the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards/public/js/generate-barcode.js" class="nodes_markdown-link__1J6_a">Gift Card API Sample App</a></span> uses a JavaScript library to generate barcodes.</p><p>When generating a QR code or barcode, the encoded message must include the gift card number (GAN) in the following format:</p><blockquote><p><code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">sqgc://<GIFT_CARD_NUMBER></code> (for example: <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">sqgc://82000571903</code>)</p></blockquote><ul><li><p>Gift cards with a Square-assigned GAN have the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan_source</code> field set to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">SQUARE</code>. These gift cards can be scanned in Square Point of Sale.</p></li><li><p>Gift cards with a <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#custom-gans" class="nodes_markdown-link__1J6_a">custom GAN</a></span> have the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan_source</code> field set to <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">OTHER</code>. To support scanning with the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">sqgc://</code> prefix, the GAN must:</p><ul><li>Not start with a BIN used by major credit cards.</li><li>Not start with a BIN used by Square gift cards: 778273 (physical) or 778332 (digital).</li><li>Contain numeric characters only.</li><li>Pass the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://en.wikipedia.org/wiki/Luhn_algorithm" class="nodes_markdown-link__1J6_a">Luhn algorithm check</a></span>.</li></ul></li></ul><p>Note that physical (plastic) Square gift cards are imprinted with a QR code and barcode.</p><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#physical-gift-cards" id="physical-gift-cards" aria-label="anchor link for physical-gift-cards" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for physical-gift-cards" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Physical gift cards</h2></div></div><p>Note the following when working with physical (plastic) gift cards:</p><ul><li><p>Physical gift cards are imprinted with a 16-digit GAN and a barcode. The GAN is numeric only and starts with 778273. The GAN is stored in the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan</code> field of the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">GiftCard</code> object.</p></li><li><p>To sell physical gift cards, the seller must have previously ordered the gift card from Square and the gift card must be unused. Sellers can <span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/help/us/en/article/5393-order-your-square-gift-cards" class="nodes_markdown-link__1J6_a">order a pack of Square gift cards</a></span> in the Square Dashboard.</p></li><li><p>Testing physical gift cards in the Square Sandbox isn't supported.</p></li><li><p>When a physical gift card reaches a zero balance for any reason, Square automatically unlinks all customers from the gift card. This behavior helps keep the linked customer profiles setting current if the card is reused.</p></li></ul><span class="markdown-anchor_container__0qZni"><a id="third-party-gift-cards" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#third-party-gift-cards" id="third-party-gift-cards" aria-label="anchor link for third-party-gift-cards" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for third-party-gift-cards" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Third-party gift cards</h2></div></div><p>If a seller previously purchased gift cards from another gift card provider (not from Square) and sold them to customers, the seller must follow a one-time process with Square Support to import these third-party gift cards into Square. The seller can then accept these gift cards for redemption like Square gift cards. Third-party gift cards cannot be reloaded.</p><p>For third-party gift cards, the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan</code> field can contain a maximum of 255 characters and <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">gan_source</code> is <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">OTHER</code>.</p><div data-testid="aside" data-test-type="info" class="box_m-t-4x__FOwYa box_m-b-4x__jr_IJ box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m box_sh-10__rHmX2 aside_aside__hEkR5 aside_info__6S1z3"><h4 class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Note</h4><div data-testid="aside-content"><p>If you attempt to migrate third-party gift cards by creating digital Square gift cards programmatically, you might receive compliance limit or rate limit errors. For more information, <span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/help/contact?panel=BF53A9C8EF68" class="nodes_markdown-link__1J6_a">contact Developer Support</a></span>.</p></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#sandbox-testing" id="sandbox-testing" aria-label="anchor link for sandbox-testing" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for sandbox-testing" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Sandbox testing</h2></div></div><p>You can create and manage Square gift cards in the <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/devtools/sandbox/overview" class="nodes_markdown-link__1J6_a">Square Sandbox</a></span>. In addition, Square provides a test value that you can use to test gift card payments. For more information, see <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/redeem-gift-cards#sandbox-gift-card-payments" class="nodes_markdown-link__1J6_a">Testing gift card payments in the Sandbox</a></span>.</p><p>The following limitations apply to testing gift card payments in the Sandbox:</p><ul><li>Creating, managing, and testing with physical gift cards isn't supported.</li><li>The Virtual Terminal doesn't accept gift card payments.</li><li>The Web Payments SDK and In-App Payments SDK only accept Sandbox test values provided by Square. These values aren't tied to any gift cards in your account, so you cannot check whether the balance of the gift card is updated.</li></ul></article><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><span class="markdown-anchor_container__0qZni"><a id="compliance-limits" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#compliance-limits" id="compliance-limits" aria-label="anchor link for compliance-limits" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for compliance-limits" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Compliance limits</h2></div></div><p>Square enforces the following compliance limits for gift card activities that load funds onto digital or physical gift cards:</p><ul><li><strong>Maximum balance amount per gift card</strong> - The maximum amount for a gift card balance.</li><li><strong>Maximum load amount per gift card per day</strong> - The maximum amount that can be loaded onto a gift card in a 24-hour period.</li><li><strong>Maximum load amount per payment card per day</strong> - The maximum amount that a single payment card can load onto gift cards in a 24-hour period.</li><li><strong>Maximum outstanding balance amount per seller</strong> - The maximum amount of the total outstanding balance across all gift cards issued for a single seller.</li></ul><p>If a limit is exceeded, the <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">CreateGiftCardActivity</code> endpoint <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/gift-cards/using-gift-cards-api#compliance-limit-errors" class="nodes_markdown-link__1J6_a">returns an error</a></span> and doesn't complete the activity.</p><div data-markdown-heading="3" class="box_m-t-3x__rN_qC box_m-b-2x__nVJGZ"><a href="#per-country-compliance-limits" id="per-country-compliance-limits" aria-label="anchor link for per-country-compliance-limits" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for per-country-compliance-limits" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Per-country compliance limits</h3></div></div><p>The following tables contain the per-country limits that are enforced by Square:</p><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for Australia (AU)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in AUD</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$10,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for Canada (CA)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in CAD</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$10,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for France (FR) and Ireland (IR) </th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in EUR</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">750 EUR</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">750 EUR</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">7.500 EUR / 7,500 EUR</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for Japan (JP)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in YEN</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">楼50,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">楼50,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">楼1,000,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">楼10,000,000</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for Spain (ES)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in EUR</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">250 EUR (card cannot be reloaded)</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">250 EUR (card cannot be reloaded)</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">7,500 EUR</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for the United Kingdom (UK)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in GBP</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">拢750</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">拢750</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">拢7,500</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div class="box_m-t-5x__L06CC box_m-b-5x__RvXTy table_outer__9zV2D"><div data-testid="table" class="table_container__Ze6L1"><table class="table_table__wDx_x"><thead><tr><th style="width:350px" class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Limits for the United States (US)</th><th class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-std__q5XI3 text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy table_left__1NzD_">Amount in USD</th></tr></thead><tbody><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum balance amount per gift card</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per gift card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$2,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum load amount per payment card per day</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">$10,000</td></tr><tr><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_"><span data-testid="tooltip" class="tooltip_tooltip__UtAId"><span slot="trigger" class="tooltip_text__SYUVD">Maximum outstanding balance amount per seller</span></span></td><td class="box_p-l-1x__RpeQN box_p-r-1x__PmqSN box_p-t-15x__Jahzv box_p-b-15x__1eVvO box_b-b-l-20__JXIoJ text_base__bZ6a4 text_paragraph-20__2lYBq table_left__1NzD_">Not applicable</td></tr></tbody></table></div></div><div data-markdown-heading="3" class="box_m-t-3x__rN_qC box_m-b-2x__nVJGZ"><a href="#compliance-limit-errors" id="compliance-limit-errors" aria-label="anchor link for compliance-limit-errors" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for compliance-limit-errors" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Compliance limit errors</h3></div></div><p>Square returns the following errors when compliance limits are exceeded:</p><ul><li><p>Maximum balance amount per gift card:</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:1ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"code"</span>: <span class="hljs-string">"BAD_REQUEST"</span>, <span data-line-number=""></span> <span class="hljs-attr">"detail"</span>: <span class="hljs-string">"Cannot load balance on this giftcard as the card maximum value has been reached"</span>, <span data-line-number=""></span> <span class="hljs-attr">"category"</span>: <span class="hljs-string">"INVALID_REQUEST_ERROR"</span> <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></li><li><p>Maximum load amount per gift card per day:</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:1ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"code"</span>: <span class="hljs-string">"PAYMENT_LIMIT_EXCEEDED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"detail"</span>: <span class="hljs-string">"The gift card limit for increasing balance reached."</span>, <span data-line-number=""></span> <span class="hljs-attr">"category"</span>: <span class="hljs-string">"PAYMENT_METHOD_ERROR"</span> <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></li><li><p>Maximum load amount per payment card per day:</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:1ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"code"</span>: <span class="hljs-string">"BAD_REQUEST"</span>, <span data-line-number=""></span> <span class="hljs-attr">"detail"</span>: <span class="hljs-string">"Load amount exceeds maximum buyer daily amount."</span>, <span data-line-number=""></span> <span class="hljs-attr">"category"</span>: <span class="hljs-string">"INVALID_REQUEST_ERROR"</span> <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></li><li><p>Maximum outstanding balance amount per seller:</p><div class="box_m-t-3x__rN_qC code-block_header__urOUF code-block_floating__ocyWk code-block_request__DDmE0 dark-mode-theme"><div></div><div class="box_m-r-1x__uw0iY box_m-t-5x__L06CC"><div class="code-block-action-button-group_button-group__QsOaL"><div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="copy-code-block" data-tracking-id="copy-code-block" slot="trigger" aria-label="Copy code" 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 icon-button_icon__Iew7h"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M11 6a1 1 0 1 0 0 2h5v6a1 1 0 1 0 2 0V8a2 2 0 0 0-2-2h-5ZM9 16v-5h4v5H9Zm-2-6a1 1 0 0 1 1-1h6a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H8a1 1 0 0 1-1-1v-7Z" fill="#7B61FF"></path></svg></button></div></div><div><div style="--tooltip-min-width:32px;--tooltip-min-height:36px" class="icon-button_dropdown__e8K_5"><button data-testid="expand-code-block" data-tracking-id="expand-code-block" slot="trigger" aria-label="Expand code" 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 icon-button_icon__Iew7h"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3H13V9H11V6.414L6.414 11H9V13H3V7H5V9.586L9.586 5H7V3Z" fill="#7B61FF"></path></svg></button></div></div></div></div></div><div data-testid="code-block" data-language="json" class="box_m-b-3x__A9ryy box_b-b-l-std__q5XI3 box_b-l-l-std__REGyC box_b-r-l-std__Q4dy4 box_b-r-6__eFn6m code-block_code-block__7vruq code-block_request__DDmE0 dark-mode-theme markdown-code-block_limit-height__WOJUw"><pre tabindex="-1" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 code-block_main__7BHb4"><div data-testid="code-block-contents" data-line-numbers-active="true" style="--line-number-length:1ch" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 code_code__4FNSr highlight_code-highlight___caZ6 highlight_json__n86A_ code_line-numbers___xHrc"><span data-line-number=""></span>{ <span data-line-number=""></span> <span class="hljs-attr">"code"</span>: <span class="hljs-string">"PAYMENT_LIMIT_EXCEEDED"</span>, <span data-line-number=""></span> <span class="hljs-attr">"detail"</span>: <span class="hljs-string">"The merchant cannot accrue any more liability."</span>, <span data-line-number=""></span> <span class="hljs-attr">"category"</span>: <span class="hljs-string">"PAYMENT_METHOD_ERROR"</span> <span data-line-number=""></span>}</div></pre><div class="markdown-code-block_bottom-bar___1uwP"><div class="markdown-code-block_bar-position__B59Cr markdown-code-block_footer-action__9cq8l"></div></div></div></li></ul><button data-tracking-id="markdown-accordion-clicked" aria-expanded="false" aria-controls=":R9ecpddl6:" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho focus-ring-styles_focus-ring__5P6v0 accordion_accordion__vbQko"><div data-markdown-heading="2"><a href="#migration-notes" id="migration-notes" aria-label="anchor link for migration-notes" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for migration-notes" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Migration notes</h2></div></div><svg width="20" height="20" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon_icon-color__dAdSt" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button><div role="region" id=":R9ecpddl6:" inert="true" class="accordion_container__Q6e6I"><div class="accordion_content__zl9fW"><p>The following migration notes apply to the Gift Cards API or Gift Card Activities API.</p><span class="markdown-anchor_container__0qZni"><a id="migrate-refund-replaces-unlinked-activity-refund" class="markdown-anchor_anchor__lBAV_"></a></span><div data-markdown-heading="3" class="box_m-t-3x__rN_qC box_m-b-2x__nVJGZ"><a href="#activity-type-is-changed-from-unlinked_activity_refund-to-refund-for-cross-tender-refunds-made-from-square-products" id="activity-type-is-changed-from-unlinked_activity_refund-to-refund-for-cross-tender-refunds-made-from-square-products" aria-label="anchor link for activity-type-is-changed-from-unlinked_activity_refund-to-refund-for-cross-tender-refunds-made-from-square-products" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for activity-type-is-changed-from-unlinked_activity_refund-to-refund-for-cross-tender-refunds-made-from-square-products" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h3 class="heading_base__MS64u heading_heading-20__RIpnh">Activity type is changed from UNLINKED_ACTIVITY_REFUND to REFUND for cross-tender refunds made from Square products</h3></div></div><p>Effective date: 2022-06-16</p><p>All cross-tender refunds made from Square Point of Sale or the Square Dashboard are now processed as <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activities instead of <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activities. This type of refund occurs when a gift card is refunded for a payment that was processed by Square and paid for using a credit card or different gift card. The resulting <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activity has a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">payment_id</code> but doesn't have a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">redeem_activity_id</code>.</p><p>Existing <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activities that represent cross-tender refunds made from Square Point of Sale or the Square Dashboard are now also returned as <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">REFUND</code> activities for a <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">ListGiftCardActivities</code> request. This change applies to all Square versions.</p><p>However, new and existing <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activities that are explicitly created by third-party applications continue to be returned as <code class="box_p-l-05x__pvvKi box_p-r-05x__PX6jO box_b-r-4__1LPp7 text_base__bZ6a4 text_paragraph-20__2lYBq text_code-field___GL_9 nodes_inline-code__HksNY">UNLINKED_ACTIVITY_REFUND</code> activities.</p></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#see-also" id="see-also" aria-label="anchor link for see-also" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for see-also" 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 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">See also</h2></div></div><ul><li><span slot="trigger"><a data-tracking-id="markdown-link" href="https://www.youtube.com/watch?v=2tUbxgkjjCo" class="nodes_markdown-link__1J6_a">Video: Sandbox 101: Gift Cards API</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards" class="nodes_markdown-link__1J6_a">Sample Application: Gift Card API Sample App</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="https://www.youtube.com/watch?v=epYIYs52Img" class="nodes_markdown-link__1J6_a">Video: Gift Card API Sample App Overview</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-cards-api" class="nodes_markdown-link__1J6_a">API Reference: Gift Cards API</a></span></li><li><span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/reference/square/gift-card-activities-api" class="nodes_markdown-link__1J6_a">API Reference: Gift Card Activities API</a></span></li></ul></article></div></div></div><div class="box_m-t-8x__7Ip7V grid-item_grid-item-small__Xb5VI page-layout_sidebar-floating-toc__oeaXi"><div data-testid="ftoc" class="sticky-container_container__FNSI1 floating-toc_docs-floating-toc__UfFM_"><h5 data-testid="docs-heading" class="heading_base__MS64u heading_heading-5__lcRR4">On this page</h5><div data-testid="ftoc-scroll" class="box_m-t-1x__GR9iT box_m-b-1x__b2HHn floating-toc_docs-scrollable-el__7yERK"><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Overview"}" href="/docs/gift-cards/using-gift-cards-api#overview" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Overview</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Requirements and limitations"}" href="/docs/gift-cards/using-gift-cards-api#requirements-and-limitations" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Requirements and limitations</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Gift Cards API"}" href="/docs/gift-cards/using-gift-cards-api#gift-cards-api" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Gift Cards API</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Gift Card Activities API"}" href="/docs/gift-cards/using-gift-cards-api#gift-card-activities-api" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Gift Card Activities API</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Integration with Square APIs"}" href="/docs/gift-cards/using-gift-cards-api#integration-with-square-apis" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Integration with Square APIs</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Custom GANs"}" href="/docs/gift-cards/using-gift-cards-api#custom-gans" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Custom GANs</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"QR code and barcode scanning"}" href="/docs/gift-cards/using-gift-cards-api#qr-code-and-barcode-scanning" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">QR code and barcode scanning</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Physical gift cards"}" href="/docs/gift-cards/using-gift-cards-api#physical-gift-cards" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Physical gift cards</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Third-party gift cards"}" href="/docs/gift-cards/using-gift-cards-api#third-party-gift-cards" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Third-party gift cards</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Sandbox testing"}" href="/docs/gift-cards/using-gift-cards-api#sandbox-testing" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Sandbox testing</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Compliance limits"}" href="/docs/gift-cards/using-gift-cards-api#compliance-limits" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Compliance limits</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"Migration notes"}" href="/docs/gift-cards/using-gift-cards-api#migration-notes" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">Migration notes</a><a data-tracking-id="floating-toc-item" data-tracking-extra="{"title":"See also"}" href="/docs/gift-cards/using-gift-cards-api#see-also" class="box_m-b-1x__b2HHn text_base__bZ6a4 text_paragraph-20__2lYBq text_color-20__myvq7 sidebar-link_sidebar-link__hvuMG sidebar-link_sidebar-container__NFtV_ floating-toc_docs-item__J_ik3">See also</a></div></div></div><div class="grid-item_grid-item-full__LsU8d"><div data-testid="docs-feedback-prompt" class="box_p-t-8x__SI6nV box_p-b-2x__bSkd6 box_b-t-l-10__Aa_Rv doc-feedback-prompt_container__E7_8O"><div class="box_m-b-2x__nVJGZ"><div class="feedback-widget_large__PmiLi"><div></div></div></div><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><p>If you need more assistance, contact <span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/help/contact?panel=BF53A9C8EF68" class="nodes_markdown-link__1J6_a">Developer and App Marketplace Support</a></span> or ask for help in the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/forums" class="nodes_markdown-link__1J6_a">Developer Forums</a></span>.</p></article></div></div></div><div class="grid_dex-grid-container__ZLJnB grid_dex-docs-content-grid-container__diyxN"><div class="box_m-t-10x__IyRMt box_m-b-10x__CM1Qo page-layout_footer__qY_8T"><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">漏 2025 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></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"data":{"getFlags":{"data":{"addons_page_devs_console":false,"api_explorer_in_explorer_ui":false,"api_explorer_input_retention":true,"api_explorer_migration_enabled":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":true,"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/fern_dotnet_examples":false,"devplat/fern_go_examples":true,"devplat/fern_java_examples":false,"devplat/fern_node_examples":true,"devplat/fern_php_examples":false,"devplat/fern_python_examples":false,"devplat/fern_ruby_examples":false,"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,"devplat/sandbox_seed_data_enabled":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_mpsdk_page":false,"devs_console_oauth_page":true,"devs_console_settings_pages":true,"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":true,"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":true,"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":true,"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/api_explorer_migration_enabled":true,"dpw/devs_console_mpsdk_page":false,"dpw/devs_console_webhook_subscriptions":false,"dpw/flagged_resubmission":false,"dpw/legacy_app_marketplace_partners":false,"explorer_to_logger_link":false,"fern_dotnet_examples":false,"fern_go_examples":true,"fern_java_examples":false,"fern_node_examples":true,"fern_php_examples":false,"fern_python_examples":false,"fern_ruby_examples":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":true,"remarkability_feb_2022":false,"remarkability_jul_2022":true,"sandbox_account_limit":"INT64_10","sandbox_seed_data_enabled":true,"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":{},"status":200,"statusText":"OK"}},"doc":{"pageInView":{"page":{"type":"doc-page","id":"2jw3ZL7uL4Miejdp2tnTV1","slug":"gift-cards/using-gift-cards-api","searchSummary":"Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards that help sellers increase sales and attract new customers.","heading":{"title":"Gift Cards API and Gift Card Activities API","browserTitle":"Gift Cards API and Gift Card Activities API","releaseStatus":"PUBLIC"},"languagesSupported":["All"],"platforms":["All"],"leftNavId":"4URmYFehLwquxQBCQKBKSx","content":[{"type":"markdown","name":"gift-cards-api : overview : intro, requirements and limitations","markdown":"**Applies to:** [Gift Cards API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-cards-api) | [Gift Card Activities API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-card-activities-api) | [Orders API](orders-api/what-it-does) | [Payments API](payments-refunds) | [Refunds API](refunds-api/overview) | [Customers API](customers-api/what-it-does) | [Web Payments SDK](web-payments/overview) | [In-App Payments SDK](in-app-payments-sdk/what-it-does) | [GraphQL](devtools/graphql)\n\n{% subheading %}Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards.{% /subheading %}\n\n{% toc hide=true /%}\n\n## Overview\n\n[Square gift cards](https://{{SQUARE_DOMAIN}}/gift-cards) allow sellers to offer a complete gifting program that can boost sales and attract new customers. Gift cards can be purchased online or in person and redeemed at all of the seller's locations. Buyers can send gift cards to friends and family to introduce them to a seller's business.\n\nDevelopers use the [Gift Cards API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-cards-api) and [Gift Card Activities API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-card-activities-api) to integrate gift cards into their applications. Watch the following video to see how the APIs work:\n\n{% youtube src=\"https://www.youtube.com/embed/2tUbxgkjjCo?si=B6AgXb08P2tdu9F3\" /%}\n\nYou can also send [Square GraphQL](devtools/graphql) queries for read-only access to gift card data and use [webhook events](gift-cards/webhooks) to keep track of activities.\n\n{% aside type=\"info\" %}\nSellers use [Square Point of Sale](https://{{SQUARE_DOMAIN}}/point-of-sale) and the [Square Dashboard](https://app.{{SQUARE_DOMAIN}}/dashboard/gift-cards) to sell, redeem, track, or reload Square gift cards. Sellers can publish an eGift Card Order Site where buyers can purchase gift cards.\n\nBuyers can view and manage their gift cards from their [Square profile](https://profile.squareup.com/).\n{% /aside %}\n\n## Requirements and limitations\n\nThe following requirements, limitations, and other considerations apply when working with the Gift Cards API and Gift Card Activities API:\n\n* **OAuth permissions** - Applications using OAuth require `GIFTCARDS_READ` for read operations and `GIFTCARDS_WRITE` for write operations.\n\n Additional permissions might be required in gift card flows. For example:\n * `CUSTOMERS_READ` - To get a customer ID to link a gift card.\n * `PAYMENTS_WRITE` - To [charge a gift card on file](gift-cards/manage-gift-cards-on-file#take-gift-card-on-file-payment).\n * `PAYMENTS_WRITE` and `ORDERS_WRITE` - To activate or reload gift cards using Orders API integration.\n\n Learn more about [OAuth](oauth-api/overview) and [endpoint permission requirements](oauth-api/square-permissions##gift-cards).\n\n* **Gift card delivery** - The developer is responsible for [delivering information for digital gift cards](gift-cards/sell-gift-cards#deliver-gift-cards) created using the Gift Cards API.\n\n* **Security of custom GANs** - The developer is responsible for ensuring the security of [custom GANs](#custom-gans). For example, to mitigate the risk of fraud, don't use repeatable patterns or GANs that are easy to guess (such as 12345678).\n\n* **No application fees** - Developers cannot collect application fees for gift card payments.`CreatePayment` returns a `BAD_REQUEST` error if the `app_fee_money` field is included in a request to create a Square gift card payment.\n\n{% anchor id=\"load-fees\" /%}\n* **Load fees** - Sellers in the following countries pay 2.5% of the amount added to a Square gift card, in addition to standard payment processing rates:\n * Australia\n * Canada\n * United States\n\n Load fees apply to `ACTIVATE`, `LOAD`, and `ADJUST_INCREMENT` activities. There are no fees when a gift card is redeemed or refunded. For more information, see [Gift cards pricing](payments-pricing#gift-cards-pricing).\n\n Square deducts or refunds load fees in seller payouts. To see all load fee deductions and refunds for a given payout, call [ListPayoutEntries](https://developer.{{SQUARE_DOMAIN}}/reference/square/payouts-api/list-payout-entries) and iterate through the results to find following entry types:\n\n * [GIFT_CARD_LOAD_FEE](payouts-api/list-payout-entries#gift_card_load_fee)\n * [GIFT_CARD_LOAD_FEE_REFUND](payouts-api/list-payout-entries#gift_card_load_fee_refund)\n * [UNDO_GIFT_CARD_LOAD_FEE_REFUND](payouts-api/list-payout-entries#undo_gift_card_load_fee_refund)\n\n* **Customer linking limits** - When saving [gift cards on file](gift-cards/manage-gift-cards-on-file): \n * The maximum number of gift cards you can link to a customer profile is 50.\n * The maximum number of customer profiles you can link to a gift card is 10.\n\n* **Square Dashboard reporting** - When third-party applications use [Orders API or Payments API integration](#integration-with-orders-api-and-payments-api) to reload or redeem a gift card, the Square Dashboard reports include these transactions. In contrast, there's no reporting when reloading and redeeming gift cards using non-Square APIs.\n\n All activated gift cards are listed in the Square Dashboard regardless of the system used to process the gift card order. However, if the gift card order was processed with non-Square APIs, the **Receipt** link to the transaction isn't available from the gift card's **Activity** card in the **Gift Cards** section.\n\n* **Square API integration** - Additional requirements and limitations apply when [integrating with other Square APIs](#integration-with-square-apis). \n\n* **Activity history** - `ACTIVATE`, `CLEAR_BALANCE`, and `IMPORT` activities that occurred before March 2, 2016, aren't included in `ListGiftCardActivities` results or when viewing the activity history in the Square Dashboard.\n\n{% anchor id=\"giftcard\" /%}\n## Gift Cards API\n\nYou can create gift cards, retrieve gift card information, and manage gift cards on file.\n\nThe following example `CreateGiftCard` request creates a `DIGITAL` gift card. You can also use this endpoint to register a `PHYSICAL` gift card.\n\n{% tabset %}\n{% tab id=\"CreateGiftCard request\" %}\n\n ```endpoint:GiftCards-CreateGiftCard\n {\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"bodyParameters\": {\n \"gift_card\": {\n \"type\": \"DIGITAL\"\n },\n \"location_id\": \"M8AKAD8160XGR\",\n \"idempotency_key\": \"a1do2d6c-28bc-3810-4se4d\"\n },\n \"environment\": \"sandbox\"\n }\n ```\n\n{% /tab %}\n{% tab id=\"GiftCard object in response\" %}\n\n```json copy_code\n{\n \"gift_card\": {\n \"id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"type\": \"DIGITAL\",\n \"gan_source\": \"SQUARE\",\n \"state\": \"PENDING\",\n \"balance_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"gan\": \"7783320002382646\",\n \"created_at\": \"2024-08-11T18:49:34Z\"\n }\n}\n``` \n\nGift cards are represented by a [GiftCard](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCard) object. The `gan` is the gift card number, also called the redemption code.\n\nGift cards can be [saved as gift cards on file](gift-cards/manage-gift-cards-on-file). The IDs of any linked customers are listed in the `customer_ids` field.\n\n```json copy_code\n{\n \"gift_card\": {\n \"id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"type\": \"DIGITAL\",\n \"gan_source\": \"SQUARE\",\n \"state\": \"PENDING\",\n \"balance_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"customer_ids\": [\n \"ASG67K1YGCSQQ47KSW7J7WX53M\", \n \"QNTC0TYTWMRSFFQ157KK4V7MVR\"\n ],\n \"gan\": \"7783320002382646\",\n \"created_at\": \"2024-08-11T18:49:34Z\"\n }\n}\n``` \n\n{% /tab %}\n{% /tabset %}\n\nNew gift cards have a `PENDING` state and zero balance. After creating a gift card, call `CreateGiftCardActivity` to activate it with an initial balance before first use. For steps, see [Sell Square Gift Cards](gift-cards/sell-gift-cards).\n\nThe `id` and `gan` fields are used in API requests. For example, use:\n* `gan` with the Web Payments SDK or In-App Payments SDK to generate a `source_id` for a gift card payment in a `CreatePayment` request.\n* `id` as the `source_id` for a gift card on file payment in a `CreatePayment` request.\n* `id` as the `destination_id` when issuing store credit in a `CreateRefund` request. This is an alternative method for activating a gift card.\n\n{% anchor id=\"giftcardactivity\" /%}\n{% anchor id=\"manage-balance-or-state\" /%}\n{% anchor id=\"managing-the-gift-card-balance-or-state\" /%}\n## Gift Card Activities API\nYou can activate a gift card with a balance, load additional funds, redeem the gift card for purchases, and create other activities that change the gift card balance or state.\n\nA `CreateGiftCardActivity` request defines a specific activity `type` and includes a corresponding `\u003cactivity-type\u003e_activity_details` field that provides the information needed to create the activity. The following example creates an `ACTIVATE` type based on the provided `activate_activity_details`:\n\n{% tabset %}\n{% tab id=\"CreateGiftCardActivity request\" %}\n\n```endpoint:GiftCardActivities-CreateGiftCardActivity\n{\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"bodyParameters\": {\n \"gift_card_activity\": {\n \"gift_card_gan\": \"7783320002382646\",\n \"type\": \"ACTIVATE\",\n \"activate_activity_details\": {\n \"order_id\": \"6x4a8NDWccmzlieCj6HBKxchfb4F\",\n \"line_item_uid\": \"fOHmeQJxmJp94DLdda2569\"\n },\n \"location_id\": \"M8AKAD8160XGR\"\n },\n \"idempotency_key\": \"dafa0d4f-c13b-44e2\"\n },\n \"environment\": \"sandbox\"\n}\n``` \n\n{% /tab %}\n{% tab id=\"GiftCardActivity object in response\" %}\n\n```json copy_code\n{\n \"gift_card_activity\": {\n \"id\": \"gcact_c24da663c0d242f5a29837d8e165bf97\",\n \"type\": \"ACTIVATE\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"created_at\": \"2024-08-11T19:01:14.000Z\",\n \"gift_card_id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"gift_card_gan\": \"7783320002382646\",\n \"gift_card_balance_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"activate_activity_details\": {\n \"amount_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"order_id\": \"q8vfn99RLTr7FuMaUtuDG6RHdCcZY\",\n \"line_item_uid\": \"syHOf0zv9OjS2vhkhFozVC\"\n }\n }\n}\n```\n\nGift card activities are represented by a [GiftCardActivity](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivity) object. In the previous example:\n\n* The `type` field indicates that this is an `ACTIVATE` activity.\n* The `activate_activity_details` field contains information related to the `ACTIVATE` activity. In this example, `amount_money` was obtained based on the provided order and line item IDs.\n* The `gift_card_balance_money` field shows the updated gift card balance resulting from the activity.\n{% line-break /%}\n\n{% /tab %}\n{% /tabset %}\n\n[Built-in integration](#integration-with-square-apis) with other Square APIs helps simplify activate, reload, redeem, and refund flows.\n\n{% anchor id=\"supported-activity-types\" /%}\n### Supported activity types for CreateGiftCardActivity\n\nGift card activities are used to manage a gift card's balance or state. You can use the `CreateGiftCardActivity` endpoint to create the following activity types:\n\n{% table %}\n* Activity type {% width=\"220px\" %}\n* Description\n---\n* `ACTIVATE`\n* Activates a gift card with a balance. A gift card must be in the `ACTIVE` state to be used for any other activity. For more information, see [Sell Square Gift Cards](gift-cards/sell-gift-cards).\n\n Details field: [activate_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityActivate)\n---\n* `LOAD`\n* Loads a gift card with additional funds. For more information, see [Reload Square Gift Cards](gift-cards/reload-gift-cards).\n\n Details field: [load_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityLoad)\n---\n* `REDEEM`\n* Redeems funds from a gift card after a gift card payment.\n\n If your application uses the Payments API to make a gift card payment, Square automatically creates a `REDEEM` activity that updates the gift card balance after the payment is completed. For more information, see [Redeem Square Gift Cards](gift-cards/redeem-gift-cards).\n\n Details field: [redeem_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityRedeem)\n---\n* `CLEAR_BALANCE`\n* Sets a gift card balance to zero. This activity should be called before reusing a physical gift card.\n\n When a physical gift card reaches a zero balance for any reason, Square automatically unlinks all customers from the gift card. This behavior helps keep the linked customer profile setting up to date if the card is reused.\n\n Details field: [clear_balance_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityClearBalance)\n---\n* `DEACTIVATE`\n* Permanently blocks a gift card from any future balance-changing activities. This activity should be called to prevent a gift card from being used (for example, before discarding a physical gift card or if the card is lost or stolen).\n\n Details field: [deactivate_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityDeactivate)\n---\n* `ADJUST_INCREMENT`\n* Increases a gift card balance when the adjustment isn't related to a gift card order or payment. To increase the balance based on gift card orders or payments, use the appropriate `LOAD`, `REFUND`, or `UNLINKED_ACTIVITY_REFUND` activity.\n\n Details field: [adjust_increment_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityAdjustIncrement)\n---\n* `ADJUST_DECREMENT`\n* Decreases a gift card balance when the adjustment isn't related to a gift card payment. To decrease the balance based on a gift card payment, use the `REDEEM` activity.\n\n Details field: [adjust_decrement_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityAdjustDecrement)\n---\n* `REFUND`\n* Adds money to a gift card from a refunded transaction. Refunds linked to a Square payment have a `payment_id`. Refunds to the same gift card used to make the payment have a `redeem_activity_id`.\n\n If your application uses the Refunds API to refund a payment to a gift card, Square automatically creates a `REFUND` activity that updates the gift card balance. Applications that use a custom processing system for {% tooltip text=\"same-method gift card refunds\" %}Refunds a payment to the same gift card used to make the payment.{% /tooltip %} must explicitly create a `REFUND` activity and specify the `redeem_activity_id`.\n\n Details field: [refund_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityRefund)\n---\n* `UNLINKED_ACTIVITY_REFUND`\n* Adds money to a gift card from a refunded transaction that wasn't paid with the same gift card.\n\n This activity type is used by applications that use a custom processing system for {% tooltip text=\"cross-method gift card refunds\" %}Refunds a payment to a gift card that wasn't used to make the payment.{% /tooltip %}.\n\n Details field: [unlinked_activity_refund_activity_details](https://developer.{{SQUARE_DOMAIN}}/reference/square/objects/GiftCardActivityUnlinkedActivityRefund)\n{% /table%}\n\n{% anchor id=\"unsupported-activities\" /%}\n{% accordion expanded=false %} \n{% slot \"heading\" %}\n#### Unsupported activity types\n{% /slot %}\n\nYou cannot use `CreateGiftCardActivities` to create the following activity types:\n\n* `BLOCK` or `UNBLOCK` - Square manages these activities while processing chargeback transactions for disputed payments.\n* `IMPORT` or `IMPORT_REVERSAL` - Sellers must work with Square Support to import [third-party gift cards](#third-party-gift-cards) or reverse previously imported gift cards.\n* `TRANSFER_BALANCE_TO` or `TRANSFER_BALANCE_FROM` - Square creates these activities when a buyer transfers money between gift cards linked to their [Square profile](https://profile.squareup.com).\n\nHowever, these activity types are included in `ListGiftCardActivities` results and invoke `gift_card.activity.created` and `gift_card.updated` [webhook events](gift-cards/webhooks).\n\n{% /accordion %}\n\n{% aside type=\"info\" %}\nYou can call `ListGiftCardActivities` to view all activities or a filtered set of activities. The response includes gift card activities initiated by sellers and buyers using Square products, third-party applications calling Square APIs, and Square. For more information, see [List gift card activities](gift-cards/retrieve-gift-cards-and-activities#list-gift-card-activities).\n{% /aside %}\n\n{% anchor id=\"integration-with-orders-api-and-payments-api\" /%}\n{% anchor id=\"integration-with-square-apis\" /%}\n## Integration with Square APIs\n\nSquare provides integrated gift card workflows for applications that use the [Orders API](https://developer.{{SQUARE_DOMAIN}}/reference/square/orders-api), [Payments API](https://developer.{{SQUARE_DOMAIN}}/reference/square/payments-api), or [Refunds API](https://developer.{{SQUARE_DOMAIN}}/reference/square/refund-api).\n\n{% anchor id=\"orders-api-integration\" /%}\n{% accordion expanded=false %} \n{% slot \"heading\" %}\n### Orders API integration with ACTIVATE and LOAD activities\n{% /slot %}\n\nWith Orders API integration, Square reads information from the order used to sell or reload a gift card. You provide an `order_id` and `line_item_uid` (of the `GIFT_CARD` line item) when you create the `ACTIVATE` or `LOAD` activity. The following are typical high-level flows:\n\n* **Selling a gift card** - Includes creating an `ACTIVATE` activity:\n\n `CreateOrder` -\u003e `CreatePayment` -\u003e `CreateGiftCard` -\u003e `CreateGiftCardActivity`\n\n* **Reloading a gift card** - Includes creating a `LOAD` activity:\n\n `CreateOrder` -\u003e `CreatePayment` -\u003e `CreateGiftCardActivity`\n\nResulting `ACTIVATE` and `LOAD` activities include the `order_id` and `line_item_uid` you provided in the `CreateGiftCardActivity` request, as shown in the following examples. The amount of the `GIFT_CARD` line item is added to the gift card balance.\n\n{% tabset %}\n{% tab id=\"ACTIVATE activity\" %}\n\n```json copy_code\n{\n \"gift_card_activity\": {\n \"id\": \"gcact_c24da663c0d242f5a29837d8e165bf97\",\n \"type\": \"ACTIVATE\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"created_at\": \"2024-08-11T19:01:14.000Z\",\n \"gift_card_id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"gift_card_gan\": \"7783320002382646\",\n \"gift_card_balance_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"activate_activity_details\": {\n \"amount_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"order_id\": \"q8vfn99RLTr7FuMaUtuDG6RHdCcZY\",\n \"line_item_uid\": \"syHOf0zv9OjS2vhkhFozVC\"\n }\n }\n}\n```\n\n{% /tab %}\n{% tab id=\"LOAD activity\" %}\n\n```json copy_code\n{\n \"gift_card_activity\": {\n \"id\": \"gcact_31ce61ffa4df4d42bf250d8a21d844c2\",\n \"type\": \"LOAD\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"created_at\": \"2024-08-15T10:21:47.000Z\",\n \"gift_card_id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"gift_card_gan\": \"7783320002382646\",\n \"gift_card_balance_money\": {\n \"amount\": 3883,\n \"currency\": \"USD\"\n },\n \"load_activity_details\": {\n \"amount_money\": {\n \"amount\": 3000,\n \"currency\": \"USD\"\n },\n \"order_id\": \"YcErdVPXmBSmn84OjBqnoS5hrb4F\",\n \"line_item_uid\": \"YKGb57Cj7Oxzv02PrenjkC\"\n }\n }\n}\n```\n\n{% /tab %}\n{% /tabset %}\n\nFor more information, see [Sell Square Gift Cards](gift-cards/sell-gift-cards) and [Reload Square Gift Cards](gift-cards/reload-gift-cards).\n\n#### Requirements and limitations for Orders API integration\n\n * `order_id` - The specified order must be in the `COMPLETED` state before you can activate or load the gift card.\n\n * `line_item_uid` - The specified line item with the gift card amount must explicitly set `GIFT_CARD` as the `item_type`. Otherwise, the order isn't processed as a gift card sale and you cannot use Orders API integration to activate or load the gift card.\n\n* If a gift card order is later refunded, the Refunds API doesn't automatically update the gift card balance. To deduct the funds from the balance, call `CreateGiftCardActivity` and create an `ADJUST_DECREMENT` activity with the `PURCHASE_WAS_REFUNDED` reason. Note that the Refunds API does update the balance after refunding a payment to a gift card.\n\n{% accordion expanded=false %}\n{% slot \"heading\" %}\n#### Custom order processing (non-Square APIs)\n{% /slot %}\n\nIf your application doesn't use the Orders API to process orders, you must call `CreateGiftCardActivity` to create the `ACTIVATE` or `LOAD` activity. Provide the following activity details in the request:\n* `amount_money`\n* `buyer_payment_instrument_ids`\n* `reference_id` (optional)\n\n{% /accordion %}\n{% /accordion %}\n\n{% anchor id=\"payments-api-integration\" /%}\n{% accordion expanded=false %} \n{% slot \"heading\" %}\n### Payments API integration with REDEEM activities\n{% /slot %}\n\nWith Payments API integration, Square automatically creates a `REDEEM` activity that updates the gift card balance after the payment is processed. Your application doesn't need to call `CreateGiftCardActivity`.\n\nResulting `REDEEM` activities have a `payment_id`, as shown in the following example. The payment amount is deducted from the gift card balance.\n\n```json\n{\n \"gift_card_activity\": {\n \"id\": \"gcact_d31b4200f5174fc48cb7138aeae197d0\",\n \"type\": \"REDEEM\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"created_at\": \"2024-08-15T15:57:43.000Z\",\n \"gift_card_id\": \"gftc:065fd3c6e1014c9293bd2d09475ea189\",\n \"gift_card_gan\": \"7783320009623257\",\n \"gift_card_balance_money\": {\n \"amount\": 7450,\n \"currency\": \"USD\"\n },\n \"redeem_activity_details\": {\n \"amount_money\": {\n \"amount\": 2550,\n \"currency\": \"USD\"\n },\n \"payment_id\": \"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY\",\n \"status\": \"COMPLETED\"\n }\n }\n}\n```\n\nFor more information, see [Redeem Square Gift Cards](gift-cards/redeem-gift-cards).\n\n#### Gift card details in a Payment object\n\nFor gift card payments, the `card_brand` field is `SQUARE_GIFT_CARD`. Note that Square supports [partial payment flows](payments-api/take-payments/card-payments/partial-payments-with-gift-cards) using gift cards.\n\n```json\n{\n \"payment\": {\n \"id\": \"JaHoTpbmK8dofR9cUheOJl9dQVcZY\",\n \"created_at\": \"2024-07-25T17:24:30.345Z\",\n \"updated_at\": \"2024-07-25T17:24:30.444Z\",\n \"amount_money\": {\n \"amount\": 522,\n \"currency\": \"USD\"\n },\n \"status\": \"COMPLETED\",\n \"delay_duration\": \"PT168H\",\n \"source_type\": \"CARD\",\n \"card_details\": {\n \"status\": \"CAPTURED\",\n \"card\": {\n \"card_brand\": \"SQUARE_GIFT_CARD\",\n \"last_4\": \"1923\",\n \"exp_month\": 12,\n \"exp_year\": 2050,\n \"fingerprint\": \"sq-1-y_yFcziMlsxVSomRNQZ7xBaW0F1xxE-6TbcGKl7KOoy3GI1mh094CY4_Ox5RzUN7Vg\",\n \"card_type\": \"DEBIT\",\n \"prepaid_type\": \"PREPAID\",\n \"bin\": \"778332\"\n },\n \"entry_method\": \"KEYED\",\n \"auth_result_code\": \"0\",\n \"card_payment_timeline\": {\n \"authorized_at\": \"2024-07-25T17:24:30.381Z\",\n \"captured_at\": \"2024-07-25T17:24:30.444Z\"\n }\n },\n \"location_id\": \"M8AKAD8160XGR\",\n \"order_id\": \"sYr0y9eUZBoXd2dmXhjvDGOW0e4F\",\n \"total_money\": {\n \"amount\": 522,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 522,\n \"currency\": \"USD\"\n },\n \"receipt_url\": \"https://squareupsandbox.com/receipt/preview/JaHoTpbmK8dofR9cUheOJl9dQVcZY\",\n \"delay_action\": \"CANCEL\",\n \"delayed_until\": \"2024-08-01T17:24:30.345Z\",\n \"application_details\": {\n \"square_product\": \"ECOMMERCE_API\",\n \"application_id\": \"sandbox-sq0idb-ioiyW39PwreFzwXoGyLtYg\"\n },\n \"version_token\": \"4WWgYqa7KXd6rIW82VkYxKF36EYkNyx4MGrq0Vxf5cm6o\"\n }\n}\n```\n\n{% accordion expanded=false %}\n{% slot \"heading\" %}\n#### Custom payment processing (non-Square APIs)\n{% /slot %}\n\nIf your application doesn't use the Payments API to process payments, you must call `CreateGiftCardActivity` to create the `REDEEM` activity. Provide the following activity details in the request:\n* `amount_money`\n* `reference_id` (optional)\n\n{% /accordion %}\n{% /accordion %}\n\n{% anchor id=\"refunds-api-integration\" /%}\n{% accordion expanded=false %} \n{% slot \"heading\" %}\n### Refunds API integration with REFUND activities\n{% /slot %}\n\nWith Refunds API integration, you can process {% tooltip text=\"same-method gift card refunds\" %}Refunds a payment to the same gift card used to make the payment.{% /tooltip %} and {% tooltip text=\"cross-method gift card refunds\" %}Refunds a payment to a gift card that wasn't used to make the payment.{% /tooltip %}. Square automatically creates a `REFUND` activity that updates the gift card balance after the refund is processed. Your application doesn't need to call `CreateGiftCardActivity`.\n\n {% aside type=\"info\" %}\n You can issue a cross-method refund to a new gift card by first calling `CreateGiftCard` to create the gift card and then refunding directly to the new gift card. Doing so automatically changes the state from `PENDING` to `ACTIVE`.\n {% /aside %}\n\nResulting `REFUND` activities include a `payment_id` if the refund is linked to a payment processed by Square and a `redeem_activity_id` if the payment was redeemed from the same gift card. The refund amount is added to the gift card balance.\n\n```json\n{\n \"gift_card_activity\": {\n \"id\": \"gcact_5a877a9e75d840e990aae654173ed655\",\n \"type\": \"REFUND\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"created_at\": \"2024-08-15T15:59:45.000Z\",\n \"gift_card_id\": \"gftc:065fd3c6e1014c9293bd2d09475ea189\",\n \"gift_card_gan\": \"7783320009623257\",\n \"gift_card_balance_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"refund_activity_details\": {\n \"redeem_activity_id\": \"gcact_d31b4200f5174fc48cb7138aeae197d0\",\n \"amount_money\": {\n \"amount\": 2550,\n \"currency\": \"USD\"\n },\n \"payment_id\": \"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY\"\n }\n }\n}\n```\n\n#### Gift card details in a Refund object\n\nThe refund flow determines whether gift card details are included in the refund. For gift card transactions, the `card_details.card.card_brand` field is set to `SQUARE_GIFT_CARD`.\n\n{% tabset %}\n{% tab id=\"Same-method gift card refund\" %}\n\nGift card details aren't included in a same-method refund. To get details about the gift card that made the payment and received the refund, call `GetPayment` using the `payment_id` from the refund and check the `card_details` field.\n\n```json\n{\n \"refund\": {\n \"id\": \"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY_JnAde8lQt5pt9MLAMZ4UgaXt0sN3ZGqr62Ohx23tGGH\",\n \"status\": \"COMPLETED\",\n \"amount_money\": {\n \"amount\": 1500,\n \"currency\": \"USD\"\n },\n \"payment_id\": \"9WIIrJKZXMgSF9dI7SX9pOlWy7DZY\",\n \"order_id\": \"kayuaH6E5v63RuuaXLSyJa8Qrc4F\",\n \"created_at\": \"2024-08-15T15:59:30.564Z\",\n \"updated_at\": \"2024-08-15T15:59:45.590Z\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"destination_type\": \"CARD\"\n }\n}\n```\n\n{% /tab %}\n{% tab id=\"Cross-method gift card refund\" %}\n\nCross-method refunds to gift cards include a `destination_details` field that provides gift card details.\n\n```json\n{\n \"refund\": {\n \"id\": \"j3ra9pWVGwJjvSUEPtZwnmxquaB_GqWV0VwrM5gKVEfiGs35S\",\n \"status\": \"COMPLETED\",\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"payment_id\": \"j3ra9pWVGwJjvSUEPtZwnmxquaB\",\n \"order_id\": \"EERJy2F14ljdo9ESBL7nGzMF\",\n \"created_at\": \"2024-08-12T19:13:10.072Z\",\n \"updated_at\": \"2024-08-12T19:13:12.466Z\",\n \"location_id\": \"M8AKAD8160XGR\",\n \"destination_type\": \"CARD\",\n \"destination_details\": {\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"SQUARE_GIFT_CARD\",\n \"last_4\": \"2281\",\n \"exp_month\": 12,\n \"exp_year\": 2026,\n \"fingerprint\": \"sq-1-fingerprint-id\",\n \"card_type\": \"DEBIT\",\n \"prepaid_type\": \"PREPAID\",\n \"bin\": \"778332\",\n },\n \"entry_method\": \"KEYED\"\n }\n }\n }\n}\n```\n\n{% /tab %}\n{% /tabset %}\n\nRefunds to the `SQUARE_GIFT_CARD` card brand don't affect a seller's payment processing balance. Note that a refund might take up to 14 days to complete. For more information about refund flows, see [Refund Payments](payments-api/refund-payments).\n\n#### Requirements and limitations for Refunds API integration\n\n* Square API version 2024-08-21 or later is required for the following features related to cross-method refunds:\n * Using `RefundPayment` to create cross-method gift card refunds.\n * Using `GetRefund` or `ListRefunds` to retrieve cross-method gift card refunds. When using earlier Square API versions, `GetRefund` returns an `API_VERSION_INCOMPATIBLE` error and `ListRefunds` omits cross-method gift card refunds from the results.\n * Using `GetPayment` or `ListPayments` to get `refunded_money` or `refund_ids` details related to the refund. When using earlier Square API versions, this information is omitted from the returned payments. Therefore, the payment IDs in corresponding `REFUND` activity details aren't useful for tracking refund activity.\n* Refunding to a new gift card activates the card by changing the `PENDING` state to `ACTIVE` and adding an initial balance equal to the refund amount. This process creates a `REFUND` activity but doesn't create an `ACTIVATE` activity.\n* Gift cards with custom GANs cannot receive cross-method refunds using the Refunds API.\n\n{% accordion expanded=false %}\n{% slot \"heading\" %}\n#### Custom refund processing (non-Square APIs)\n{% /slot %}\n\nIf your application doesn't use the Refunds API to process refunds, you must call `CreateGiftCardActivity` to create the `REFUND` or `UNLINKED_ACTIVITY_REFUND` activity.\n* For {% tooltip text=\"same-method gift card refunds\" %}Refunds a payment to the same gift card used to make the payment.{% /tooltip %} - Create a `REFUND` activity and provide the following activity details in the request:\n * `amount_money`\n * `redeem_activity_id`\n * `reference_id` (optional)\n* For {% tooltip text=\"cross-method gift card refunds\" %}Refunds a payment to a gift card that wasn't used to make the payment.{% /tooltip %} - Create an `UNLINKED_ACTIVITY_REFUND` activity and provide the following activity details in the request:\n * `amount_money`\n * `reference_id` (optional)\n\n`REFUND` and `UNLINKED_ACTIVITY_REFUND` activities created by custom processing systems don't have a `payment_id` because they aren't linked to a Square payment.\n\n{% /accordion %}\n{% /accordion %}\n","programmingLanguage":"All","platform":"All"},{"type":"markdown","name":"gift-cards-api : overview : custom gans, physical gift cards, 3p gift cards. sandbox testing","markdown":"{% anchor id=\"custom-gans\" /%}\n## Custom GANs\n\nThe `CreateGiftCard` endpoint allows you to specify a custom GAN when you create a gift card. The custom GAN that you provide in the request must meet the following requirements:\n\n* The custom GAN must be unique for the Square seller account. \n* The custom GAN must contain 8 to 20 alphanumeric characters. Note that only numeric characters can be used if you want to generate [QR codes or barcodes](#scanning).\n* The custom GAN cannot start with:\n * A bank identification number (BIN) pattern used by major credit cards (such as Visa, Mastercard, and American Express).\n * A BIN used by Square gift cards: 778273 (physical) or 778332 (digital).\n\nGift cards created with a custom GAN have a `gan_source` of `OTHER`.\n\n{% aside type=\"info\" %}\nFor an example `CreateGiftCard` request that creates a gift card with a custom GAN, see [Create or register the gift card](gift-cards/sell-gift-cards#create-gift-card).\n{% /aside %}\n\nCustom GANs can enable scenarios that aren't possible with Square-assigned GANs. For example, they can be used for gift card redemptions across multiple Square sellers and channels, to attach a value to non-gift-card items such as tickets, and to allow sellers to accept gift cards created by external sites. Gift cards with custom GANs can be redeemed just like gift cards with Square-assigned GANs.\n\nBuyers use GANs to make gift card payments and check the gift card balance. It's the responsibility of the developer to ensure the security of their custom GANs. For example, to mitigate the risk of fraud, avoid using repeatable patterns or GANs that are easy to guess (such as 12345678).\n\nYou should be aware of the following limitation for gift cards with custom GANs:\n\n* After using the `LinkCustomerToGiftCard` endpoint to add a gift card on file for a customer profile, the customer ID is added to the `customer_ids` field of the `gift_card` object. However, linked gift cards that have custom GANs aren't currently visible as a card on file for the customer in Square products, such as Square Point of Sale or the Square Dashboard.\n\n{% anchor id=\"scanning\" /%}\n## QR code and barcode scanning\n\nAlthough Square APIs don't provide native code-generation support, you can use a third-party solution to generate a QR code or barcode for digital gift cards. For example, the [Gift Card API Sample App](https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards/public/js/generate-barcode.js) uses a JavaScript library to generate barcodes.\n\nWhen generating a QR code or barcode, the encoded message must include the gift card number (GAN) in the following format:\n\n\u003e`sqgc://\u003cGIFT_CARD_NUMBER\u003e` (for example: `sqgc://82000571903`)\n\n* Gift cards with a Square-assigned GAN have the `gan_source` field set to `SQUARE`. These gift cards can be scanned in Square Point of Sale.\n\n* Gift cards with a [custom GAN](#custom-gans) have the `gan_source` field set to `OTHER`. To support scanning with the `sqgc://` prefix, the GAN must:\n * Not start with a BIN used by major credit cards.\n * Not start with a BIN used by Square gift cards: 778273 (physical) or 778332 (digital).\n * Contain numeric characters only.\n * Pass the [Luhn algorithm check](https://en.wikipedia.org/wiki/Luhn_algorithm).\n\nNote that physical (plastic) Square gift cards are imprinted with a QR code and barcode.\n\n## Physical gift cards\nNote the following when working with physical (plastic) gift cards:\n\n\n * Physical gift cards are imprinted with a 16-digit GAN and a barcode. The GAN is numeric only and starts with 778273. The GAN is stored in the `gan` field of the `GiftCard` object.\n\n * To sell physical gift cards, the seller must have previously ordered the gift card from Square and the gift card must be unused. Sellers can [order a pack of Square gift cards](https://{{SQUARE_DOMAIN}}/help/us/en/article/5393-order-your-square-gift-cards) in the Square Dashboard.\n\n * Testing physical gift cards in the Square Sandbox isn't supported. \n\n * When a physical gift card reaches a zero balance for any reason, Square automatically unlinks all customers from the gift card. This behavior helps keep the linked customer profiles setting current if the card is reused.\n\n{% anchor id=\"third-party-gift-cards\" /%}\n## Third-party gift cards\n\nIf a seller previously purchased gift cards from another gift card provider (not from Square) and sold them to customers, the seller must follow a one-time process with Square Support to import these third-party gift cards into Square. The seller can then accept these gift cards for redemption like Square gift cards. Third-party gift cards cannot be reloaded. \n\nFor third-party gift cards, the `gan` field can contain a maximum of 255 characters and `gan_source` is `OTHER`.\n\n{% aside type=\"info\" %}\nIf you attempt to migrate third-party gift cards by creating digital Square gift cards programmatically, you might receive compliance limit or rate limit errors. For more information, [contact Developer Support](https://{{SQUARE_DOMAIN}}/help/contact?panel=BF53A9C8EF68).\n{% /aside %}\n\n## Sandbox testing\nYou can create and manage Square gift cards in the [Square Sandbox](devtools/sandbox/overview). In addition, Square provides a test value that you can use to test gift card payments. For more information, see [Testing gift card payments in the Sandbox](gift-cards/redeem-gift-cards#sandbox-gift-card-payments).\n\nThe following limitations apply to testing gift card payments in the Sandbox:\n* Creating, managing, and testing with physical gift cards isn't supported.\n* The Virtual Terminal doesn't accept gift card payments.\n* The Web Payments SDK and In-App Payments SDK only accept Sandbox test values provided by Square. These values aren't tied to any gift cards in your account, so you cannot check whether the balance of the gift card is updated.","programmingLanguage":"All","platform":"All"},{"type":"markdown","name":"gift-cards-api : overview : compliance limits, migration notes, related topics","markdown":"{% anchor id=\"compliance-limits\" /%}\n## Compliance limits\n\nSquare enforces the following compliance limits for gift card activities that load funds onto digital or physical gift cards: \n\n* **Maximum balance amount per gift card** - The maximum amount for a gift card balance.\n* **Maximum load amount per gift card per day** - The maximum amount that can be loaded onto a gift card in a 24-hour period. \n* **Maximum load amount per payment card per day** - The maximum amount that a single payment card can load onto gift cards in a 24-hour period. \n* **Maximum outstanding balance amount per seller** - The maximum amount of the total outstanding balance across all gift cards issued for a single seller.\n\nIf a limit is exceeded, the `CreateGiftCardActivity` endpoint [returns an error](#compliance-limit-errors) and doesn't complete the activity.\n\n### Per-country compliance limits\n\nThe following tables contain the per-country limits that are enforced by Square:\n\n|Limits for Australia (AU){% width=\"350px\" %}|Amount in AUD| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|$2,000|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|$2,000| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|$10,000| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable|\n\n|Limits for Canada (CA){% width=\"350px\" %}|Amount in CAD| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|$2,000| \n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|$2,000| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|$10,000| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable|\n\n|Limits for France (FR) and Ireland (IR) {% width=\"350px\" %}|Amount in EUR| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|750 EUR|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|750 EUR| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|7.500 EUR / 7,500 EUR| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable|\n\n|Limits for Japan (JP){% width=\"350px\" %}|Amount in YEN| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|\u0026#165;50,000|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|\u0026#165;50,000| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|\u0026#165;1,000,000| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|\u0026#165;10,000,000| \n\n|Limits for Spain (ES){% width=\"350px\" %}|Amount in EUR| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|250 EUR (card cannot be reloaded)|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|250 EUR (card cannot be reloaded)| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|7,500 EUR| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable|\n\n|Limits for the United Kingdom (UK){% width=\"350px\" %}|Amount in GBP| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|\u0026#xA3;750|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|\u0026#xA3;750| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|\u0026#xA3;7,500| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable| \n\n|Limits for the United States (US){% width=\"350px\" %}|Amount in USD| \n|------|------| \n|{% tooltip text=\"Maximum balance amount per gift card\" %}The maximum amount for a gift card balance.{% /tooltip %}|$2,000|\n|{% tooltip text=\"Maximum load amount per gift card per day\" %}The maximum amount that can be loaded onto a gift card in a 24-hour period.{% /tooltip %}|$2,000| \n|{% tooltip text=\"Maximum load amount per payment card per day\" %}The maximum amount that a single payment card can load onto gift cards in a 24-hour period.{% /tooltip %}|$10,000| \n|{% tooltip text=\"Maximum outstanding balance amount per seller\" %}The maximum amount of total outstanding balance across all gift cards issued for a single seller.{% /tooltip %}|Not applicable|\n\n### Compliance limit errors\n\nSquare returns the following errors when compliance limits are exceeded:\n\n* Maximum balance amount per gift card: \n\n ```json copy_code\n {\n \"code\": \"BAD_REQUEST\",\n \"detail\": \"Cannot load balance on this giftcard as the card maximum value has been reached\",\n \"category\": \"INVALID_REQUEST_ERROR\"\n }\n ```\n\n* Maximum load amount per gift card per day: \n\n ```json copy_code\n {\n \"code\": \"PAYMENT_LIMIT_EXCEEDED\",\n \"detail\": \"The gift card limit for increasing balance reached.\",\n \"category\": \"PAYMENT_METHOD_ERROR\"\n }\n ```\n\n* Maximum load amount per payment card per day: \n\n ```json copy_code\n {\n \"code\": \"BAD_REQUEST\",\n \"detail\": \"Load amount exceeds maximum buyer daily amount.\",\n \"category\": \"INVALID_REQUEST_ERROR\"\n }\n ```\n\n* Maximum outstanding balance amount per seller: \n\n ```json copy_code\n {\n \"code\": \"PAYMENT_LIMIT_EXCEEDED\",\n \"detail\": \"The merchant cannot accrue any more liability.\",\n \"category\": \"PAYMENT_METHOD_ERROR\"\n }\n ```\n\n{% accordion expanded=false %} \n{% slot \"heading\" %}\n## Migration notes\n{% /slot %}\n\nThe following migration notes apply to the Gift Cards API or Gift Card Activities API.\n\n{% anchor id=\"migrate-refund-replaces-unlinked-activity-refund\" /%}\n### Activity type is changed from UNLINKED_ACTIVITY_REFUND to REFUND for cross-tender refunds made from Square products\n\nEffective date: 2022-06-16\n\nAll cross-tender refunds made from Square Point of Sale or the Square Dashboard are now processed as `REFUND` activities instead of `UNLINKED_ACTIVITY_REFUND` activities. This type of refund occurs when a gift card is refunded for a payment that was processed by Square and paid for using a credit card or different gift card. The resulting `REFUND` activity has a `payment_id` but doesn't have a `redeem_activity_id`.\n\nExisting `UNLINKED_ACTIVITY_REFUND` activities that represent cross-tender refunds made from Square Point of Sale or the Square Dashboard are now also returned as `REFUND` activities for a `ListGiftCardActivities` request. This change applies to all Square versions.\n\nHowever, new and existing `UNLINKED_ACTIVITY_REFUND` activities that are explicitly created by third-party applications continue to be returned as `UNLINKED_ACTIVITY_REFUND` activities.\n\n{% /accordion %}\n\n## See also\n\n* [Video: Sandbox 101: Gift Cards API](https://www.youtube.com/watch?v=2tUbxgkjjCo)\n* [Sample Application: Gift Card API Sample App](https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards)\n* [Video: Gift Card API Sample App Overview](https://www.youtube.com/watch?v=epYIYs52Img)\n* [API Reference: Gift Cards API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-cards-api)\n* [API Reference: Gift Card Activities API](https://developer.{{SQUARE_DOMAIN}}/reference/square/gift-card-activities-api)","programmingLanguage":"All","platform":"All"}]},"requirementsDomain":null},"navSet":{"value":{"items":[{"type":"link","url":"/","title":"Docs Home"},{"type":"divider","style":"divider"},{"id":"iO7IcPwigJctqIkoJ11Zo","type":"subcategory","items":[{"id":"7dlzvOUwboNqjIqujGxzcq","type":"subcategory","items":[{"type":"link","url":"/get-started/create-account-and-application","title":"Create an Account and App"},{"type":"link","url":"/get-started/make-api-request","title":"Make your First API Call"},{"type":"link","url":"/get-started/view-log","title":"View the API Logs"},{"type":"link","url":"/get-started/verify-transaction-in-seller-dashboard","title":"Verify the Payment"},{"type":"link","url":"/get-started/what-next","title":"What's Next"}],"title":"Get Started","url":"/square-get-started"},{"type":"divider","style":"divider"},{"type":"link","url":"/development-essentials","title":"Overview"},{"id":"2bnJ76IVdWdlJkBxvg7SmH","type":"subcategory","items":[{"type":"link","url":"/build-basics/versioning-overview","title":"Versioning"},{"type":"link","url":"/build-basics/access-tokens","title":"Access Tokens"},{"type":"link","url":"/build-basics/frontend-backend-development","title":"Frontend and Backend Development"},{"id":"4TMGdBKMRZhCtNaE99difL","type":"subcategory","items":[{"type":"link","url":"/build-basics/general-considerations/tls-and-https","title":"TLS and HTTPS"},{"type":"link","url":"/build-basics/general-considerations/using-rest-api","title":"Using the REST API"},{"type":"link","url":"/build-basics/general-considerations/handling-errors","title":"Handling Errors"},{"type":"link","url":"/build-basics/general-considerations/collecting-information","title":"Collecting Information"},{"type":"link","url":"/build-basics/general-considerations/language-preferences","title":"Language Preferences"}],"title":"General Development Concepts","url":"/build-basics/general-considerations"},{"id":"3aMdMffYnkZVVVgdISQxCp","type":"subcategory","items":[{"type":"link","url":"/build-basics/common-data-types/working-with-dates","title":"Working with Dates"},{"type":"link","url":"/build-basics/common-data-types/working-with-monetary-amounts","title":" Working with Monetary Amounts"},{"type":"link","url":"/build-basics/common-data-types/working-with-addresses","title":"Working with Addresses"}],"title":"Common Data Types","url":"/build-basics/common-data-types"},{"id":"3RImgYl86M2FgJQKHeKyoX","type":"subcategory","items":[{"type":"link","url":"/devtools/customattributes/overview","title":"Custom Attributes"},{"type":"link","url":"/build-basics/common-api-patterns/idempotency","title":"Idempotency"},{"type":"link","url":"/build-basics/common-api-patterns/pagination","title":"Pagination"},{"type":"link","url":"/build-basics/common-api-patterns/optimistic-concurrency","title":"Optimistic Concurrency"},{"type":"link","url":"/build-basics/clearing-fields","title":"Clear Object Fields"}],"title":"Common Square API Patterns","url":"/build-basics/common-api-patterns"},{"type":"link","url":"/ecommerce-api","title":"Square eCommerce APIs"},{"type":"link","url":"/build-basics/api-lifecycle","title":"Square API Lifecycle"}],"title":"Build Basics","url":"/buildbasics"},{"id":"3xPiA4blL9jPuuayGJ6MTW","type":"subcategory","items":[{"type":"link","url":"/devtools/developer-dashboard","title":"Developer Console"},{"type":"link","url":"/devtools/seller-dashboard","title":"Square Dashboard"},{"id":"3KRB4IB9BlZtJ6B2m6vUfS","type":"subcategory","items":[{"type":"link","url":"/devtools/sandbox/testing","title":"Test in Sandbox"},{"type":"link","url":"/devtools/sandbox/payments","title":"Sandbox Payments"},{"type":"link","url":"/devtools/sandbox/seed-data","title":"Sandbox Seeding Data"}],"title":"Sandbox","url":"/devtools/sandbox/overview"},{"type":"link","url":"/devtools/api-explorer","title":"API Explorer"},{"type":"link","url":"/devtools/api-logs","title":"API Logs"},{"type":"link","url":"/devtools/webhook-logs","title":"Webhook Event Logs"},{"id":"gjri5F4fH2T3zkF44a67X","type":"subcategory","items":[{"type":"link","url":"/webhooks/step1createurl","title":"Create a Notification URL"},{"type":"link","url":"/webhooks/step2subscribe","title":"Subscribe to Event Notifications"},{"type":"link","url":"/webhooks/step3validate","title":"Verify and Validate an Event Notification"},{"type":"link","url":"/webhooks/step4manage","title":"Manage Operations"},{"type":"link","url":"/webhooks/movetoprod","title":"Move Event Notifications to Production"},{"type":"link","url":"/webhooks/v2webhook-events-tech-ref","title":"Webhook Events Reference"},{"type":"link","url":"/webhooks/troubleshooting","title":"Troubleshooting"}],"title":"Webhooks","url":"/webhooks/overview"},{"type":"link","url":"/devtools/developer-permissions","title":"Build a Developer Team"},{"type":"link","url":"/auth","title":"Authentication"},{"type":"link","url":"/devtools/postman","title":"Postman"}],"title":"Developer Tools","url":"/devtools/overview"},{"id":"3Dla3ISAkrXINrZrVMau3d","type":"subcategory","items":[{"id":"2Ca4WvgGRCnQW4KBXsLDjR","type":"subcategory","items":[{"type":"link","url":"/sdks/java/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/java/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/java/using-java-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/java/common-square-api-patterns","title":"Common API Patterns"}],"title":"Java","url":"/sdks/java"},{"id":"6ioIsulmzIRS1Fp5LbpySx","type":"subcategory","items":[{"type":"link","url":"/sdks/dotnet/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/dotnet/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/dotnet/using-dot-net-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/dotnet/common-square-api-patterns","title":"Common API Patterns"}],"title":".NET","url":"/sdks/dotnet"},{"id":"TtR5ma1jNu33j5Up3QRZ7","type":"subcategory","items":[{"type":"link","url":"/sdks/nodejs/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/nodejs/common-square-api-patterns","title":"Common API Patterns"},{"type":"link","url":"/sdks/nodejs/migration","title":"Migration Guide"}],"title":"Node.js","url":"/sdks/nodejs"},{"id":"3hWuvXuREAS464rBzFn5S6","type":"subcategory","items":[{"type":"link","url":"/sdks/php/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/php/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/php/using-php-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/php/common-square-api-patterns","title":"Common API Patterns"}],"title":"PHP","url":"/sdks/php"},{"id":"6wVrPqjTomk2Pg7Y2aPTPX","type":"subcategory","items":[{"type":"link","url":"/sdks/python/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/python/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/python/using-python-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/python/common-square-api-patterns","title":"Common API Patterns"}],"title":"Python","url":"/sdks/python"},{"id":"1tWDddcaCZLVqVBGIxvs4A","type":"subcategory","items":[{"type":"link","url":"/sdks/ruby/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/ruby/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/ruby/using-ruby-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/ruby/common-square-api-patterns","title":"Common API Patterns"}],"title":"Ruby","url":"/sdks/ruby"},{"id":"3geJJhUlXHHQQDcUGty5BW","type":"subcategory","items":[{"type":"link","url":"/sdks/go/quick-start","title":"Quickstart"}],"title":"Go","url":"/sdks/go"}],"title":"Square SDKs","url":"/sdks"},{"type":"link","url":"/sample-apps","title":"Sample Applications"},{"type":"divider","style":"divider"},{"id":"31uVZVus1mPqbgRgRBWk2b","type":"subcategory","items":[{"type":"link","url":"/graphql/basics","title":"GraphQL Basics"},{"type":"link","url":"/graphql/build-your-first-query","title":"Build your First Query"},{"type":"link","url":"/devtools/graphqlexplorer","title":"GraphQL Explorer"},{"type":"link","url":"/graphql/query-examples","title":"Query Examples"}],"title":"GraphQL","url":"/devtools/graphql"},{"type":"divider","style":"divider"},{"id":"1xR5tTBo3FKTtqQB9F8d6J","type":"subcategory","items":[{"type":"link","url":"/oauth-api/create-urls-for-square-authorization","title":"Create Redirect URL and Authorization Page URL"},{"type":"link","url":"/oauth-api/receive-and-manage-tokens","title":"Receive Authorization and Manage OAuth Tokens"},{"type":"link","url":"/oauth-api/refresh-revoke-limit-scope","title":"Refresh and Revoke OAuth Tokens"},{"type":"link","url":"/oauth-api/token-introspection","title":"Token Introspection"},{"type":"link","url":"/oauth-api/best-practices","title":"OAuth Best Practices"},{"type":"link","url":"/oauth-api/walkthrough","title":"OAuth Walkthrough"},{"type":"link","url":"/oauth-api/migrate-to-square-oauth-flow","title":"Migrate to the Square API OAuth Flow"},{"type":"link","url":"/oauth-api/movetoprod","title":"Move OAuth to Production"},{"type":"link","url":"/oauth-api/square-permissions","title":"Permissions Reference"}],"title":"OAuth","url":"/oauth-api/overview"},{"type":"link","url":"/webhooks/webhook-subscriptions-api","title":"Webhook Subscriptions"},{"type":"link","url":"/events-api/overview","title":"Events"},{"type":"divider","style":"divider"},{"id":"2b6GKzXmebfh3NFImkw69V","type":"subcategory","items":[{"type":"link","url":"/migrate-from-v1/current-status","title":"Deprecated Items"},{"id":"2S2I7wKsntsXiMbpEYl1vv","type":"subcategory","items":[{"type":"link","url":"/migrate-from-v1/guides/v1-payments","title":"v1 Payments API"},{"type":"link","url":"/migrate-from-v1/guides/v1-refunds","title":"v1 Refunds API"},{"type":"link","url":"/payments-api/migrate-from-transactions-api","title":"Square Transactions API"},{"type":"link","url":"/labor-api/migrate-to-teams","title":"Migrate Employees to Team Members"},{"type":"link","url":"/migrate-from-v1/guides/v1-checkout","title":"Migrate from CreateCheckout to CreatePaymentLink"}],"title":"API Migration Guides"}],"title":"Migrate from Deprecated APIs","url":"/migrate-from-v1"},{"id":"2FbyzmNmotvJlFa0lkrvGa","type":"subcategory","items":[{"type":"link","url":"/international-development/oauth-testing","title":"OAuth and Testing"},{"type":"link","url":"/international-development/payments","title":"International Payments"},{"type":"link","url":"/international-development/regional-differences","title":"Regional Differences for International Development"},{"type":"link","url":"/international-development/japan-invoice-system","title":"Compliance with Japan's Tax Invoice System"}],"title":"International Development","url":"/international-development"}],"title":"Dev Essentials","url":"/development-essentials"},{"type":"divider","style":"divider"},{"id":"1JxXf5dweJNagXLkQOFGsh","type":"subcategory","items":[{"type":"link","url":"/payments-overview","title":"Overview"},{"id":"7zfhvbp4AghuyT3BkoJd1v","type":"subcategory","items":[{"type":"link","url":"/payments/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/payments/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/payments/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/payments/scenarios"},{"id":"uUZ9NoDit8f9tVTf5zSRm","type":"subcategory","items":[{"id":"1gxFZ2zjIW9IxVIOVrlHsi","type":"subcategory","items":[{"id":"cX9mbMbYzJRiexfbw1HuZ","type":"subcategory","items":[{"type":"link","url":"/payments-api/take-payments/card-payments/delayed-capture","title":"Delayed Capture"},{"type":"link","url":"/payments-api/take-payments/card-payments/partial-payments-with-gift-cards","title":"Partial Payments"},{"type":"link","url":"/payments-api/take-payments/card-payments/statement-descriptions","title":"Statement Descriptions"}],"title":"Card Payments","url":"/payments-api/take-payments/card-payments"},{"type":"link","url":"/payments-api/take-payments/ach-payments","title":"ACH Bank Transfer Payment"},{"type":"link","url":"/payments-api/take-payments/afterpay-payments","title":"Afterpay and Clearpay Payments"},{"type":"link","url":"/payments-api/take-payments/cash-app-payments","title":"Cash App Payments"},{"type":"link","url":"/payments-api/take-payments/cash-payments","title":"Cash Payments"},{"type":"link","url":"/payments-api/take-payments/external-payments","title":"External Payments"},{"type":"link","url":"/payments-api/take-payments/house-accounts","title":"House Accounts"}],"title":"Take Payments","url":"/payments-api/take-payments"},{"type":"link","url":"/payments-api/take-payments-and-collect-fees","title":"Collect Application Fees"},{"type":"link","url":"/payments-api/update-payments","title":"Update Payment and Tip Amounts"},{"type":"link","url":"/payments-api/retrieve-payments","title":"Retrieve Payments"},{"type":"link","url":"/payments-api/error-codes","title":"Troubleshoot"},{"type":"link","url":"/payments-api/webhooks","title":"Webhooks"}],"title":"Payments","url":"/payments-refunds"},{"id":"2zvmrqXp2ajTw6sZprzRpu","type":"subcategory","items":[{"type":"link","url":"/payments-api/refund-payments","title":"Refund Payments"},{"type":"link","url":"/payments-api/collect-fees/payment-with-app-fee-refund","title":"Refund a Payment with an App Fee"},{"type":"link","url":"/refunds-api/retrieve-refunds","title":"Retrieve Refunds"},{"type":"link","url":"/refunds-api/unlinked-refunds","title":"Process an Unlinked Refund"},{"type":"link","url":"/refunds-api/webhooks","title":"Webhooks"}],"title":"Refunds","url":"/refunds-api/overview"},{"id":"zsWHyi2OOINzGoMk3KheJ","type":"subcategory","items":[{"type":"link","url":"/disputes-api/process-disputes","title":"Process Disputes"},{"type":"link","url":"/disputes-api/sandbox-testing","title":"Test in the Sandbox"}],"title":"Disputes","url":"/disputes-api/overview"},{"type":"divider","style":"divider"},{"id":"3QI4Ij83kOJO4XY5vg44ec","type":"subcategory","items":[{"id":"4qST1Mhcut4CEO49Ymx2wJ","type":"subcategory","items":[{"type":"link","url":"/terminal-api/quickstart","title":"Quickstart"},{"type":"link","url":"/terminal-api/square-terminal-payments","title":"Take Payments"},{"type":"link","url":"/terminal-api/pos-integration","title":"POS App Pairing with Square Terminal"},{"type":"link","url":"/terminal-api/dismiss-checkouts-and-refunds","title":"Dismiss Terminal Checkouts and Refunds"},{"type":"link","url":"/terminal-api/terminal-device-monitoring","title":"Monitor Square Terminals"},{"type":"link","url":"/terminal-api/advanced-features","title":"Manage Terminal Actions"},{"type":"link","url":"/terminal-api/advanced-features/save-card-on-file","title":"Save Card on File"},{"type":"link","url":"/terminal-api/advanced-features/check-device-information","title":"Check Device Information"},{"type":"link","url":"/terminal-api/advanced-features/issue-receipts","title":"Print or Issue Receipts"},{"type":"link","url":"/terminal-api/advanced-features/customize-idle-screen","title":"Customize the Idle Screen"},{"id":"5csDnJcAAfXw1PIO507K5i","type":"subcategory","items":[{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/confirmation","title":"Confirmation Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/signature","title":"Signature Capture Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/data-collection","title":"Data Collection Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/menu-select","title":"Menu Selection List Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/qr-code-display","title":"QR Code Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions","title":"Link and Dismiss Actions"}],"title":"Custom Screen Workflows","url":"/terminal-api/advanced-features/custom-workflows"},{"id":"1diR890qlxltZJ0tUr6fPB","type":"subcategory","items":[{"type":"link","url":"/terminal-api/square-terminal-refunds","title":"Refund Interac Payments"},{"type":"link","url":"/terminal-api/e-money-payments","title":"Take E-Money Payments"},{"type":"link","url":"/terminal-api/international-payment-methods/paypay-qr-code-payments","title":"Take QR Code Payments for Digital Wallets"}],"title":"International Payment Methods","url":"/terminal-api/international-payment-methods"}],"title":"Terminal API","url":"/terminal-api/overview"},{"id":"4sRkVAYqVuVcsx5Xht8EIO","type":"subcategory","items":[{"id":"V2EiCWkS7R7XRjihKoGRJ","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/android/configure-authorize","title":"Authorize the Mobile Payments SDK"},{"type":"link","url":"/mobile-payments-sdk/android/pair-manage-readers","title":"Pair and Manage Card Readers"},{"type":"link","url":"/mobile-payments-sdk/android/take-payments","title":"Take a Payment"},{"type":"link","url":"/mobile-payments-sdk/android/offline-payments","title":"Offline Payments"},{"type":"link","url":"/mobile-payments-sdk/android/handling-errors","title":"Handling Errors"}],"title":"Build on Android","url":"/mobile-payments-sdk/android"},{"id":"184IwlKxX3dToiJCIgybi7","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/ios/configure-authorize","title":"Authorize the Mobile Payments SDK"},{"type":"link","url":"/mobile-payments-sdk/ios/pair-manage-readers","title":"Pair and Manage Card Readers"},{"type":"link","url":"/mobile-payments-sdk/ios/take-payments","title":"Take a Payment"},{"type":"link","url":"/mobile-payments-sdk/ios/offline-payments","title":"Offline Payments"},{"type":"link","url":"/mobile-payments-sdk/ios/square-stand","title":"Configure for Square Stand or Square Kiosk"},{"type":"link","url":"/mobile-payments-sdk/ios/handling-errors","title":"Handling Errors"}],"title":"Build on iOS","url":"/mobile-payments-sdk/ios"},{"type":"link","url":"/mobile-payments-sdk/migrate","title":"Migrate from Reader SDK"},{"type":"link","url":"/mobile-payments-sdk/react-native","title":"React Native Plugin"}],"title":"Mobile Payments SDK","url":"/mobile-payments-sdk"},{"id":"41VWCwHuOVzHNHKVQOT41","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/migrate","title":"Migrate to Mobile Payments SDK"},{"id":"4xNhvuBpEO78hn0xLFBiJp","type":"subcategory","items":[{"type":"link","url":"/reader-sdk/quick-start/step-1","title":"Get Credentials"},{"type":"link","url":"/reader-sdk/quick-start/step-2","title":"Configure the Sample Application"},{"type":"link","url":"/reader-sdk/quick-start/step-3","title":"Take a Cash Payment"},{"type":"link","url":"/reader-sdk/quick-start/step-4","title":"Customize the Checkout Amount"},{"type":"link","url":"/reader-sdk/quick-start/step-5","title":"Take a Credit Card Payment"}],"title":"Quickstart","url":"/reader-sdk/quick-start/start"},{"type":"link","url":"/reader-sdk/how-it-works","title":"How It Works"},{"type":"link","url":"/reader-sdk/build-on-android","title":"Build on Android"},{"type":"link","url":"/reader-sdk/build-on-ios","title":"Build on iOS"},{"type":"link","url":"/reader-sdk/cookbook/contactless-reader","title":"Connect a Contactless Reader"},{"type":"link","url":"/reader-sdk/cookbook/charge-cards-on-file","title":"Charge a Card on File"},{"type":"link","url":"/reader-sdk/cookbook/save-cards-on-file","title":"Save a Card on File"},{"type":"link","url":"/reader-sdk/cookbook/square-stand","title":"Configure on iOS for Square Stand"},{"type":"link","url":"/reader-sdk/cookbook/deauthorize-reader-sdk","title":"Deauthorize Reader SDK"},{"type":"link","url":"/reader-sdk/cookbook/capture-a-transaction","title":"Capture a Transaction"},{"type":"link","url":"/reader-sdk/cookbook/delay-capture-of-payment","title":"Delay the Capture of Payments"},{"type":"link","url":"/reader-sdk/cookbook/configure-apk-splits","title":"Configure APK Splits"},{"type":"link","url":"/reader-sdk/upgrade-reader-sdk","title":"Update to New Reader SDK Version"},{"type":"link","url":"/reader-sdk/flutter","title":"Flutter Plugin"},{"type":"link","url":"/reader-sdk/react-native","title":"React Native Plugin"}],"title":"Reader SDK","url":"/reader-sdk/what-it-does"},{"id":"3afip77TiGS5ECyUYIRM96","type":"subcategory","items":[{"type":"link","url":"/pos-api/how-it-works","title":"How It Works"},{"type":"link","url":"/pos-api/build-on-android","title":"Build on Android"},{"type":"link","url":"/pos-api/build-on-ios","title":"Build on iOS"},{"type":"link","url":"/pos-api/build-mobile-web","title":"Build on Mobile Web"},{"type":"link","url":"/pos-api/cookbook/find-your-android-fingerprint","title":"Find Your Android Fingerprint"},{"type":"link","url":"/pos-api/cookbook/offline-mode","title":"Use the API in Offline Mode"},{"type":"link","url":"/pos-api/cookbook/alert-dialog-helper","title":"Add an Alert Dialog Helper Class"},{"type":"link","url":"/pos-api/cookbook/electronic-payments","title":"Accept E-Money Payments"},{"type":"link","url":"/pos-api/qr-code-payments-paypay","title":"Accept PayPay Payments"},{"type":"link","url":"/pos-api/web-technical-reference","title":"Mobile Web Technical Reference"},{"type":"link","url":"/pos-api/payments-integration","title":"Payments API Integration"}],"title":"Point of Sale API","url":"/pos-api/what-it-does"}],"title":"Take Payments on Hardware","url":"/in-person-payment-options"},{"id":"6sXAr41iJBMDHea2l3Z8gv","type":"subcategory","items":[{"id":"7jyjtk6YX9Vvjr6IB3nf2J","type":"subcategory","items":[{"id":"50fRf1DljbdST7WDPNFEwv","type":"subcategory","items":[{"type":"link","url":"/web-payments/quickstart/clone-quickstart-project","title":"Clone the Quickstart Project Template"},{"type":"link","url":"/web-payments/quickstart/add-sdk-to-web-client","title":"Add the SDK to the Web Client"},{"type":"link","url":"/web-payments/quickstart/verify-the-payment","title":"Verify the Payment"},{"type":"link","url":"/web-payments/quickstart/add-sca","title":"Add Strong Customer Authentication"},{"type":"link","url":"/web-payments/quickstart/deploy-app","title":"Deploy the Application"}],"title":"Quickstart","url":"/web-payments/quickstart"},{"type":"link","url":"/web-payments/take-card-payment","title":"Take a Card Payment"},{"id":"76vVgo6CnCmx5Xt8tJJnS8","type":"subcategory","items":[{"type":"link","url":"/web-payments/apple-pay","title":"Apple Pay"},{"type":"link","url":"/web-payments/google-pay","title":"Google Pay"},{"type":"link","url":"/web-payments/payment-requests","title":"Digital Wallet Payment Requests"}],"title":"Integrate Digital Wallets","url":"/web-payments/digital-wallets"},{"type":"link","url":"/web-payments/add-ach","title":"ACH Bank Transfer"},{"type":"link","url":"/web-payments/add-afterpay","title":"Afterpay"},{"type":"link","url":"/web-payments/add-cash-app-pay","title":"Cash App Pay"},{"id":"UmgjQ7AynheCEMWohcGmp","type":"subcategory","items":[{"type":"link","url":"/web-payments/gift-card","title":"Take a Gift Card Payment"},{"type":"link","url":"/web-payments/gift-card-walkthrough","title":"Take Partial Payments"}],"title":"Square Gift Card Payments","url":"/web-payments/gift-cards-intro"},{"type":"link","url":"/web-payments/customize-styles","title":"Customize the Card Entry Form"},{"type":"link","url":"/web-payments/sca","title":"Add SCA to a Card Payment"},{"type":"link","url":"/web-payments/sca-add-card","title":"Store a Card on File"},{"type":"link","url":"/web-payments/sca-charge-card-on-file","title":"Charge a Card on File"},{"type":"link","url":"/web-payments/sca-charge-and-store-card-on-file","title":"Charge and Store a Card on File"}],"title":"Web Payments SDK","url":"/web-payments/overview"},{"id":"3kx6yG9fmBAdJZbbO6F1yD","type":"subcategory","items":[{"id":"61aUeKzNEGAElKXXrUTg3x","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/quick-start/generate-token","title":"Set up the Client"},{"type":"link","url":"/in-app-payments-sdk/quick-start/deploy-server-backend","title":"Deploy the Server"}],"title":"Quickstart","url":"/in-app-payments-sdk/quick-start"},{"type":"link","url":"/in-app-payments-sdk/installation","title":"Install the SDK"},{"type":"link","url":"/in-app-payments-sdk/build-on-android","title":"Build on Android"},{"type":"link","url":"/in-app-payments-sdk/build-on-ios","title":"Build on iOS"},{"id":"1YvixWOltemNhXC61aCNfc","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/google-pay","title":"Google Pay"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/apple-pay","title":"Apple Pay"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/src/android","title":"Enable SRC for Android"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/src/ios","title":"Enable SRC for iOS"}],"title":"Integrate Digital Wallets","url":"/in-app-payments-sdk/add-digital-wallets"},{"type":"link","url":"/in-app-payments/localize-ios","title":"Localize an Application "},{"type":"link","url":"/in-app-payments-sdk/cookbook/giftcards","title":"Gift Card Payments"},{"type":"link","url":"/in-app-payments-sdk/flutter","title":"Flutter Plugin"},{"type":"link","url":"/in-app-payments-sdk/react-native","title":"React Native Plugin"},{"type":"link","url":"/in-app-payments-sdk/cookbook/customize-payment-form","title":"Customize the Payment Entry Form"},{"type":"link","url":"/in-app-payments-sdk/cookbook/connect-to-a-backend-service","title":"Connect to a Backend Service"},{"type":"link","url":"/in-app-payments-sdk/cookbook/disable-postal-code","title":"Remove the Postal Code Requirement"},{"type":"link","url":"/in-app-payments-sdk/troubleshooting","title":"Troubleshoot"},{"type":"link","url":"/in-app-payments-sdk/how-it-works","title":"How It Works"},{"id":"6CxT0SjYvqtIoHogrU592e","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/verify-buyer","title":"Verify a Buyer"}],"title":"Strong Customer Authentication","url":"/sca-overview-iap"}],"title":"In-App Payments SDK","url":"/in-app-payments-sdk/what-it-does"},{"id":"V4hkw0bOYUpdBadmYBHr0","type":"subcategory","items":[{"type":"link","url":"/checkout-api/quick-pay-checkout","title":"Quick Pay Checkout"},{"type":"link","url":"/checkout-api/square-order-checkout","title":"Square Order Checkout"},{"type":"link","url":"/checkout-api/subscription-plan-checkout","title":"Subscription Plan Checkout"},{"type":"link","url":"/checkout-api/checkout-settings","title":"Checkout Settings"},{"type":"link","url":"/checkout-api/optional-checkout-configurations","title":"Checkout Configurations"},{"type":"link","url":"/checkout-api/manage-checkout","title":"Manage Checkout"},{"type":"link","url":"/checkout-api/guidelines-and-limitations","title":"Guidelines and Limitations"}],"title":"Checkout API","url":"/checkout-api"},{"id":"48IHue04VlAsOncIA5GupV","type":"subcategory","items":[{"type":"link","url":"/subscriptions-api/plans-and-variations","title":"Subscription Plans and Variations"},{"type":"link","url":"/subscriptions-api/manage-subscriptions","title":"Manage Subscriptions"},{"type":"link","url":"/subscriptions-api/actions-events","title":"Subscription Actions and Events"},{"type":"link","url":"/subscriptions-api/pause-resume-cancel-subscriptions","title":"Pause, Resume, or Cancel Subscriptions"},{"type":"link","url":"/subscriptions-api/subscription-billing","title":"Subscription Billing and Invoices"},{"type":"link","url":"/subscriptions-api/swap-plan-variations","title":"Swap Subscription Plan Variations"}],"title":"Subscriptions API","url":"/subscriptions/overview"},{"id":"56mq1PzSktrD9m24himiW5","type":"subcategory","items":[{"type":"link","url":"/invoices-api/create-publish-invoices","title":"Create and Publish Invoices"},{"type":"link","url":"/invoices-api/retrieve-list-search-invoices","title":"Retrieve, List, or Search Invoices"},{"type":"link","url":"/invoices-api/attachments","title":"Create or Delete Invoice Attachments"},{"type":"link","url":"/invoices-api/update-invoices","title":"Update Invoices"},{"type":"link","url":"/invoices-api/cancel-delete-invoices","title":"Cancel or Delete Invoices"},{"type":"link","url":"/invoices-api/pay-refund-invoices","title":"Pay or Refund Invoices"},{"type":"link","url":"/invoices-api/walkthrough","title":"Walkthrough: Create and Publish Invoices"}],"title":"Invoices API","url":"/invoices-api/overview"}],"title":"Take Payments Online","url":"/online-payment-options"},{"type":"divider","style":"divider"},{"id":"3crTgQawiMx30ZW42kX5w8","type":"subcategory","items":[{"type":"link","url":"/cards-api/manage-cards","title":"Manage Cards"},{"type":"link","url":"/cards-api/walkthrough/card-from-payment-id","title":"Create a Card on File from Payment ID"},{"type":"link","url":"/cards-api/walkthrough-seller-card","title":"Create a Card on File and Make a Payment"},{"type":"link","url":"/cards-api/walkthrough-shared-card","title":"Create a Shared Card on File and Make a Payment"}],"title":"Cards","url":"/cards-api/overview"},{"id":"3oWs4JO3JfhkfDcUEhNGeJ","type":"subcategory","items":[{"type":"link","url":"/payouts-api/list-payouts","title":"List Payouts"},{"type":"link","url":"/payouts-api/get-payout","title":"Get Payout"},{"type":"link","url":"/payouts-api/list-payout-entries","title":"List Payout Entries"}],"title":"Payouts","url":"/payouts-api/overview"},{"type":"link","url":"/bank-accounts-api","title":"Bank Accounts"},{"id":"7re5dyp7kQZpvvwAJUee93","type":"subcategory","items":[{"type":"link","url":"/mobile-authz/how-it-works","title":"How It Works"},{"type":"link","url":"/mobile-authz/build-with-mobile-authz","title":"Build with Mobile Authorization"},{"type":"link","url":"/mobile-authz/cookbook/mobile-code-with-curl","title":"Get Authorization Code on Command Line"}],"title":"Mobile Authorization","url":"/mobile-authz/what-it-does"},{"type":"divider","style":"divider"},{"type":"link","url":"/payment-card-support-by-country","title":"Payment Methods by Country"},{"type":"link","url":"/payments-pricing","title":"Payments Pricing"},{"type":"link","url":"/sca-overview","title":"Strong Customer Authentication"},{"type":"link","url":"/payment-minimums","title":"Payment Minimums"}],"title":"Payments","url":"/payments-overview"},{"id":"3NKV9K0UfSbHh8odPIJR1c","type":"subcategory","items":[{"type":"link","url":"/commerce","title":"Overview"},{"id":"4F79mKtS4eqZigce67OxFF","type":"subcategory","items":[{"type":"link","url":"/commerce/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/commerce/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/commerce/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/commerce-scenarios"},{"id":"1fQKpXBuZJnPgVRaDRKLg0","type":"subcategory","items":[{"type":"link","url":"/orders-api/create-orders","title":"Create Orders"},{"type":"link","url":"/orders-api/manage-orders/update-orders","title":"Update Orders"},{"type":"link","url":"/orders-api/manage-orders/search-orders","title":"Search Orders"},{"type":"link","url":"/orders-api/manage-orders/retrieve-orders","title":"Retrieve Orders"},{"id":"3actPvHZPDJZx122xWJpED","type":"subcategory","items":[{"type":"link","url":"/orders-api/apply-taxes-and-discounts/auto-apply-discounts","title":"Apply Square-Defined Discounts"},{"type":"link","url":"/orders-api/apply-taxes-and-discounts/auto-apply-taxes","title":"Apply Catalog Taxes to Orders"}],"title":"Apply Catalog Taxes and Discounts","url":"/orders-api/apply-taxes-and-discounts"},{"id":"ebWImqVQwkBx3xfF0lbvb","type":"subcategory","items":[{"type":"link","url":"/orders-api/discounts","title":"Order Discounts"},{"type":"link","url":"/orders-api/taxes","title":"Order Taxes"},{"type":"link","url":"/orders-api/service-charges","title":"Order Service Charges"}],"title":"Order Price Adjustments","url":"/orders-api/price-adjustments"},{"type":"link","url":"/orders-api/pay-for-orders","title":"Pay for Orders"},{"type":"divider","style":"divider"},{"type":"link","url":"/orders-api/order-returns-exchanges","title":"Refunds and Exchanges"},{"type":"link","url":"/orders-api/fulfillments","title":"Manage Fulfillments"},{"type":"link","url":"/orders-api/how-it-works","title":"How It Works"},{"type":"link","url":"/orders-api/order-ahead-usecase","title":"Order-Ahead Use Case"},{"id":"7zVLALaKpsa7uX7WLYhQ8e","type":"subcategory","items":[{"type":"link","url":"/orders-api/quick-start/step-1","title":"Get Developer Credentials"},{"type":"link","url":"/orders-api/quick-start/step-2","title":"Configure the Sample Application"},{"type":"link","url":"/orders-api/quick-start/step-3","title":"Generate Test Catalog Items"},{"type":"link","url":"/orders-api/quick-start/step-4","title":"Take a Pickup Order"},{"type":"link","url":"/orders-api/quick-start/step-5","title":"Verify a Pickup Order"}],"title":"Order-Ahead Sample App","url":"/orders-api/quick-start"},{"type":"link","url":"/orders-api/metadata","title":"Metadata"}],"title":"Orders","url":"/orders-api/what-it-does"},{"id":"7uE6hgqgUI1iKEWFxYKPYb","type":"subcategory","items":[{"type":"link","url":"/orders-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes"},{"type":"link","url":"/orders-custom-attributes-api/custom-attributes","title":"Use Custom Attributes"}],"title":"Order Custom Attributes","url":"/orders-custom-attributes-api/overview"},{"id":"5uzyfjmBfADM23ka1K1pWH","type":"subcategory","items":[{"type":"link","url":"/catalog-api/design-a-catalog","title":"Design a Catalog"},{"type":"link","url":"/catalog-api/build-with-catalog","title":"Build a Catalog"},{"type":"link","url":"/catalog-api/update-catalog-objects","title":"Update Catalog Objects"},{"type":"link","url":"/catalog-api/retrieve-catalog-objects","title":"Retrieve Catalog Objects"},{"id":"XauByVgbcHPakYrcVm4lx","type":"subcategory","items":[{"type":"link","url":"/catalog-api/search-catalog-items","title":"Call SearchCatalogItems"},{"type":"link","url":"/catalog-api/search-catalog-objects","title":"Call SearchCatalogObjects"}],"title":"Search a Catalog","url":"/catalog-api/search-catalog"},{"type":"link","url":"/catalog-api/sync-with-external-system","title":"Synchronize Catalog with External Platform"},{"type":"link","url":"/catalog-api/archive-catalog-items","title":"Archive Catalog Items"},{"type":"link","url":"/catalog-api/delete-catalog-objects","title":"Delete Catalog Objects"},{"type":"link","url":"/catalog-api/categorize-catalog-items","title":"Categorize Catalog Items"},{"type":"link","url":"/catalog-api/enable-modifiers-on-items","title":"Enable Modifiers on Items"},{"type":"link","url":"/catalog-api/item-options","title":"Use Item Options"},{"id":"6lb9Ids2YTwmZdYSSWo9ZU","type":"subcategory","items":[{"type":"link","url":"/catalog-api/upload-and-attach-images","title":"Upload and Attach Images"},{"type":"link","url":"/catalog-api/manage-images","title":"Manage Images"}],"title":"Work with Images","url":"/catalog-api/cookbook/create-catalog-image"},{"type":"link","url":"/catalog-api/add-custom-attributes","title":"Add Custom Attributes"},{"id":"4uO79DXTpBj486wRLPVjD9","type":"subcategory","items":[{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/volume-discounts","title":"Create Volume Discounts"},{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/bundle-discounts","title":"Create Bundled Discounts"},{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/timeframe-discounts","title":"Create Time-Based Discounts"},{"type":"link","url":"/catalog-api/configure-customer-group-discounts","title":"Create Customer Group Discounts"}],"title":"Configure Discounts","url":"/catalog-api/cookbook/auto-apply-discounts"},{"type":"link","url":"/catalog-api/cookbook/set-quick-amounts","title":"Configure Quick Payments"},{"type":"link","url":"/catalog-api/webhooks","title":"Use Webhooks"}],"title":"Catalog","url":"/catalog-api/what-it-does"},{"id":"1VGd8FbxwmjW0KMaajkmro","type":"subcategory","items":[{"type":"link","url":"/inventory-api/how-it-works","title":"How It Works"},{"type":"link","url":"/inventory-api/build-with-inventory","title":"Build an Inventory"},{"type":"link","url":"/inventory-api/enable-stock-conversion","title":"Enable Stock Conversion"},{"type":"link","url":"/inventory-api/cookbook/reconcile-computed-quantity","title":"Reconcile Inventory Counts"},{"type":"link","url":"/inventory-api/cookbook/retrieve-specific-instock-quantity","title":"Retrieve Inventory Counts"},{"type":"link","url":"/inventory-api/cookbook/inventory-change-history","title":"Inspect Inventory Changes"},{"type":"link","url":"/inventory-api/monitor-sold-out-status-on-item-variation","title":"Monitor Sold-out Item Variations"},{"type":"link","url":"/inventory-api/webhooks","title":"Handle Inventory Events"},{"type":"link","url":"/inventory-api/migrate-to-updated-api-entities","title":"Migrate to Updated API Entities"}],"title":"Inventory","url":"/inventory-api/what-it-does"},{"id":"1oCvFBbwIfvkgSqzjsVtl2","type":"subcategory","items":[{"type":"link","url":"/bookings-api/get-ready-to-use-the-api","title":"Basic Concepts"},{"type":"link","url":"/bookings-api/onboard-to-the-api","title":"Onboard to Square Appointments"},{"type":"link","url":"/bookings-api/use-the-api","title":"Create and Manage Bookings"},{"type":"link","url":"/bookings-api/use-webhooks","title":"Handle Event Notifications"}],"title":"Bookings","url":"/bookings-api/what-it-is"},{"id":"3IFs9Vd3B5uWf4LFR7k8EL","type":"subcategory","items":[{"type":"link","url":"/booking-custom-attributes-api/custom-attribute-definitions","title":"Manage Custom Attribute Definitions for Bookings"},{"type":"link","url":"/booking-custom-attributes-api/custom-attributes","title":"Manage Custom Attributes for Bookings"}],"title":"Booking Custom Attributes","url":"/booking-custom-attributes-api/overview"},{"id":"5XXuzzOGN1H5FPRGJcikVN","type":"subcategory","items":[{"type":"link","url":"/vendors-api/create-vendors","title":"Create Vendors"},{"type":"link","url":"/vendors-api/update-vendors","title":"Update Vendors"},{"type":"link","url":"/vendors-api/retrieve-vendors","title":"Retrieve Vendors"},{"type":"link","url":"/vendors-api/search-for-vendors","title":"Search for Vendors"},{"type":"link","url":"/vendors-api/receive-vendors-events","title":"Receive Vendors Events"}],"title":"Vendors","url":"/vendors-api/manage-vendors-in-apps"},{"id":"1mKQKHnvTn1nAsKsA2JRCl","type":"subcategory","items":[{"id":"6bKuXUnDxmCCuIR7ihe7jW","type":"subcategory","items":[{"type":"link","url":"/sites-api/use-the-api","title":"Use the Sites API"}],"title":"Sites API","url":"/sites-api/overview"},{"id":"5Cl3kPc7CUDPgqnbaJBDVJ","type":"subcategory","items":[{"type":"link","url":"/snippets-api/use-the-api","title":"Use the Snippets API"},{"type":"link","url":"/snippets-api/add-a-snippet","title":"Add a Snippet to a Site"}],"title":"Snippets API","url":"/snippets-api/overview"}],"title":"Square Online","url":"/online-api"},{"type":"link","url":"/cashdrawershift-api/reporting","title":"Cash Drawer Shifts"}],"title":"Commerce","url":"/commerce"},{"id":"4URmYFehLwquxQBCQKBKSx","type":"subcategory","items":[{"type":"link","url":"/customers","title":"Overview"},{"id":"5A6vAFRO33giYriws2hfBB","type":"subcategory","items":[{"type":"link","url":"/customers/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/customers/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/customers/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/customers/scenarios"},{"id":"15dy7EMFV93TibH1VXLeuV","type":"subcategory","items":[{"type":"link","url":"/customers-api/how-it-works","title":"Customers API Workflows"},{"type":"link","url":"/customers-api/use-the-api/keep-records","title":"Manage Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/retrieve-profiles","title":"Retrieve Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/search-customers","title":"Search for Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/integrate-with-other-services","title":"Integrate with Other Services"},{"type":"link","url":"/customers-api/use-the-api/customer-webhooks","title":"Use Customer Webhooks"}],"title":"Customers","url":"/customers-api/what-it-does"},{"id":"76835s9ZeAgwsAQ3g4bAGW","type":"subcategory","items":[{"type":"link","url":"/customer-custom-attributes-api/custom-attribute-definitions","title":"Manage Customer Custom Attribute Definitions"},{"type":"link","url":"/customer-custom-attributes-api/custom-attributes","title":"Manage Customer Custom Attributes"}],"title":"Customer Custom Attributes","url":"/customer-custom-attributes-api/overview"},{"id":"3o5YnQHQmUFb3JPaTZB1DC","type":"subcategory","items":[{"type":"link","url":"/customer-groups-api/how-to-use-it","title":"Use Customer Groups"}],"title":"Customer Groups","url":"/customer-groups-api/what-it-does"},{"id":"1sYaoLP7iJ1tVaklA24liK","type":"subcategory","items":[{"type":"link","url":"/customer-segments-api/how-to-use-it","title":"Use Customer Segments"}],"title":"Customer Segments","url":"/customer-segments-api/what-it-does"},{"id":"JVl8yM8tzLNaxzj7qZtMM","type":"subcategory","items":[{"type":"link","url":"/loyalty/overview","title":"Loyalty Program Overview"},{"type":"link","url":"/loyalty-api/loyalty-programs","title":"Retrieve Loyalty Program"},{"type":"link","url":"/loyalty-api/loyalty-promotions","title":"Manage Loyalty Promotions"},{"type":"link","url":"/loyalty-api/loyalty-accounts","title":"Create and Retrieve Loyalty Accounts"},{"type":"link","url":"/loyalty-api/loyalty-points","title":"Manage Loyalty Points"},{"type":"link","url":"/loyalty-api/loyalty-rewards","title":"Manage Loyalty Rewards"},{"type":"link","url":"/loyalty-api/loyalty-events","title":"Search for Loyalty Events"},{"id":"1y9o6Z4aUBI2x7iBbs7dem","type":"subcategory","items":[{"type":"link","url":"/loyalty-api/walkthrough1/setup-loyalty-program","title":"Set up a Loyalty Program"},{"type":"link","url":"/loyalty-api/walkthrough1/enroll-buyer","title":"Enroll a Buyer"},{"type":"link","url":"/loyalty-api/walkthrough1/accrue-points","title":"Accumulate Points"},{"type":"link","url":"/loyalty-api/walkthrough1/redeem-points","title":"Redeem Points"}],"title":"Loyalty Walkthrough 1","url":"/loyalty-api/walkthrough1"},{"id":"11C6YxWjq6Ln0oPvOntZIE","type":"subcategory","items":[{"type":"link","url":"/loyalty-api/walkthrough2-setup-loyalty-program","title":"Set up a Loyalty Program"},{"type":"link","url":"/loyalty-api/walkthrough2-enroll-buyer","title":"Enroll a Buyer"},{"type":"link","url":"/loyalty-api/walkthrough2-accrue-points","title":"Adjust Points"},{"type":"link","url":"/loyalty-api/walkthrough2-redeem-points","title":"Redeem Points"}],"title":"Loyalty Walkthrough 2","url":"/loyalty-api/walkthrough2"}],"title":"Loyalty","url":"/loyalty-api/overview"},{"id":"SkbBIiQbMBmohDyoTixOJ","type":"subcategory","items":[{"type":"link","url":"/gift-cards/sell-gift-cards","title":"Sell Gift Cards"},{"type":"link","url":"/gift-cards/reload-gift-cards","title":"Reload Gift Cards"},{"type":"link","url":"/gift-cards/redeem-gift-cards","title":"Redeem Gift Cards"},{"type":"link","url":"/gift-cards/retrieve-gift-cards-and-activities","title":"Retrieve Gift Cards and Track Activity"},{"type":"link","url":"/gift-cards/manage-gift-cards-on-file","title":"Manage Gift Cards on File"},{"id":"6jk6v9WCq58u7FwD9THjoZ","type":"subcategory","items":[{"type":"link","url":"/gift-cards/walkthrough-1-with-orders-api","title":"Sell a Gift Card (Orders API Integration)"},{"type":"link","url":"/gift-cards/walkthrough-1-without-orders-api","title":"Sell a Gift Card (Custom Processing System)"}],"title":"Walkthrough 1: Sell a Gift Card","url":"/gift-cards/walkthrough-1"},{"id":"3dKyCAtUVMdrXS6NlwDLHz","type":"subcategory","items":[{"type":"link","url":"/gift-cards/walkthrough-2-orders-and-payments-integration","title":"Use a Gift Card (Orders and Payments APIs Integration)"},{"type":"link","url":"/gift-cards/walkthrough-2-custom-processing-system","title":"Use a Gift Card (Custom Processing System)"}],"title":"Walkthrough 2: Use a Gift Card","url":"/gift-cards/walkthrough-2"},{"type":"link","url":"/gift-cards/webhooks","title":"Webhooks"}],"title":"Gift Cards","url":"/gift-cards/using-gift-cards-api"}],"title":"Customers","url":"/customers"},{"id":"1ThKdZQl6m1Eioed7ZwOsS","type":"subcategory","items":[{"type":"link","url":"/staff","title":"Overview"},{"id":"6mOVdvn1uSAoAb8iJaDzEo","type":"subcategory","items":[{"type":"link","url":"/staff/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/staff/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/staff/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/staff/scenarios"},{"id":"2nH2TMoml4cRDkyaLvM892","type":"subcategory","items":[{"type":"link","url":"/team/integration","title":"Integration Guide"},{"type":"link","url":"/team/troubleshooting","title":"Troubleshoot Team API"}],"title":"Team","url":"/team/overview"},{"id":"4onB3obwWl1foVPal7Sq8X","type":"subcategory","items":[{"type":"link","url":"/labor-api/build-with-labor","title":"Build with Labor"},{"type":"link","url":"/labor-api/cookbook/add-shift-breaks","title":"Add Shift Breaks"},{"type":"link","url":"/labor-api/cookbook/get-completed-shifts","title":"Get Completed Shifts"},{"type":"link","url":"/labor-api/how-it-works","title":"How It Works"},{"type":"link","url":"/labor-api/troubleshooting","title":"Troubleshoot"},{"type":"link","url":"/labor-api/webhooks","title":"Webhooks"}],"title":"Labor","url":"/labor-api/what-it-does"}],"title":"Staff","url":"/staff"},{"id":"5BHWPSspAJWZD75mfWezwx","type":"subcategory","items":[{"type":"link","url":"/merchant-details","title":"Overview"},{"id":"3OwozWeQAYofh9tmoyrEPq","type":"subcategory","items":[{"type":"link","url":"/merchants/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/merchants/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/merchants/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/merchants/scenarios"},{"type":"link","url":"/merchants-api","title":"Merchants"},{"id":"3busOpLCt9zKcYBv4DnkxZ","type":"subcategory","items":[{"type":"link","url":"/merchant-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes for Merchants"},{"type":"link","url":"/merchant-custom-attributes-api/custom-attributes","title":"Use Custom Attributes for Merchants"}],"title":"Merchant Custom Attributes","url":"/merchant-custom-attributes-api/overview"},{"type":"link","url":"/locations-api","title":"Locations"},{"id":"3OtQbV9DLTefjKNm185T2k","type":"subcategory","items":[{"type":"link","url":"/location-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes for Locations"},{"type":"link","url":"/location-custom-attributes-api/custom-attributes","title":"Use Custom Attributes for Locations"}],"title":"Location Custom Attributes","url":"/location-custom-attributes-api/overview"}],"title":"Merchants","url":"/merchant-details"},{"type":"divider","style":"divider"},{"id":"2FhNpYU8iPn0qCJYFJureL","type":"subcategory","items":[{"id":"4dMAnH4WGqOuZx7AQsbW6W","type":"subcategory","items":[{"id":"3QpiaF1RqkIztw876w6vhH","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/what-should-i-build","title":"What Should I Build?"},{"id":"PkhOF4kBMi8AcjqYu6NjO","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/requirements/general","title":"General"},{"type":"link","url":"/app-marketplace/requirements/oauth-api","title":"OAuth API"},{"type":"link","url":"/app-marketplace/requirements/locations-api","title":"Locations API"},{"type":"link","url":"/app-marketplace/requirements","title":" ---------------"},{"type":"link","url":"/app-marketplace/requirements/app-subscriptions","title":"App Subscriptions"},{"type":"link","url":"/app-marketplace/requirements/bookings-api","title":"Bookings API"},{"type":"link","url":"/app-marketplace/requirements/catalog-api","title":"Catalog and Inventory API"},{"type":"link","url":"/app-marketplace/requirements/customers-api","title":"Customers API"},{"type":"link","url":"/app-marketplace/requirements/invoices-api","title":"Invoices API"},{"type":"link","url":"/app-marketplace/requirements/gift-cards-api","title":"Gift Cards API"},{"type":"link","url":"/app-marketplace/requirements/labor-api","title":"Labor API"},{"type":"link","url":"/app-marketplace/requirements/loyalty-api","title":"Loyalty API"},{"type":"link","url":"/app-marketplace/requirements/orders-api","title":"Orders API"},{"type":"link","url":"/app-marketplace/requirements/payments-api","title":"Payments"},{"type":"link","url":"/app-marketplace/requirements/payouts-api","title":"Payouts API"},{"type":"link","url":"/app-marketplace/requirements/snippets-api","title":"Snippets API"},{"type":"link","url":"/app-marketplace/requirements/subscriptions-api","title":"Subscriptions API"},{"type":"link","url":"/app-marketplace/requirements/team-api","title":"Team API"},{"type":"link","url":"/app-marketplace/requirements/terminal-api","title":"Terminal API"},{"type":"link","url":"/app-marketplace/requirements/webhooks","title":"Webhooks"}],"title":"Requirements","url":"/app-marketplace/requirements"},{"type":"link","url":"/app-marketplace/video-submission","title":"Video Submission Requirements"}],"title":"Build an App","url":"/app-marketplace/build"},{"id":"24UhdFmhHPDXsMEzIJ6OG4","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/listing-best-practices/basics","title":"Basic Information"},{"type":"link","url":"/app-marketplace/listing-best-practices/details","title":"Details"},{"type":"link","url":"/app-marketplace/listing-best-practices/get-started","title":"Get Started"},{"type":"link","url":"/app-marketplace/listing-best-practices/pricing","title":"Pricing"},{"type":"link","url":"/app-marketplace/listing-best-practices/brand-and-images","title":"Brand and Images"},{"type":"link","url":"/app-marketplace/listing-best-practices/support-information","title":"Support Information"}],"title":"Create an App Marketplace Listing","url":"/app-marketplace/listing-best-practices"},{"id":"4iCpNMONaJXwer69vlZd8Y","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/rev-share","title":"App Marketplace Revenue Sharing"},{"type":"link","url":"/app-marketplace/referral-tracking-links","title":"Referral Tracking Links"},{"id":"1el38dmWf4nbVIBAf60U2Q","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/app-subscriptions/billing","title":"App Subscriptions Billing"}],"title":"App Subscriptions","url":"/app-marketplace/app-subscriptions"}],"title":"Monetize your Application","url":"/app-marketplace/earn-and-share"},{"type":"link","url":"/app-marketplace/promote-your-app","title":"Promote your App"},{"type":"link","url":"/app-marketplace/app-reviews","title":"App Marketplace Reviews"},{"type":"link","url":"/app-marketplace/faq","title":"App Marketplace Frequently Asked Questions"}],"title":"App Marketplace","url":"/app-marketplace"}],"title":"Publish","url":"/app-marketplace"},{"type":"divider","style":"space"},{"type":"divider","style":"divider"},{"id":"347zcabrwZkdfbgVsDmSBO","type":"subcategory","items":[{"type":"link","url":"/release-notes","title":"Overview"},{"type":"link","url":"/changelog/connect","title":"Square APIs and SDKs"},{"type":"link","url":"/changelog/mobile","title":"Mobile SDKs"},{"id":"6QrXNH8opd01JmuzgLjUXU","type":"subcategory","items":[{"type":"link","url":"/changelog/webpaymentsdk","title":"Web Payments SDK"},{"type":"link","url":"/changelog/paymentform","title":"Payment Form"}],"title":"Web SDKs","url":"/changelog/websdks"},{"type":"link","url":"/changelog/requirements","title":"App Marketplace Requirements"}],"title":"Release notes","url":"/release-notes"}]}},"notFound":false,"preview":false,"didRedirect":false}},"_sentryTraceData":"12d6406002874fc5b3d07ef59d3c84ad-97c591c693478cc9-1","_sentryBaggage":"sentry-environment=production,sentry-release=45a671e198d332b37aa8aed10a78e8aa8544f793,sentry-public_key=94d09c8eb5834eb282d762cecbbd40e6,sentry-trace_id=12d6406002874fc5b3d07ef59d3c84ad,sentry-sample_rate=1,sentry-transaction=%2Fdocs%2F%5B%5B...slug%5D%5D,sentry-sampled=true"}},"page":"/docs/[[...slug]]","query":{"slug":["gift-cards","using-gift-cards-api"]},"buildId":"45a671e198d332b37aa8aed10a78e8aa8544f793","assetPrefix":"https://dex-tech-fe-production-c.squarecdn.com/main","isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>