## Square Developer Platform Documentation ## Developer Essentials Learn about the Square Developer platform and how Square APIs and SDKs work together. ### Build basics Learn about design concepts and patterns for building applications with Square APIs. - [Authentication](https://developer.squareup.com/docs/auth): Learn about client application authentication using Square authentication APIs. - [Access Tokens](https://developer.squareup.com/docs/build-basics/access-tokens): Learn about the different Square access tokens and how to generate the correct token for your needs. - [Square API Lifecycle](https://developer.squareup.com/docs/build-basics/api-lifecycle): Learn about the Square API lifecycle and what to expect for each stage of development. - [Clear Object Fields](https://developer.squareup.com/docs/build-basics/clearing-fields): Learn how to clear Square API resource fields using a standard method for all clearable fields. - [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency): Learn about idempotency and how idempotency keys prevent negative results from accidental duplicate requests. - [Optimistic Concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency): Learn about optimistic concurrency and how it prevents lost data writes with Square APIs. - [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination): Learn how Square API endpoints use pagination to efficiently provide listing results. - [Working with Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses): Learn how the Square API model works with address information. - [Working with Dates](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates): Learn about how Square APIs model date information. - [ Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts): Learn how the Square API model works with monetary amounts. - [Frontend and Backend Development](https://developer.squareup.com/docs/build-basics/frontend-backend-development): Learn about the frontend-backend model for server-side development. - [Collecting Information](https://developer.squareup.com/docs/build-basics/general-considerations/collecting-information): If you collect, or plan to collect, personal information from users, it's critical that you handle that information responsibly. - [Handling Errors](https://developer.squareup.com/docs/build-basics/general-considerations/handling-errors): Improve your user experience by handling error information from Square APIs and SDKs. - [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences): Explains language preferences for applications to communicates with Square sellers and buyers, available options, and related guidance. - [TLS and HTTPS](https://developer.squareup.com/docs/build-basics/general-considerations/tls-and-https): Learn about the relationship between TLS and HTTPS. - [Using the REST API](https://developer.squareup.com/docs/build-basics/general-considerations/using-rest-api): Learn how to use the Square API (REST). You manage the resources of a Square account by making HTTPS requests to URLs that represent those resources. - [Versioning](https://developer.squareup.com/docs/build-basics/versioning-overview): Learn about the Square versioning process and how it works with breaking changes. ### Developer tools Learn about the various tools that Square provides for developers who are creating applications that use the Square APIs. - [Dev essentials](https://developer.squareup.com/docs/development-essentials): The Square Developer platform provides a collection tools, APIs, and SDKs for developing applications. - [Overview](https://developer.squareup.com/docs/development-essentials): The Square Developer platform provides a collection tools, APIs, and SDKs for developing applications. - [API Explorer](https://developer.squareup.com/docs/devtools/api-explorer): Learn about API Explorer features and how to use API Explorer to test Square APIs. - [API Logs](https://developer.squareup.com/docs/devtools/api-logs): Learn about the Square API Logs feature, which lets you view the request and response of API calls. - [Custom Attributes](https://developer.squareup.com/docs/devtools/customattributes/overview): An overview of custom attributes, which are a lightweight way to include additional properties in the Square data model. - [Developer Console](https://developer.squareup.com/docs/devtools/developer-dashboard): Use the Developer Dashboard to manage your applications, permissions, and authorizations. - [Build a Developer Team](https://developer.squareup.com/docs/devtools/developer-permissions): Learn how to add a developer to your Square development team and give them the right set of permissions. - [GraphQL](https://developer.squareup.com/docs/devtools/graphql): Learn how Square GraphQL queries can be used retrieve specific fields from orders, catalogs, customers, and other Square objects. - [GraphQL Explorer](https://developer.squareup.com/docs/devtools/graphqlexplorer): Describes Square GraphQL Explorer features and user interface, including setup steps and an overview of the schema. - [Postman](https://developer.squareup.com/docs/devtools/postman): You can use Postman to test API calls multiple times without having to write code or install Square SDKs. - [Test in the Sandbox](https://developer.squareup.com/docs/devtools/sandbox/overview): An overview of the Square Sandbox, which can be used to simulate orders, invoices, payments, and transactions in a test environment. - [Sandbox Payments](https://developer.squareup.com/docs/devtools/sandbox/payments): A quick reference of test credit card numbers and payment tokens you can use to make test payments with the Square Sandbox. - [Test in Sandbox](https://developer.squareup.com/docs/devtools/sandbox/testing): A quick reference for walkthroughs for various Square APIs that use the Sandbox for testing. - [Square Dashboard](https://developer.squareup.com/docs/devtools/seller-dashboard): Developers can use the Square Dashboard to simulate the seller experience and see the effects of their Square API calls. - [Webhook Event Logs](https://developer.squareup.com/docs/devtools/webhook-logs): Learn about webhook event logs, which show the webhook event triggered during an API call. ### Get started Create an account and make your first Square API call in minutes. - [Create an Account and App](https://developer.squareup.com/docs/get-started/create-account-and-application): Learn how to create a Square account for developers and your first application. - [Make your First API Call](https://developer.squareup.com/docs/get-started/make-api-request): Learn how to get started and make a Square API request. - [Verify the Payment](https://developer.squareup.com/docs/get-started/verify-transaction-in-seller-dashboard): Learn how to view Square transactions in the Sandbox Square Dashboard. - [Verify the Payment](https://developer.squareup.com/docs/get-started/verify-transaction-in-seller-dashboard): Learn how to view Square transactions in the Sandbox Square Dashboard. - [Verify the Payment in the Seller Dashboard](https://developer.squareup.com/docs/get-started/verify-transaction-in-seller-dashboard): Learn how to view Square transactions in the Sandbox Square Dashboard. - [Verify the Payment in the Seller Dashboard](https://developer.squareup.com/docs/get-started/verify-transaction-in-seller-dashboard): Learn how to view Square transactions in the Sandbox Square Dashboard. - [View the API Logs](https://developer.squareup.com/docs/get-started/view-log): Learn how to view a Square transaction in the Square API log. - [View the API Logs](https://developer.squareup.com/docs/get-started/view-log): Learn how to view a Square transaction in the Square API log. - [View the API Logs](https://developer.squareup.com/docs/get-started/view-log): Learn how to view a Square transaction in the Square API log. - [What's Next](https://developer.squareup.com/docs/get-started/what-next): After exploring the Get Started walkthrough, learn about areas to explore as a Square developer. - [What's Next](https://developer.squareup.com/docs/get-started/what-next): After exploring the Get Started walkthrough, learn about areas to explore as a Square developer. ### GraphQL Streamline your application flow with fewer, faster, and more compact data transfers using Square GraphQL. - [GraphQL Basics](https://developer.squareup.com/docs/graphql/basics): Learn about concepts, patterns and practices that apply when working with Square GraphQL. - [Build your First Query](https://developer.squareup.com/docs/graphql/build-your-first-query): Learn how to build a Square GraphQL query using GraphQL Explorer and the schema documentation. - [Query Examples](https://developer.squareup.com/docs/graphql/query-examples): Find example queries that show how you can use Square GraphQL for common reporting scenarios. ### Migrated from Deprecated APIs Learn about depreciated APIs and how to migrate your code to use the replacement Square APIs. - [Connect v1 Retirement](https://developer.squareup.com/docs/migrate-from-v1): Find migration information for Square APIs and Connect v1 APIs in the Square Developer platform that are scheduled for retirement. - [Deprecated Items](https://developer.squareup.com/docs/migrate-from-v1/current-status): Learn about the current status of deprecated Square APIs. - [v1 BankAccounts](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-bankaccounts): Learn how to migrate your code from the Square Connect v1 BankAccounts API to the Square API BankAccounts API - [v1 CashDrawerShifts ](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-cashdrawershifts): Learn how to migrate your code from the Connect v1 CashDrawer Shifts API to Square CashDrawer Shifts - [Migrate from CreateCheckout to CreatePaymentLink](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-checkout): Learn how to migrate an application from using the CreateCheckout endpoint to using the CreatePaymentLink endpoint. - [v1 Employees](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-employees): Learn how to migrate your application from the Connect v1 Employees API to the Square Team API - [API Guide: Migrate from v1Items](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items): Migrate from the Connect v1 Items API to the Square Catalog and Inventory APIs. - [v1 Items](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items): Migrate from the Connect v1 Items API to the Square Catalog and Inventory APIs. - [API Guide: Migrate from v1Locations](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-locations): Migrate from the Connect v1 Locations API to the Square Locations API. - [v1 Locations](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-locations): Migrate from the Connect v1 Locations API to the Square Locations API. - [v1 Payments API](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-payments): Learn how to migrate from using the deprecated V1 Payments API to using the Square Payments API. - [v1 Refunds API](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-refunds): Learn about migrating your application from the V1 Refunds API to the V2 Refunds API. - [v1 Timecards](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-timecards): Learn how to migrate your Connect V1 Timecard API code to the Square Labor API. ### OAuth Use the OAuth API to connect your application to a seller's account using OAuth. - [OAuth Best Practices](https://developer.squareup.com/docs/oauth-api/best-practices): Learn about the best practices for using the Square OAuth API to authorize your application to access a Square account. - [Create Redirect URL and Authorization Page URL](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization): The first step in the OAuth process is to create a URL that requests permissions and directs the seller to the authorization page. - [Migrate to Refreshable OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens): Learn how to migrate your Square API authentication logic to use OAuth refresh tokens. - [Migrate to the Square API OAuth Flow](https://developer.squareup.com/docs/oauth-api/migrate-to-square-oauth-flow): Describes the migration tasks that update your application to use seller-scoped OAuth tokens appropriate for calling Square API endpoints. - [Move OAuth to Production](https://developer.squareup.com/docs/oauth-api/movetoprod): A list of tasks for a developer to take to move an application from using the Square Sandbox to a production environment. - [Overview](https://developer.squareup.com/docs/oauth-api/overview): The OAuth API lets you request permissions from Square sellers to manage their resources and get access tokens to call Square APIs on their behalf. - [Receive Authorization and Manage OAuth Tokens](https://developer.squareup.com/docs/oauth-api/receive-and-manage-tokens): Shows how to create an application that receives the seller's OAuth authorization and manages the OAuth tokens. - [Refresh and Revoke OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope): Learn how to refresh, revoke, and limit the scope of OAuth tokens. - [Permissions Reference](https://developer.squareup.com/docs/oauth-api/square-permissions): Reference for all OAuth permissions (scopes) needed to call Square API endpoints with an OAuth access token. - [Token Introspection](https://developer.squareup.com/docs/oauth-api/token-introspection): Learn how to get scope details about the scope of an access token. - [Test Authorization](https://developer.squareup.com/docs/oauth-api/walkthrough): Learn how to build a Square OAuth API flow to authorize your application to access a Square account. ### Sample applications Explore samples for OAuth, Square SDK, GraphQL, and mobile. - [Sample Applications](https://developer.squareup.com/docs/sample-apps): Learn about OAuth samples, Square SDK samples, GraphQL samples, and Square mobile samples. ### Square SDKs Learn about the available Square SDKs that you can use to build solutions. - [Square SDKs](https://developer.squareup.com/docs/sdks): Summarizes the available Square APIs and SDKs that you can use to build solutions. - [.NET](https://developer.squareup.com/docs/sdks/dotnet): Use the Square .NET library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/dotnet/common-square-api-patterns): Learn how the Square .NET SDK supports the common Square API features. - [Migration Guide](https://developer.squareup.com/docs/sdks/dotnet/migration): Upgrade from the legacy version of the Square .NET SDK to version 42.0.0 or later. - [Quickstart](https://developer.squareup.com/docs/sdks/dotnet/quick-start): Learn how to quickly set up and test the Square .NET SDK. - [Quickstart](https://developer.squareup.com/docs/sdks/go/quick-start): Learn how to quickly set up and test the Square Go SDK. - [Java](https://developer.squareup.com/docs/sdks/java): Use the Square Java library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/java/common-square-api-patterns): Learn how the Square Java SDK supports the common Square API features. - [Migration Guide](https://developer.squareup.com/docs/sdks/java/migration): Upgrade from the legacy version of the Square Java SDK to version 42.0.0 or later. - [Quickstart](https://developer.squareup.com/docs/sdks/java/quick-start): Learn how to quickly set up and test the Square Java SDK. - [Node.js](https://developer.squareup.com/docs/sdks/nodejs): Use the Square Node.js library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/nodejs/common-square-api-patterns): Learn how the Square Node.js SDK supports the common Square API features. - [Migration Guide](https://developer.squareup.com/docs/sdks/nodejs/migration): Upgrade from the legacy version of the Square Node.js SDK to version 40.0.0 or later. - [Quickstart](https://developer.squareup.com/docs/sdks/nodejs/quick-start): Learn how to quickly set up and test the Square Node.js SDK. - [PHP](https://developer.squareup.com/docs/sdks/php): Use the Square PHP library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/php/common-square-api-patterns): Learn how the Square PHP SDK supports the common Square API features. - [Migration Guide](https://developer.squareup.com/docs/sdks/php/migration): Upgrade from the legacy version of the Square PHP SDK to version 41.0.0.20250220 or later. - [Quickstart](https://developer.squareup.com/docs/sdks/php/quick-start): Learn how to quickly set up and test the Square PHP SDK. - [Python](https://developer.squareup.com/docs/sdks/python): Use the Square Python library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/python/common-square-api-patterns): Learn how the Square Python SDK supports the common Square API features. - [Migration Guide](https://developer.squareup.com/docs/sdks/python/migration): Upgrade from the legacy version of the Square Python SDK to version 42.0.0 or later. - [Quickstart](https://developer.squareup.com/docs/sdks/python/quick-start): Learn how to quickly set up and test the Square Python SDK. - [Ruby](https://developer.squareup.com/docs/sdks/ruby): Use the Square Ruby library to build with Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. - [Common API Patterns](https://developer.squareup.com/docs/sdks/ruby/common-square-api-patterns): Learn how the Square Ruby SDK supports the common Square API features. - [Quickstart](https://developer.squareup.com/docs/sdks/ruby/quick-start): Learn how to quickly set up and test the Square Ruby SDK. - [Project Setup](https://developer.squareup.com/docs/sdks/ruby/setup-project): An introduction to setting up a Square Ruby SDK project. - [Using the SDK](https://developer.squareup.com/docs/sdks/ruby/using-ruby-sdk): An introduction to using the Square Ruby SDK features. ### Webhooks Learn about the Webhook Subscriptions API, which you can use to programmatically subscribe to webhooks. - [Events](https://developer.squareup.com/docs/events-api/overview): Learn how the Events API can be used to search for and retrieve Square API events. - [MCP Server](https://developer.squareup.com/docs/mcp): Learn about the Square MCP server, which implements the MCP standard and provides a bridge between AI assistants and the Square REST API platform. - [Move Event Notifications to Production](https://developer.squareup.com/docs/webhooks/movetoprod): A list of tasks for developers to take to move an application that uses webhooks from Sandbox testing to a production environment. - [Webhooks Overview](https://developer.squareup.com/docs/webhooks/overview): Square webhooks let developers receive real-time notifications of events, such as inventory changes and point of sale payments. - [Create a Notification URL](https://developer.squareup.com/docs/webhooks/step1createurl): The first step to create Square webhooks is to create a notification URL that receives and processes the webhook event information. - [Subscribe to Event Notifications](https://developer.squareup.com/docs/webhooks/step2subscribe): The second step to create Square webhooks is to subscribe to the events you want to monitor. - [Verify and Validate an Event Notification](https://developer.squareup.com/docs/webhooks/step3validate): The third step to creating Square webhooks is to have your application verify the event notification and validate the data included. - [Manage Operations](https://developer.squareup.com/docs/webhooks/step4manage): The final step to creating Square webhooks is to have your application safely process and store the event information. - [Troubleshooting](https://developer.squareup.com/docs/webhooks/troubleshooting): Common issues developers encounter when implementing Square webhooks. - [Webhook Events Reference](https://developer.squareup.com/docs/webhooks/v2webhook-events-tech-ref): Shows all the V2 webhooks for Square API endpoints. - [Webhook Subscriptions](https://developer.squareup.com/docs/webhooks/webhook-subscriptions-api): An introduction to the Webhook Subscriptions API, which you can use to programmatically subscribe to webhooks. - [Webhook Subscriptions](https://developer.squareup.com/docs/webhooks/webhook-subscriptions-api): An introduction to the Webhook Subscriptions API, which you can use to programmatically subscribe to webhooks. ## Payments The Square Developer platform provides payment APIs and SDKs to add Square payments to your application. Whether buyers are paying on Square hardware or online, you can charge for a simple currency amount or a more complex order using Square-supported payment methods. ### Payments APIs Learn about the Payments API and how it is used to create and manage payments. - [Refund a Payment with an App Fee](https://developer.squareup.com/docs/payments-api/collect-fees/payment-with-app-fee-refund): Learn about refunding payments that include application fees using the Refunds API. - [Troubleshoot](https://developer.squareup.com/docs/payments-api/error-codes): Learn about the error codes returned by the Payments API. - [Square Transactions API](https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api): Learn how to move from processing payments with the Transactions API to using the Square Payments API. Also, learn how to access old transactions. - [Refund Payments](https://developer.squareup.com/docs/payments-api/refund-payments): Learn how to process refunds with the Square Refunds API. - [Retrieve Payments](https://developer.squareup.com/docs/payments-api/retrieve-payments): Learn how to retrieve payments using the Payments API. - [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments): You can use the Payments API CreatePayment endpoint to direct Square to take payments and record payments processed outside of Square. - [Collect Application Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees): Learn how to collect an application fee when processing payments using the Square Payments API. - [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees): Learn how to collect an application fee when processing payments using the Square Payments API. - [ACH Bank Transfer Payment](https://developer.squareup.com/docs/payments-api/take-payments/ach-payments): Learn how to take ACH bank transfer payments using the Square Payments API. - [Afterpay and Clearpay Payments](https://developer.squareup.com/docs/payments-api/take-payments/afterpay-payments): Learn how the Payments API processes Afterpay payments for buy now, pay later items. - [Card Payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments): Learn how to provide cards (credit, debit, and square gift card) as a payment source in a Payments API CreatePayment request. - [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture): Learn how to obtain payment authorization when using a credit card as a payment source in a CreatePayment request. - [Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards): Learn how partial payments work when a gift card is a payment source in a CreatePayment request. - [Statement Descriptions](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/statement-descriptions): Learn what Square does with statement description identifiers in constructing statement descriptions that it sends to banks. - [Cash App Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-app-payments): Learn how to use the Square Payments API (CreatePayment endpoint) to charge Cash App. - [Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments): Record cash payments using the Square Payments API. - [External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments): Learn how to use the Square Payments API to record external payments. - [House Accounts](https://developer.squareup.com/docs/payments-api/take-payments/house-accounts): Learn how to work with house accounts using the Square Payments API. - [Update Payment and Tip Amounts](https://developer.squareup.com/docs/payments-api/update-payments): Learn how to update a payment created using the Payments API. - [Webhooks](https://developer.squareup.com/docs/payments-api/webhooks): Learn about the Square webhook notifications supported by the Payments API. - [Overview](https://developer.squareup.com/docs/payments-overview): Process online, in-app, and in-person payments with Square payment APIs. Manage disputes and subscriptions and perform other payment-related tasks. - [Payments Pricing](https://developer.squareup.com/docs/payments-pricing): Learn about the processing fees that Square charges for payments made with Square payment APIs. ### Refund API Use the Refunds API to refund a payment processed by Square. - [Retrieve Refunds](https://developer.squareup.com/docs/refunds-api/retrieve-refunds): Use the Refunds API to retrieve funds regardless of the payment source or what the seller used to process a payment. - [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds): Learn how to process unlinked refunds with Refunds API. - [Webhooks](https://developer.squareup.com/docs/refunds-api/webhooks): Learn how to use Square webhooks to get notifications of refund updates. ### Disputes API Learn how to use the Disputes API to processing payment disputes. - [Overview](https://developer.squareup.com/docs/disputes-api/overview): An introduction to processing disputes using the Square Disputes API. - [Process Disputes](https://developer.squareup.com/docs/disputes-api/process-disputes): Learn how to process disputes using the Square Disputes API. - [Test in the Sandbox](https://developer.squareup.com/docs/disputes-api/sandbox-testing): Learn how to test the Disputes API in the Square Sandbox. ### Take payments on hardware Learn about Square hardware solutions, explore use cases for in-person payments, and identify the APIs and SDKs that best suit your development goals and application requirements. - [Build with Mobile Authorization](https://developer.squareup.com/docs/mobile-authz/build-with-mobile-authz): Build with the Mobile Authorization API to request authorization tokens to initialize Square mobile solutions like the Reader SDK. - [Get Authorization Code on Command Line](https://developer.squareup.com/docs/mobile-authz/cookbook/mobile-code-with-curl): Request authorization tokens with a command-line tool to initialize Square mobile solutions like the Reader SDK. - [How It Works](https://developer.squareup.com/docs/mobile-authz/how-it-works): Use the Mobile Authorization API to request authorization tokens to initialize Square mobile solutions like the Reader SDK. - [Mobile Authorization](https://developer.squareup.com/docs/mobile-authz/what-it-does): Get an overview of the Square Mobile Authorization API for solutions like the Reader SDK. - [Mobile Authorization API](https://developer.squareup.com/docs/mobile-authz/what-it-does): Get an overview of the Square Mobile Authorization API for solutions like the Reader SDK. - [What It Does](https://developer.squareup.com/docs/mobile-authz/what-it-does): Get an overview of the Square Mobile Authorization API for solutions like the Reader SDK. - [Authorize the Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk/android/configure-authorize): Learn how to configure and authorize your Mobile Payments SDK Android application. - [Handling Errors](https://developer.squareup.com/docs/mobile-payments-sdk/android/handling-errors): Learn how to handling errors in the Mobile Payments SDK for Android. - [Offline Payments](https://developer.squareup.com/docs/mobile-payments-sdk/android/offline-payments): Learn how to take offline payments with the Mobile Payments SDK for Android. - [Pair and Manage Card Readers](https://developer.squareup.com/docs/mobile-payments-sdk/android/pair-manage-readers): Learn how to pair and manage card readers with the Mobile Payments SDK for Android. - [Take a Payment](https://developer.squareup.com/docs/mobile-payments-sdk/android/take-payments): Learn how to take payments with the Mobile Payments SDK for Android. - [Tap to Pay on Android](https://developer.squareup.com/docs/mobile-payments-sdk/android/tap-to-pay): Use Tap to Pay on Android to accept payments with your own device, without the need for Square hardware. - [Flutter Plugin](https://developer.squareup.com/docs/mobile-payments-sdk/flutter): The Flutter plugin for the Square Mobile Payments SDK is an open source Dart interface for calling native Mobile Payments SDK implementations. - [Authorize the Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk/ios/configure-authorize): Learn how to configure and authorize your Mobile Payments SDK iOS application. - [Handling Errors](https://developer.squareup.com/docs/mobile-payments-sdk/ios/handling-errors): Learn how to resolve errors in the Mobile Payments SDK for iOS. - [Offline Payments](https://developer.squareup.com/docs/mobile-payments-sdk/ios/offline-payments): Learn how to take payments offline with the Mobile Payments SDK for iOS. - [Pair and Manage Card Readers](https://developer.squareup.com/docs/mobile-payments-sdk/ios/pair-manage-readers): Learn how to pair and manage card readers with the Mobile Payments SDK for iOS. - [Configure for Square Stand or Square Kiosk](https://developer.squareup.com/docs/mobile-payments-sdk/ios/square-stand): Configure the Mobile Payments SDK on iOS to use Square Stand or Square Kiosk to take card payments. - [Take a Payment](https://developer.squareup.com/docs/mobile-payments-sdk/ios/take-payments): Learn how to use the Mobile Payments SDK for iOS to take a payment with a Square Reader or Square Stand. - [Tap to Pay on iPhone](https://developer.squareup.com/docs/mobile-payments-sdk/ios/tap-to-pay): Use Tap to Pay on iPhone to accept payments with your own device, without the need for Square hardware. - [Migrate from Reader SDK](https://developer.squareup.com/docs/mobile-payments-sdk/migrate): Learn how to migrate applications from the Reader SDK to use the Mobile Payments SDK. - [Migrate to Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk/migrate): Learn how to migrate applications from the Reader SDK to use the Mobile Payments SDK. - [React Native Plugin](https://developer.squareup.com/docs/mobile-payments-sdk/react-native): The React Native plugin for the Square Mobile Payments SDK is an open source JavaScript interface for calling native Mobile Payments SDK implementations. - [Online Payment Options](https://developer.squareup.com/docs/online-payment-options): Learn about Square online payment solutions, identify APIs and SDKs that best suit your development goals, and build a payment integration. - [Build on Mobile Web](https://developer.squareup.com/docs/pos-api/build-mobile-web): Open the Square Point of Sale application from a custom mobile web application to process in-person payments using Square hardware. - [Build on Mobile Web](https://developer.squareup.com/docs/pos-api/build-mobile-web): Open the Square Point of Sale application from a custom mobile web application to process in-person payments using Square hardware. - [Build on Android](https://developer.squareup.com/docs/pos-api/build-on-android): Open the Square Point of Sale application from your mobile Android application to process in-person payments using Square hardware. - [Build on Android](https://developer.squareup.com/docs/pos-api/build-on-android): Open the Square Point of Sale application from your mobile Android application to process in-person payments using Square hardware. - [Build on iOS](https://developer.squareup.com/docs/pos-api/build-on-ios): Take payments in a custom iOS application by calling the Square Point of Sale application. - [Build with iOS](https://developer.squareup.com/docs/pos-api/build-on-ios): Take payments in a custom iOS application by calling the Square Point of Sale application. - [Add an Alert Dialog Helper Class](https://developer.squareup.com/docs/pos-api/cookbook/alert-dialog-helper): Learn how to add an alert dialog helper class. Before you start, get a reference to the Activity that is hosting the Point of Sale user interface. - [Accept E-Money Payments](https://developer.squareup.com/docs/pos-api/cookbook/electronic-payments): Learn about taking electronic payments in supported countries using the Square Point of Sale API. - [Find Your Android Fingerprint](https://developer.squareup.com/docs/pos-api/cookbook/find-your-android-fingerprint): Find the debug and release fingerprints of your Android application to configure the Point of Sale API application. - [Use the API in Offline Mode](https://developer.squareup.com/docs/pos-api/cookbook/offline-mode): The Point of Sale API supports payment processing with the Square Point of Sale application in Offline Mode. - [How It Works](https://developer.squareup.com/docs/pos-api/how-it-works): You can use the Point of Sale API to build custom POS solutions that requires payments, without worrying about hardware integrations or PCI compliance. - [Payments API Integration](https://developer.squareup.com/docs/pos-api/payments-integration): Learn how to get payment details from a Point of Sale API transaction ID. - [Accept PayPay Payments](https://developer.squareup.com/docs/pos-api/qr-code-payments-paypay): Learn how to set up PayPay QR code payments with the Point of Sale API. - [Mobile Web Technical Reference](https://developer.squareup.com/docs/pos-api/web-technical-reference): Technical Reference for mobile web integrations with the Square Point of Sale API. - [Point of Sale API](https://developer.squareup.com/docs/pos-api/what-it-does): The Point of Sale API lets mobile applications open the Square Point of Sale application to process in-person payments using Square hardware. - [What It Does](https://developer.squareup.com/docs/pos-api/what-it-does): The Point of Sale API lets mobile applications open the Square Point of Sale application to process in-person payments using Square hardware. - [Build on Android](https://developer.squareup.com/docs/reader-sdk/build-on-android): Build a secure in-person payment solution for Android devices with the Reader SDK. - [Build on iOS](https://developer.squareup.com/docs/reader-sdk/build-on-ios): Build with the Reader SDK on iOS to process in-person payments with Square hardware. - [Capture a Transaction](https://developer.squareup.com/docs/reader-sdk/cookbook/capture-a-transaction): Complete a delayed transaction by capturing all authorized card payments. - [Charge a Card on File](https://developer.squareup.com/docs/reader-sdk/cookbook/charge-cards-on-file): Create a seamless purchase experience for returning customers and enable recurring payments. - [Configure APK Splits](https://developer.squareup.com/docs/reader-sdk/cookbook/configure-apk-splits): Configure your Reader SDK project to generate multiple APK files for different application binary interfaces (ABIs). - [Connect a Contactless Reader](https://developer.squareup.com/docs/reader-sdk/cookbook/contactless-reader): Connect the Reader SDK to a Square Contactless Reader to accept chip and tap payments. - [Deauthorize Reader SDK](https://developer.squareup.com/docs/reader-sdk/cookbook/deauthorize-reader-sdk): Learn how to deauthorize the current Square account location in a Reader SDK application. - [Delay the Capture of Payments](https://developer.squareup.com/docs/reader-sdk/cookbook/delay-capture-of-payment): Delay the capture of payments authorized by a Reader SDK application. - [Save a Card on File](https://developer.squareup.com/docs/reader-sdk/cookbook/save-cards-on-file): Use the Reader SDK card on file workflow to create a customer card for an existing Customer object. - [Configure on iOS for Square Stand](https://developer.squareup.com/docs/reader-sdk/cookbook/square-stand): Configure the Reader SDK on iOS to use Square Stand to swipe payments and to connect a Contactless and Chip Reader using USB. - [Flutter Plugin](https://developer.squareup.com/docs/reader-sdk/flutter): The Flutter plugin for Reader SDK is an open source project that provides a Dart interface for calling the native Reader SDK implementations. - [How It Works](https://developer.squareup.com/docs/reader-sdk/how-it-works): Learn about the Reader SDK process flow and checkout flow and how they work. - [Reader SDK Quick Start](https://developer.squareup.com/docs/reader-sdk/quick-start/start): Start taking cash and credit card payments with the Android and iOS Reader SDK sample application. - [Start](https://developer.squareup.com/docs/reader-sdk/quick-start/start): Start taking cash and credit card payments with the Android and iOS Reader SDK sample application. - [Get Credentials](https://developer.squareup.com/docs/reader-sdk/quick-start/step-1): Get credentials for the Reader SDK before configuring the Reader SDK sample application. - [Configure the Sample Application](https://developer.squareup.com/docs/reader-sdk/quick-start/step-2): Download the Reader SDK sample application from GitHub and configure the sample application for your environment. - [Take a Cash Payment](https://developer.squareup.com/docs/reader-sdk/quick-start/step-3): Take a cash payment using the Reader SDK. The Reader SDK must be authorized to collect payments. - [Customize the Checkout Amount](https://developer.squareup.com/docs/reader-sdk/quick-start/step-4): Customize a checkout amount using the Reader SDK. Before trying a credit card transaction, update the sample code to change the checkout amount. - [Take a Credit Card Payment](https://developer.squareup.com/docs/reader-sdk/quick-start/step-5): Connect a Square Reader and complete a credit card transaction. - [React Native Plugin](https://developer.squareup.com/docs/reader-sdk/react-native): The React Native plugin for Reader SDK is an open source project that provides a JavaScript interface for calling the native Reader SDK implementations. - [Update to New Reader SDK Version](https://developer.squareup.com/docs/reader-sdk/upgrade-reader-sdk): Learn how to upgrade your project for the latest version of the Reader SDK. - [Learn more about Reader SDK](https://developer.squareup.com/docs/reader-sdk/what-it-does): Learn more about processing payments with the Square Reader SDK. - [Reader SDK](https://developer.squareup.com/docs/reader-sdk/what-it-does): Learn more about processing payments with the Square Reader SDK. - [What It Does](https://developer.squareup.com/docs/reader-sdk/what-it-does): Learn more about processing payments with the Square Reader SDK. - [Add Payment and Checkout Features](https://developer.squareup.com/docs/terminal-api/additional-payment-checkout-features): Learn how to modify a Terminal checkout to accept other types of payments and enable additional checkout features. - [Manage Terminal Actions](https://developer.squareup.com/docs/terminal-api/advanced-features): Use the Terminal API's Terminal Actions endpoint to customize buyer workflows, save cards on file, check a device status, and perform other tasks. - [Check Device Information](https://developer.squareup.com/docs/terminal-api/advanced-features/check-device-information): Learn how to check device information for a Square Terminal. - [Confirmation Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/confirmation): Display a confirmation screen and ask for a buyer's input on the Square Terminal. - [Data Collection Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/data-collection): Display a screen that collects a buyer's contact information on the Square Terminal. - [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions): Learn how to link multiple screens for data input and dismiss Terminal actions on the Square Terminal. - [Menu Selection List Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/menu-select): Display a menu of options for a buyer to select on the Square Terminal. - [QR Code Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/qr-code-display): Display a QR code for a buyer to scan on the Square Terminal. - [Signature Capture Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/signature): Display a confirmation screen that captures a buyer's signature on the Square Terminal. - [Customize the Idle Screen](https://developer.squareup.com/docs/terminal-api/advanced-features/customize-idle-screen): Customize the Square Terminal idle screen to display the seller's brand and convey visual information to buyers. - [Print or Issue Receipts](https://developer.squareup.com/docs/terminal-api/advanced-features/issue-receipts): Use the Square Terminal and a POS application to print or issue receipts for cash payments and previous transactions. - [Save Card on File](https://developer.squareup.com/docs/terminal-api/advanced-features/save-card-on-file): Learn how to use the Terminal API to save a customer's card for making future purchases. - [Dismiss Terminal Checkouts and Refunds](https://developer.squareup.com/docs/terminal-api/dismiss-checkouts-and-refunds): Learn how to dismiss pending checkouts and refunds using the Terminal API. - [Take E-Money Payments](https://developer.squareup.com/docs/terminal-api/e-money-payments): Use the Square Terminal and Terminal API to take E-Money payments in regions where E-Money is available. - [Connect a Square Terminal](https://developer.squareup.com/docs/terminal-api/integrate-square-terminal): Learn how to integrate a custom POS application with a Square Terminal to take payments through a Terminal checkout. - [Take QR Code Payments for Digital Wallets](https://developer.squareup.com/docs/terminal-api/international-payment-methods/paypay-qr-code-payments): Learn how to set up QR code payments for multiple digital wallet brands in Japan with the Terminal API. - [Overview](https://developer.squareup.com/docs/terminal-api/overview): Learn how the Terminal API integrates a POS application with the Square Terminal. - [POS App Pairing](https://developer.squareup.com/docs/terminal-api/pos-integration): Learn how the Square Terminal and a POS application operate together as a paired system. - [Quickstart](https://developer.squareup.com/docs/terminal-api/quickstart): Learn how to connect and set up a Square Terminal with the Terminal API. - [Take One-Off Payments](https://developer.squareup.com/docs/terminal-api/square-terminal-payments): Learn how to take a one-off payment with the Square Terminal API and Square Terminal. - [Refund Interac Payments](https://developer.squareup.com/docs/terminal-api/square-terminal-refunds): Learn how to refund a payment using a Square Terminal and the Terminal API. - [Take Payments for Orders](https://developer.squareup.com/docs/terminal-api/take-payments-for-orders): Learn how to take payments for orders with the Terminal API and Square Terminal. - [Monitor Square Terminals](https://developer.squareup.com/docs/terminal-api/terminal-device-monitoring): Learn how to use the Devices API to monitor Square Terminals. ### Take payments online Learn about Square online payment solutions, explore online payment use cases, and identify the APIs and SDKs that best suit your development goals and requirements to build a payment gateway integration. - [Checkout Settings](https://developer.squareup.com/docs/checkout-api/checkout-settings): Learn how to access and modify checkout settings for payment links created using the Checkout API. - [Guidelines and Limitations](https://developer.squareup.com/docs/checkout-api/guidelines-and-limitations): Learn about Square Checkout API guidelines and limitations. - [Manage Checkout](https://developer.squareup.com/docs/checkout-api/manage-checkout): Learn how to manage checkout links. The Checkout API provides endpoints to manage the checkout pages you created. - [Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations): Learn how to specify optional checkout configurations. - [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout): Learn how to create a Square-hosted quick pay checkout page by only specifying the name and price (without having to specify the Order object). - [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout): Learn how to create a checkout for a Square order. - [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout): Learn how to create a quick pay checkout for a subscription plan. - [Apple Pay](https://developer.squareup.com/docs/in-app-payments-sdk/add-digital-wallets/apple-pay): Enable Apple Pay for the Square In-App Payments SDK. - [Google Pay](https://developer.squareup.com/docs/in-app-payments-sdk/add-digital-wallets/google-pay): Enable Google Pay for the Square In-App Payments SDK. - [Build on Android](https://developer.squareup.com/docs/in-app-payments-sdk/build-on-android): Build a secure payment client for Android devices with the In-App Payments SDK. - [Build on iOS](https://developer.squareup.com/docs/in-app-payments-sdk/build-on-ios): Build a secure payment client for iOS devices with the In-App Payments SDK. - [Connect to a Backend Service](https://developer.squareup.com/docs/in-app-payments-sdk/cookbook/connect-to-a-backend-service): Learn how to connect a mobile application to a backend service. - [Customize the Payment Entry Form](https://developer.squareup.com/docs/in-app-payments-sdk/cookbook/customize-payment-form): Configure the In-App Payments SDK payment screen to seamlessly match the branding of your application. - [Remove the Postal Code Requirement](https://developer.squareup.com/docs/in-app-payments-sdk/cookbook/disable-postal-code): Remove the postal code requirement from the In-App Payments SDK card entry form. - [Gift Card Payments](https://developer.squareup.com/docs/in-app-payments-sdk/cookbook/giftcards): Learn how to support Square gift card payments with the In-App Payments SDK. - [Flutter Plugin](https://developer.squareup.com/docs/in-app-payments-sdk/flutter): The Flutter plugin is an open source project that provides a Dart interface for calling native In-App Payments SDK implementations. - [How It Works](https://developer.squareup.com/docs/in-app-payments-sdk/how-it-works): Learn about processing mobile payments with the Square In-App Payments SDK. - [Install the SDK](https://developer.squareup.com/docs/in-app-payments-sdk/installation): Learn how to add the In-App-Payments SDK to your mobile development environment. - [Deploy the Server](https://developer.squareup.com/docs/in-app-payments-sdk/quick-start/deploy-server-backend): Configure a test server for the Square In-App Payments SDK Quickstart. - [Set up the Client](https://developer.squareup.com/docs/in-app-payments-sdk/quick-start/generate-token): Configure a Quickstart example client that embeds the In-App Payments SDK. - [React Native Plugin](https://developer.squareup.com/docs/in-app-payments-sdk/react-native): The React Native plugin is an open source project that provides a JavaScript interface for calling native In-App Payments SDK implementations. - [In-App Payments SDK](https://developer.squareup.com/docs/in-app-payments-sdk/troubleshooting): Troubleshoot problems with the Square In-App Payments SDK. - [Troubleshoot](https://developer.squareup.com/docs/in-app-payments-sdk/troubleshooting): Troubleshoot problems with the Square In-App Payments SDK. - [Verify a Buyer](https://developer.squareup.com/docs/in-app-payments-sdk/verify-buyer): Learn how to start an SCA buyer verification, get the resulting verification token, and use that token to complete a payment with the Square Payments API. - [In-App Payments SDK](https://developer.squareup.com/docs/in-app-payments-sdk/what-it-does): The In-App Payments SDK provides secure managed payment handling for in-app purchases on mobile devices. - [Learn more about In-App Payments SDK](https://developer.squareup.com/docs/in-app-payments-sdk/what-it-does): The In-App Payments SDK provides secure managed payment handling for in-app purchases on mobile devices. - [What It Does](https://developer.squareup.com/docs/in-app-payments-sdk/what-it-does): The In-App Payments SDK provides secure managed payment handling for in-app purchases on mobile devices. - [Localize an Application ](https://developer.squareup.com/docs/in-app-payments/localize-ios): Learn how to localize an In-App Payments application for Android or iOS. - [In-Person Payment Options](https://developer.squareup.com/docs/in-person-payment-options): Use Square's in-person payment solutions to process payments and build payment integrations with the seller's POS application. - [Create or Delete Invoice Attachments](https://developer.squareup.com/docs/invoices-api/attachments): Learn how to use the Invoices API to attach an image or PDF file to a Square invoice, delete an invoice attachment, or retrieve attachment metadata. - [Cancel or Delete Invoices](https://developer.squareup.com/docs/invoices-api/cancel-delete-invoices): Learn how to use the CancelInvoice and DeleteInvoice endpoints in the Square Invoices API to cancel a published invoice or delete a draft invoice. - [Create and Publish Invoices](https://developer.squareup.com/docs/invoices-api/create-publish-invoices): Learn how to use the CreateInvoice and PublishInvoice endpoints in the Square Invoices API to configure, create, and publish invoices. - [Pay or Refund Invoices](https://developer.squareup.com/docs/invoices-api/pay-refund-invoices): Learn how Square handles invoice payments and how to retrieve and refund an invoice payment. - [Retrieve, List, or Search Invoices](https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices): Learn how to use the GetInvoice, ListInvoices, and SearchInvoices endpoints in the Square Invoices API to retrieve or search for invoices. - [Update Invoices](https://developer.squareup.com/docs/invoices-api/update-invoices): Learn how to use the UpdateInvoice endpoint in the Square Invoices API to update invoice settings. - [Walkthrough: Create and Publish Invoices](https://developer.squareup.com/docs/invoices-api/walkthrough): Learn how to use the Invoices API to send an invoice to a customer and to automatically charge a card on file. - [Subscription Actions and Events](https://developer.squareup.com/docs/subscriptions-api/actions-events): Learn how to track Square subscriptions with actions and events. - [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions): Learn how to create and manage subscriptions with the Subscriptions API. - [Manage Subscriptions ](https://developer.squareup.com/docs/subscriptions-api/overview): Learn about using the Square Subscriptions API to create and manage subscriptions in a subscription plan. - [Pause, Resume, or Cancel Subscriptions](https://developer.squareup.com/docs/subscriptions-api/pause-resume-cancel-subscriptions): Learn how to pause, resume, or cancel a subscription using the Subscriptions API. - [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations): Learn how to set up Square subscription plans and plan variations using the Catalog API. - [Set up Subscriptions Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan): Learn how to set up Square subscription plans and plan variations using the Catalog API. - [Subscription Billing and Invoices](https://developer.squareup.com/docs/subscriptions-api/subscription-billing): Learn about subscription billing and how Square invoices are used in the Subscriptions API. - [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations): Learn how to swap plan variations in a subscription using the Subscriptions API. - [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough): Learn about using the Square Subscriptions API to create and manage subscriptions in a subscription plan. - [ACH Bank Transfer](https://developer.squareup.com/docs/web-payments/add-ach): Learn how to take ACH bank transfer payments in a web client with the Web Payments SDK. - [Afterpay](https://developer.squareup.com/docs/web-payments/add-afterpay): Learn how to add an Afterpay and Clearpay payment method to an application. - [Cash App Pay](https://developer.squareup.com/docs/web-payments/add-cash-app-pay): Learn how to add Cash App Pay as a payment method to an application. - [Apple Pay](https://developer.squareup.com/docs/web-payments/apple-pay): Learn how to take Apple Pay payments in a web client with the Web Payments SDK. - [Charge and Store Cards](https://developer.squareup.com/docs/web-payments/charge-and-store-cards): Learn how to use the Web Payments SDK to charge a card and store card details for future online payments with a card on file. - [Add a Content Security Policy](https://developer.squareup.com/docs/web-payments/content-security-policy): Learn how to add a content security policy to your application that takes payments with Web Payments SDK. - [Customize the Card Entry Form](https://developer.squareup.com/docs/web-payments/customize-styles): Learn how to apply custom styles to the Web Payments SDK card payment form. - [Gift Card Payments](https://developer.squareup.com/docs/web-payments/gift-card): Learn how to take gift card payments in a web client with the Web Payments SDK. - [Take a Gift Card Payment](https://developer.squareup.com/docs/web-payments/gift-card): Learn how to take gift card payments in a web client with the Web Payments SDK. - [Take Partial Payments](https://developer.squareup.com/docs/web-payments/gift-card-walkthrough): Learn how to handle Square gift card payments with the Web Payments SDK and other APIs. - [Google Pay](https://developer.squareup.com/docs/web-payments/google-pay): Learn how to take Google Pay payments in a web client with the Web Payments SDK. - [Digital Wallet Payment Requests](https://developer.squareup.com/docs/web-payments/payment-requests): Learn how to create a digital wallet payment request and handle digital wallet events with the Web Payments SDK. - [Add Strong Customer Authentication](https://developer.squareup.com/docs/web-payments/quickstart/add-sca): Learn how to add Strong Customer Authentication to the Web Payments SDK quickstart project. - [Add the SDK to the Web Client](https://developer.squareup.com/docs/web-payments/quickstart/add-sdk-to-web-client): Learn how to add the Web Payments SDK to the web client. - [Deploy the Application](https://developer.squareup.com/docs/web-payments/quickstart/deploy-app): Learn how to deploy the application with the Web Payments SDK quickstart project. - [Set Up the Web Client App](https://developer.squareup.com/docs/web-payments/quickstart/set-up-web-client-app): Learn how to set up a web client application with the Web Payments SDK quickstart sample project. - [Charge and Store a Card on File](https://developer.squareup.com/docs/web-payments/sca-charge-and-store-card-on-file): Learn how to use the Web Payments SDK to charge a card and store card details for future online payments with a card on file. - [Take a Card Payment](https://developer.squareup.com/docs/web-payments/take-card-payment): Learn how to take card payments in a web client with the Web Payments SDK. ### Other Payment topics Additional topics covering bank accounts, cards on file, payment methods and payment pricing - [Bank Accounts](https://developer.squareup.com/docs/bank-accounts-api): Learn how to use the Bank Accounts API to retrieve information about an external bank account linked to a Square account. - [Manage Card Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines): Learn about Square features and guidance that can help reduce and manage card-on-file declines. - [Manage Cards](https://developer.squareup.com/docs/cards-api/manage-cards): The Cards API provides a set of endpoints for you to manage cards on file. You can retrieve card information, list cards on file, and disable a card. - [Create a Card on File and Make a Payment](https://developer.squareup.com/docs/cards-api/walkthrough-seller-card): This procedure is used when your Square account is a seller account and your application uses only a seller account access token. - [Create a Shared Card on File and Make a Payment](https://developer.squareup.com/docs/cards-api/walkthrough-shared-card): Store a card on file in your Square developer account and make payments with the card in other Square seller accounts. - [Create a Card on File from Payment ID](https://developer.squareup.com/docs/cards-api/walkthrough/card-from-payment-id): Learn how to create a new card on file in a Square account using a payment ID as a source. - [Compliance with Japan's Tax Invoice System](https://developer.squareup.com/docs/international-development/japan-invoice-system): Learn how to build with Square to be compliant with Japan's tax invoice preservation system. - [Payment Methods by Country](https://developer.squareup.com/docs/payment-card-support-by-country): Learn about Square support for payment card brands by country for card-not-present and card-present payments. - [Payment Minimums](https://developer.squareup.com/docs/payment-minimums): Learn about the minimum payment amounts required for any Square payment related API. - [Build a Sales Report](https://developer.squareup.com/docs/payments/scenarios/simple-sales-report): The Sales Report sample application shows how to build a report that details all the items sold between two dates. - [Split an Online Payment](https://developer.squareup.com/docs/payments/scenarios/split-online-payment): Learn how to build an application that supports splitting multiple online payments. - [Build a Tip Report](https://developer.squareup.com/docs/payments/scenarios/tip-reporting): Learn how to create tip reports and manage tip compensation for a seller's staff. - [Get Payout](https://developer.squareup.com/docs/payouts-api/get-payout): The GetPayout endpoint provides details about a specific payout. You need to pass the payout ID as an argument to this endpoint. - [List Payout Entries](https://developer.squareup.com/docs/payouts-api/list-payout-entries): The ListPayoutEntries endpoint provides a list of payout entries associated with a specific payout. - [List Payouts](https://developer.squareup.com/docs/payouts-api/list-payouts): The ListPayouts endpoint provides a list of payouts for a location. If you don't specify a location, the main or default location is used. - [Strong Customer Authentication](https://developer.squareup.com/docs/sca-overview): Learn about Strong Customer Authentication (SCA) and 3D Secure (3DS) to verify buyers for online and in-app payments. - [SCA Overview](https://developer.squareup.com/docs/sca-overview-iap): Use Strong Customer Authentication (SCA) to verify buyers for online and in-app payments. ## Commerce The Square Developer platform provides commerce APIs that applications can use to help sellers run their online or brick-and-mortar businesses. Sellers can use Square commerce and eCommerce APIs to process orders, manage catalogs, track inventory, book appointments, and more. - [Commerce](https://developer.squareup.com/docs/commerce): Create applications that help sellers run online or brick-and-mortar businesses with Square commerce APIs. - [Overview](https://developer.squareup.com/docs/commerce): Create applications that help sellers run online or brick-and-mortar businesses with Square commerce APIs. - [Build a Sales Report](https://developer.squareup.com/docs/commerce/scenarios/simple-sales-report): The Sales Report sample application shows how to build a report that details all the items sold between two dates. - [Split an Online Payment](https://developer.squareup.com/docs/commerce/scenarios/split-online-payment): Learn how to build an application that supports splitting multiple online payments. - [Build a Tip Report](https://developer.squareup.com/docs/commerce/scenarios/tip-reporting): Learn how to create tip reports and manage tip compensation for a seller's staff. - [Cash Drawer Shifts](https://developer.squareup.com/docs/cashdrawershift-api/reporting): Use the Square Cash Drawer Shifts API to report on cash drawer activity by seller and location. ### Orders API Learn about the Orders API and how to track and manage the lifecycle of a purchase. - [Apply Square-Defined Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-discounts): An example walkthrough showing how to apply preconfigured discounts to an order (the Orders API). - [Apply Catalog Taxes to Orders](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes): Learn how to apply preconfigured taxes to an order using the Orders API. - [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders): Learn how to create an order, add line items, and track fulfillment. - [Order Discounts](https://developer.squareup.com/docs/orders-api/discounts): Learn how to apply discounts to an order using the Orders API. - [Manage Fulfillments](https://developer.squareup.com/docs/orders-api/fulfillments): Learn how to create and manage order fulfillment using the Square Orders API. - [How It Works](https://developer.squareup.com/docs/orders-api/how-it-works): Learn how the Orders API processes and returns information about purchase transactions. - [Retrieve Orders](https://developer.squareup.com/docs/orders-api/manage-orders/retrieve-orders): Learn how to use the RetrieveOrder and BatchRetrieveOrders endpoints to retrieve one or more orders. - [Search Orders](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders): Learn about searching orders, how filtering and sorting works, and about filtering orders by a time range. - [Update Orders](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders): Learn how to update orders and specify sparse objects in an update request to add, update, and delete fields. - [Metadata](https://developer.squareup.com/docs/orders-api/metadata): Use metadata to store additional information about Square API resources. - [Order-Ahead Use Case](https://developer.squareup.com/docs/orders-api/order-ahead-usecase): An example use case of how an order-ahead application can use the Orders API. - [Refunds and Exchanges](https://developer.squareup.com/docs/orders-api/order-returns-exchanges): Learn how order returns and exchanges are supported in the Square Orders API. - [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders): You can pay for your orders with the Payments API (the CreatePayment endpoint) or the Orders API (the PayOrder endpoint). - [Order-Ahead Quick Start](https://developer.squareup.com/docs/orders-api/quick-start): Use the Order-Ahead Sample Application to start taking pickup orders. - [Get Developer Credentials](https://developer.squareup.com/docs/orders-api/quick-start/step-1): Get your developer credentials and test account for the Orders API sample application. - [Configure the Sample Application](https://developer.squareup.com/docs/orders-api/quick-start/step-2): Configure the Orders API sample application with your developer credentials. - [Generate Test Catalog Items](https://developer.squareup.com/docs/orders-api/quick-start/step-3): Generate test catalog items that work with the Orders API sample application. - [Take a Pickup Order](https://developer.squareup.com/docs/orders-api/quick-start/step-4): Create and pay for a pickup order using the Orders API sample application. - [Verify a Pickup Order](https://developer.squareup.com/docs/orders-api/quick-start/step-5): Verify a pickup order generated with the Orders API sample application in the Sandbox Seller Dashboard. - [Order Service Charges](https://developer.squareup.com/docs/orders-api/service-charges): Learn how to add service charges to an order using the Orders API. - [Order Taxes](https://developer.squareup.com/docs/orders-api/taxes): Learn how to apply taxes to an order using the Orders API. - [Orders API](https://developer.squareup.com/docs/orders-api/what-it-does): Learn more about processing orders with the Square Orders API. - [What It Does](https://developer.squareup.com/docs/orders-api/what-it-does): Learn more about processing orders with the Square Orders API. - [Define Custom Attributes](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attribute-definitions): Learn how to create and manage order-related custom attribute definitions for Square sellers using the Order Custom Attributes API. - [Use Custom Attributes](https://developer.squareup.com/docs/orders-custom-attributes-api/custom-attributes): Learn how to create and manage custom attributes for Square orders using the Order Custom Attributes API. ### Catalog API Learn about creating and managing a seller's item library (also known as a catalog) with the Catalog API. - [Add Custom Attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes): Learn how to add custom attributes to your catalog objects. - [Archive Catalog Items](https://developer.squareup.com/docs/catalog-api/archive-catalog-items): Learn how to archive, unarchive, and manage catalog items. - [Add a Catalog Item](https://developer.squareup.com/docs/catalog-api/build-with-catalog): Create a simple catalog using the Square Catalog API. - [Build With Catalog](https://developer.squareup.com/docs/catalog-api/build-with-catalog): Create a simple catalog using the Square Catalog API. - [Categorize Catalog Items](https://developer.squareup.com/docs/catalog-api/categorize-catalog-items): Learn how to use the Square Catalog API to categorize items in a Square seller's catalog. - [Create Customer Group Discounts](https://developer.squareup.com/docs/catalog-api/configure-customer-group-discounts): Use a pricing rule to make customers in selected customer groups eligible to receive specified discounts to matched products. - [Automatically Apply Discounts](https://developer.squareup.com/docs/catalog-api/cookbook/auto-apply-discounts): Create pricing rules to apply discounts based on the number of products (volume), a combination of items (bundle), or a specific time period (timeframe). - [Create Bundled Discounts](https://developer.squareup.com/docs/catalog-api/cookbook/auto-apply-discounts/bundle-discounts): Create discounts that apply when customers buy a combination of items (for example, an entree and a side dish). - [Create Time-Based Discounts](https://developer.squareup.com/docs/catalog-api/cookbook/auto-apply-discounts/timeframe-discounts): Create discounts that apply during a specific active time period, such as a holiday sale. - [Create Volume Discounts](https://developer.squareup.com/docs/catalog-api/cookbook/auto-apply-discounts/volume-discounts): Create discounts based on the number of products, such as "Buy One Get One Free" or "10% Off Three or More Items". - [Upload and Attach an Image](https://developer.squareup.com/docs/catalog-api/cookbook/create-catalog-image): Learn about uploading and attaching images to your product catalog using the Catalog API. - [Configure Quick Payments](https://developer.squareup.com/docs/catalog-api/cookbook/set-quick-amounts): Learn how to add as many as three custom quick amounts to the Square Register custom amount dialog. - [Delete Catalog Objects](https://developer.squareup.com/docs/catalog-api/delete-catalog-objects): Learn how to delete a catalog object and how to retrieve it for auditing. - [Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog): When designing a product catalog, learn where to draw the line between an item, item variation, and item modifier. - [Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog): When designing a product catalog, learn where to draw the line between an item, item variation, and item modifier. - [Enable Modifiers on Items](https://developer.squareup.com/docs/catalog-api/enable-modifiers-on-items): Learn how to enable product customization with list-based and text-based modifiers. - [Use Item Options](https://developer.squareup.com/docs/catalog-api/item-options): Learn how to use item options to simplify the process of creating standard variants for catalog items. - [Manage Images](https://developer.squareup.com/docs/catalog-api/manage-images): Learn how to manage uploaded images using the Square Catalog API. - [Manage Menus](https://developer.squareup.com/docs/catalog-api/manage-menus): Learn how to manage menus with the Catalog API and catalog categories. - [Retrieve Catalog Objects](https://developer.squareup.com/docs/catalog-api/retrieve-catalog-objects): Learn how to retrieve Square catalog objects of given IDs or versions using the Catalog API. - [Search for Items and Objects](https://developer.squareup.com/docs/catalog-api/search-catalog): Learn how to search for objects programmatically using the SearchCatalogItems and SearchCatalogObjects endpoints. - [Call SearchCatalogItems](https://developer.squareup.com/docs/catalog-api/search-catalog-items): Learn how to search for items or item variations using one or more supported query filters. - [Call SearchCatalogObjects](https://developer.squareup.com/docs/catalog-api/search-catalog-objects): Learn how to use the SearchCatalogObjects endpoint to search for objects of any type programmatically. - [Synchronize Catalog with External Platform](https://developer.squareup.com/docs/catalog-api/sync-with-external-system): Learn about using the Square API to synchronize an external platform with a Square catalog. - [Update Catalog Objects](https://developer.squareup.com/docs/catalog-api/update-catalog-objects): The UpsertCatalogObject endpoint updates one item at a time, whereas the BatchUpsertCatalogObjects endpoint can update multiple objects at the same time. - [Upload and Attach Images](https://developer.squareup.com/docs/catalog-api/upload-and-attach-images): Learn how to upload images to a Square catalog and attach them to supporting objects in the catalog. - [Sync Your External Catalog](https://developer.squareup.com/docs/catalog-api/webhooks): Learn how to use a webhook to accept notifications to sync your offline catalog. - [Catalog API](https://developer.squareup.com/docs/catalog-api/what-it-does): Learn about creating and managing a product catalog with the Square Catalog API. - [What It Does](https://developer.squareup.com/docs/catalog-api/what-it-does): Learn about creating and managing a product catalog with the Square Catalog API. ### Inventory API Learn about using the Inventory API to adjust inventory quantities and review inventory changes for products in a Square catalog. - [Build an Inventory](https://developer.squareup.com/docs/inventory-api/build-with-inventory): Learn how to build inventory management solutions with the Square Inventory API. - [Build with Inventory API](https://developer.squareup.com/docs/inventory-api/build-with-inventory): Learn how to build inventory management solutions with the Square Inventory API. - [Inspect Inventory Changes](https://developer.squareup.com/docs/inventory-api/cookbook/inventory-change-history): Retrieve the inventory change history for an item. - [Reconcile Inventory Counts](https://developer.squareup.com/docs/inventory-api/cookbook/reconcile-computed-quantity): Use the Inventory API to reconcile the inventory count calculated by Square with the results of a physical count. - [Retrieve Inventory Counts](https://developer.squareup.com/docs/inventory-api/cookbook/retrieve-specific-instock-quantity): Retrieve in-stock quantities for a specific item variation. - [Enable Stock Conversion](https://developer.squareup.com/docs/inventory-api/enable-stock-conversion): Use component inventory to enable selling a product in different measurement units with a specified stock conversion. - [Process Flow](https://developer.squareup.com/docs/inventory-api/how-it-works): Learn about the inventory process flow and how the Inventory API works. - [Migrate to Updated API Entities](https://developer.squareup.com/docs/inventory-api/migrate-to-updated-api-entities): Learn what updated Inventory API endpoints to call to migrate from deprecated endpoint URLs. - [Monitor Sold-out Item Variations](https://developer.squareup.com/docs/inventory-api/monitor-sold-out-status-on-item-variation): Learn how to use the Catalog API to set or inspect a sold-out item or to have it enabled to be set as sold out when its inventory count reaches zero. - [Handle Inventory Events](https://developer.squareup.com/docs/inventory-api/webhooks): Learn how to use inventory webhooks to receive notifications when quantities are updated for catalog item variations. - [Inventory API](https://developer.squareup.com/docs/inventory-api/what-it-does): Use the Square Inventory API to adjust inventory quantities and review inventory changes for products in a Square catalog. - [What It Does](https://developer.squareup.com/docs/inventory-api/what-it-does): Use the Square Inventory API to adjust inventory quantities and review inventory changes for products in a Square catalog. ### Bookings API Learn about using the Bookings API to create applications for Square sellers and their customers to create and manage bookings. - [Manage Custom Attribute Definitions for Bookings](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attribute-definitions): Learn how to define custom attributes to extend Booking properties. - [Manage Custom Attributes for Bookings](https://developer.squareup.com/docs/booking-custom-attributes-api/custom-attributes): Learn how to create and manage custom attribute values for Booking objects. - [Custom Attributes for Bookings](https://developer.squareup.com/docs/booking-custom-attributes-api/overview): Learn how custom attributes can support additional properties on the Booking object. - [Basic Concepts](https://developer.squareup.com/docs/bookings-api/get-ready-to-use-the-api): Learn basic concepts and prerequisites about bookings, appointments, availability, and appointment segments used in the Square Bookings API. - [Onboard to Square Appointments](https://developer.squareup.com/docs/bookings-api/onboard-to-the-api): Learn about how to onboard a seller account or a developer Sandbox account to the Bookings API. - [Create and Manage Bookings](https://developer.squareup.com/docs/bookings-api/use-the-api): Learn how to call the Bookings API to create and manage bookings for a Square seller. - [Handle Event Notifications](https://developer.squareup.com/docs/bookings-api/use-webhooks): Learn how to use the Bookings API to receive supported event notifications related to bookings. - [Bookings](https://developer.squareup.com/docs/bookings-api/what-it-is): The Bookings API lets you create and manage bookings for Square sellers. ### Square Online Find information about the Square Snippets and Sites APIs that you can use to add custom functionality to Square Online sites. - [Square eCommerce APIs](https://developer.squareup.com/docs/ecommerce-api): eCommerce APIs are building blocks for online marketplaces, allowing developers to create seamless shopping experiences. - [Use the Sites API](https://developer.squareup.com/docs/sites-api/use-the-api): Learn how to use the Sites API to list the sites for a Square seller account. - [Add a Snippet to a Site](https://developer.squareup.com/docs/snippets-api/add-a-snippet): Learn how to use the Snippets API and Sites API to add a snippet to a Square Online site - [Use the Snippets API](https://developer.squareup.com/docs/snippets-api/use-the-api): Learn how to use the Snippets API to manage snippets for Square Online sites. ### Vendors API Learn about the Vendors API and how an application can manage vendors for a seller. - [Create Vendors](https://developer.squareup.com/docs/vendors-api/create-vendors): Learn how to use the Vendors API to create vendors for a Square seller. - [Manage Vendors](https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps): Learn about the Vendors API and how to use it in a Square application. - [Receive Vendors Events](https://developer.squareup.com/docs/vendors-api/receive-vendors-events): Learn how to call the Vendors API to set up webhooks to receive supported Vendors API event notifications. - [Retrieve Vendors](https://developer.squareup.com/docs/vendors-api/retrieve-vendors): Learn how to call the Vendors API to retrieve vendors of specified IDs or to search for vendors based on specified query conditions. - [Search for Vendors](https://developer.squareup.com/docs/vendors-api/search-for-vendors): Learn how to use the Vendors API to search vendors as suppliers to a Square seller. - [Update Vendors](https://developer.squareup.com/docs/vendors-api/update-vendors): Learn how to call the Vendors API to update existing vendors. ## Customers The Square Developer platform provides customer APIs to build applications that help sellers grow their businesses through strong customer relationships. Use the customer APIs to securely manage customer data, analyze buying behavior, and integrate engagement features to increase repeat business and attract new customers. - [Customers](https://developer.squareup.com/docs/customers): Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions. - [Overview](https://developer.squareup.com/docs/customers): Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions. - [Build a Sales Report](https://developer.squareup.com/docs/customers/scenarios/simple-sales-report): The Sales Report sample application shows how to build a report that details all the items sold between two dates. - [Split an Online Payment](https://developer.squareup.com/docs/customers/scenarios/split-online-payment): Learn how to build an application that supports splitting multiple online payments. - [Build a Tip Report](https://developer.squareup.com/docs/customers/scenarios/tip-reporting): Learn how to create tip reports and manage tip compensation for a seller's staff. ### Customer profiles Learn about the Customers API and how to manage customer profiles. - [Customers API Workflows](https://developer.squareup.com/docs/customers-api/how-it-works): Learn more about how the Square Customers API processes information. - [Use Customer Webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks): Learn how to configure webhooks to get notified of events when a customer profile is created, updated, deleted, or merged. - [Integrate with Other Services](https://developer.squareup.com/docs/customers-api/use-the-api/integrate-with-other-services): Learn how to integrate customer profiles with the Square Orders API and Payments API. - [Manage Customer Profiles](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records): Use the Square Customers API to perform CRUD operations on customers profiles in a Square account. - [Retrieve Customer Profiles](https://developer.squareup.com/docs/customers-api/use-the-api/retrieve-profiles): Use the Square Customers API to retrieve customers profiles stored in a Square account. - [Search for Customer Profiles](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers): Use the Square Customers API to search for customers using one or more supported query filters. - [Manage Customer Profiles](https://developer.squareup.com/docs/customers-api/what-it-does): Learn more about managing customer profiles with the Square Customers API. - [Manage Customers](https://developer.squareup.com/docs/customers-api/what-it-does): Learn more about managing customer profiles with the Square Customers API. - [Manage Customer Custom Attribute Definitions](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions): Learn how to create and manage customer-related custom attribute definitions for Square sellers using the Customer Custom Attributes API. - [Manage Customer Custom Attributes](https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes): Learn how to create and manage custom attributes for Square customer profiles using the Customer Custom Attributes API. ### Customer Groups Learn about managing customer groups using the Customer Groups API. - [Use Customer Groups](https://developer.squareup.com/docs/customer-groups-api/how-to-use-it): Learn how to use the Square Customer Groups API to organize customer profiles. - [Manage Customers by Groups](https://developer.squareup.com/docs/customer-groups-api/what-it-does): Learn about managing customer groups and using the Square Customer Groups API. - [Use Customer Segments](https://developer.squareup.com/docs/customer-segments-api/how-to-use-it): Learn how to use the Square Customer Segments API to discover available segments in a business and retrieve a specific segment ID to inspect its details. ### Customer segments Learn how to organize customer segments based on a set of filtered criteria. - [Manage Customers by Segments](https://developer.squareup.com/docs/customer-segments-api/what-it-does): A customer segment (also called a smart group) is a dynamic collection of customers that are defined based on a set of filter criteria. ### Gift cards Use the Gift Cards API and Gift Card Activities API to create and manage Square gift cards. - [Manage Gift Cards on File](https://developer.squareup.com/docs/gift-cards/manage-gift-cards-on-file): Learn how to manage gift cards on file by linking or unlinking customers with Square gift cards using the Gift Cards API. - [Redeem Gift Cards](https://developer.squareup.com/docs/gift-cards/redeem-gift-cards): Learn how to redeem a Square gift card for a purchase using the Payments API or the Gift Card Activities API. - [Reload Gift Cards](https://developer.squareup.com/docs/gift-cards/reload-gift-cards): Learn how to reload Square gift cards with additional funds using the Gift Card Activities API. - [Retrieve Gift Cards and Track Activity](https://developer.squareup.com/docs/gift-cards/retrieve-gift-cards-and-activities): Learn how to retrieve gift card information, such as balance, status, and activity history using the Gift Cards API and Gift Card Activities API. - [Sell Gift Cards](https://developer.squareup.com/docs/gift-cards/sell-gift-cards): Learn how to create a Square gift card and activate it with an initial balance using the Gift Cards API and Gift Card Activities API. - [Sell a Gift Card (Orders API Integration)](https://developer.squareup.com/docs/gift-cards/walkthrough-1-with-orders-api): Learn how to sell a Square gift card when your application integrates with the Orders API. - [Sell a Gift Card (Custom Processing System)](https://developer.squareup.com/docs/gift-cards/walkthrough-1-without-orders-api): Provides steps that show how to sell a Square gift card when your application uses a custom order processing system. - [Use a Gift Card (Custom Processing System)](https://developer.squareup.com/docs/gift-cards/walkthrough-2-custom-processing-system): Provides steps that show how to redeem and reload a Square gift card when your application uses a custom order and payment processing system. - [Use a Gift Card (Orders and Payments APIs Integration)](https://developer.squareup.com/docs/gift-cards/walkthrough-2-orders-and-payments-integration): Learn how to redeem and reload a Square gift card when your application integrates with the Orders API and Payments API. - [Webhooks](https://developer.squareup.com/docs/gift-cards/webhooks): Learn about Square Gift Cards API webhooks. You can subscribe to these webhook events to get notified when changes occur. ### Customer loyalty Learn about the Loyalty API and how to set up a loyalty program, enroll buyers in the program, accrue points, and redeem points. - [Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts): Learn about the LoyaltyAccount object and how to use the Square Loyalty API to create and retrieve loyalty accounts. - [Search for Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events): Learn about the LoyaltyEvent object and how to use the Square Loyalty API to list or search for events that affect the point balance of loyalty accounts. - [Manage Loyalty Points](https://developer.squareup.com/docs/loyalty-api/loyalty-points): Learn how to use the Square Loyalty API to accumulate or adjust points for a loyalty account. - [Retrieve Loyalty Program](https://developer.squareup.com/docs/loyalty-api/loyalty-programs): Learn about the LoyaltyProgram object and how to use the Square Loyalty API to retrieve a loyalty program. - [Manage Loyalty Promotions](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions): Learn about the LoyaltyPromotion object and how to use the Square Loyalty API to manage loyalty promotions. - [Manage Loyalty Rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards): Learn about the LoyaltyReward object and how to use the Square Loyalty API to create and manage loyalty rewards. - [Manage with Loyalty API](https://developer.squareup.com/docs/loyalty-api/overview): Learn about the Loyalty API and how to set up a loyalty program, enroll buyers in the program, accrue points, and redeem points. - [Accumulate Points](https://developer.squareup.com/docs/loyalty-api/walkthrough1/accrue-points): Learn how to use the Loyalty API with Orders API integration to compute points earned on a purchase when adding points to a loyalty account. - [Enroll a Buyer](https://developer.squareup.com/docs/loyalty-api/walkthrough1/enroll-buyer): To enroll a buyer in a loyalty program, you create a loyalty account and provide the program ID and buyer's phone number. - [Redeem Points](https://developer.squareup.com/docs/loyalty-api/walkthrough1/redeem-points): Learn about the Square Loyalty API and how to accrue and redeem points. - [Set up a Loyalty Program](https://developer.squareup.com/docs/loyalty-api/walkthrough1/setup-loyalty-program): Square sellers can subscribe to Square Loyalty and set up a loyalty program to help increase repeat visits to their business. - [Adjust Points](https://developer.squareup.com/docs/loyalty-api/walkthrough2-accrue-points): Learn how to use the Loyalty API to adjust the point balance of a buyer's loyalty account. - [Enroll a Buyer](https://developer.squareup.com/docs/loyalty-api/walkthrough2-enroll-buyer): Enroll a buyer in the Square loyalty program as part of the Loyalty Walkthrough 2. - [Redeem Points](https://developer.squareup.com/docs/loyalty-api/walkthrough2-redeem-points): Learn about the Square Loyalty API and how to accrue and redeem points (example walkthrough 2). - [Set up a Loyalty Program](https://developer.squareup.com/docs/loyalty-api/walkthrough2-setup-loyalty-program): Learn how to set up a loyalty program to help increase repeat visits to a seller's business. - [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview): Learn about Square loyalty programs, accrual rules, and reward tiers. ## Staff The Square Developer platform provides staff APIs that let you integrate features using Square team management and time-recording tools. Use staff APIs to help sellers maintain an employee roster, manage job and wage settings, track timecards and breaks, manage team schedules, and optimize staffing levels. - [Build a Sales Report](https://developer.squareup.com/docs/staff/scenarios/simple-sales-report): The Sales Report sample application shows how to build a report that details all the items sold between two dates. - [Build a Tip Report](https://developer.squareup.com/docs/staff/scenarios/tip-reporting): Learn how to create tip reports and manage tip compensation for a seller's staff. - [Split an Online Payment](https://developer.squareup.com/docs/staff/scenarios/split-online-payment): Learn how to build an application that supports splitting multiple online payments. ### Labor Manage timecards and schedules for team members within a Square business. - [Start and End Timecards](https://developer.squareup.com/docs/labor-api/build-with-labor): Learn how to start and end a timecard to record hours worked for a shift using the Square Labor API. - [Add Breaks to Timecards](https://developer.squareup.com/docs/labor-api/cookbook/add-shift-breaks): Learn how to get available break types, add a break to a timecard, and close the break using the Square Labor API. - [Get Completed Timecards](https://developer.squareup.com/docs/labor-api/cookbook/get-completed-shifts): Learn how to get all closed timecards for the workweek using the Square Labor API. - [How It Works](https://developer.squareup.com/docs/labor-api/how-it-works): Use the Square Labor API to record the hours worked by team members, with breaks, pay rate, and declared cash tips. - [Manage Scheduled Shifts](https://developer.squareup.com/docs/labor-api/manage-scheduled-shifts): Learn how to create and manage future scheduled shifts for team members using scheduling endpoints in the Labor API. - [Migrate Employees to Team Members](https://developer.squareup.com/docs/labor-api/migrate-to-teams): Learn about migrating your Labor API application code to reference team members in the Team API. - [Retrieve Scheduled Shifts](https://developer.squareup.com/docs/labor-api/retrieve-scheduled-shifts): Use the Square Labor API to retrieve scheduled shifts and search for shifts by location, team member, date range, and assignment status. - [Labor API](https://developer.squareup.com/docs/labor-api/troubleshooting): Find problems and solutions related to managing timecards (shifts) using the Labor API. - [Troubleshoot](https://developer.squareup.com/docs/labor-api/troubleshooting): Find problems and solutions related to managing timecards (shifts) using the Labor API. - [Webhooks](https://developer.squareup.com/docs/labor-api/webhooks): Learn how to subscribe to Labor API webhooks that send notifications about created, updated, and deleted labor shifts. - [Labor API](https://developer.squareup.com/docs/labor-api/what-it-does): Learn about the time tracking and scheduling capabilities of the Square Labor API. - [What It Does](https://developer.squareup.com/docs/labor-api/what-it-does): Learn about the time tracking and scheduling capabilities of the Square Labor API. - [Overview](https://developer.squareup.com/docs/staff): Use Square staff APIs to help sellers maintain an employee roster, manage job and wage settings, track shifts and breaks, and optimize staffing levels. ### Staff - [Staff](https://developer.squareup.com/docs/staff): Use Square staff APIs to help sellers maintain an employee roster, manage job and wage settings, track shifts and breaks, and optimize staffing levels. - [Integration Guide](https://developer.squareup.com/docs/team/integration): Learn how to use the Team API to manage team members for a Square seller. - [Troubleshoot Team API](https://developer.squareup.com/docs/team/troubleshooting): Learn how to troubleshoot errors with the Team API. ## Merchants The Square Developer platform provides merchant APIs that let you configure and access account details to support merchant services across many locations. Each merchant represents one organization or business that sells with Square. - [Define Custom Attributes for Locations](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attribute-definitions): Learn how to define location-related custom attributes for Square sellers using the Location Custom Attributes API. - [Use Custom Attributes for Locations](https://developer.squareup.com/docs/location-custom-attributes-api/custom-attributes): Learn how to create and manage custom attribute values for Location objects. - [Locations](https://developer.squareup.com/docs/locations-api): Learn how to use a Square API to update and retrieve location information for a Square seller. - [Define Custom Attributes for Merchants](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attribute-definitions): Learn how to define merchant-related custom attributes for Square sellers using the Merchant Custom Attributes API. - [Use Custom Attributes for Merchants](https://developer.squareup.com/docs/merchant-custom-attributes-api/custom-attributes): Learn how to create and manage custom attribute values for Merchant objects. - [Overview](https://developer.squareup.com/docs/merchant-details): Use Square merchant APIs to configure and access account details that support merchant services across many locations. - [Merchants](https://developer.squareup.com/docs/merchants-api): Learn about the Merchants API and how to retrieve information about a Square seller account that's integrated with your application - [Build a Sales Report](https://developer.squareup.com/docs/merchants/scenarios/simple-sales-report): The Sales Report sample application shows how to build a report that details all the items sold between two dates. - [Split an Online Payment](https://developer.squareup.com/docs/merchants/scenarios/split-online-payment): Learn how to build an application that supports splitting multiple online payments. - [Build a Tip Report](https://developer.squareup.com/docs/merchants/scenarios/tip-reporting): Learn how to create tip reports and manage tip compensation for a seller's staff. ## Publish Millions of sellers use the Square App Marketplace to discover and connect apps to the Square accounts that they rely on daily to run their businesses. As a Square app partner, you can monetize your apps by offering them directly to Square sellers through the Square App Marketplace. For more information about the benefits of app partnership, see Square Developer App Partnerships. - [App Marketplace](https://developer.squareup.com/docs/app-marketplace): Learn how to publish your Square-integrated application in the Square App Marketplace. - [App Marketplace Reviews](https://developer.squareup.com/docs/app-marketplace/app-reviews): Reviews provide sellers with a useful context for how your application can help them run their business. - [App Subscriptions Billing](https://developer.squareup.com/docs/app-marketplace/app-subscriptions/billing): Learn how App Subscriptions are billed to sellers and developers. - [Build an app](https://developer.squareup.com/docs/app-marketplace/build): Learn how to build applications for the Square App Marketplace - [App Marketplace Frequently Asked Questions](https://developer.squareup.com/docs/app-marketplace/faq): Get answers to frequently asked Developer App Marketplace questions. - [Create an App Marketplace Listing](https://developer.squareup.com/docs/app-marketplace/listing-best-practices): Learn how to write an effective App Marketplace listing. - [Basic Information](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/basics): Learn how to complete the basic information and details for your App Marketplace listing. - [Brand and Images](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/brand-and-images): Learn how to add brand images to your App Marketplace listing. - [Details](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/details): Learn how to complete the detail fields for your App Marketplace listing. - [Get Started](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/get-started): Learn how to complete the Get Started fields for your App Marketplace listing. - [Pricing](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/pricing): Learn how to complete the pricing fields in your App Marketplace listing. - [Support Information](https://developer.squareup.com/docs/app-marketplace/listing-best-practices/support-information): Learn how to provide support information for your App Marketplace listing. - [Promote your App](https://developer.squareup.com/docs/app-marketplace/promote-your-app): Learn about promoting your App Marketplace listing to get the attention of more Square sellers - [Referral Tracking Links](https://developer.squareup.com/docs/app-marketplace/referral-tracking-links): Learn how to add referral tracking links to your application to enable revenue from usage of your application by Square sellers - [ ---------------](https://developer.squareup.com/docs/app-marketplace/requirements): Learn about App Marketplace requirements for Square’s platform partners to follow. - [App Subscriptions](https://developer.squareup.com/docs/app-marketplace/requirements/app-subscriptions): Learn about the App Subscription API requirements for getting your application approved for the App Marketplace. - [Bookings API](https://developer.squareup.com/docs/app-marketplace/requirements/bookings-api): Learn about the Bookings API requirements for getting your application approved for the App Marketplace. - [Catalog and Inventory API](https://developer.squareup.com/docs/app-marketplace/requirements/catalog-api): Learn about the Catalog API requirements for getting your application approved for the App Marketplace. - [Customers API](https://developer.squareup.com/docs/app-marketplace/requirements/customers-api): Learn about the Customers API requirements for getting your application approved for the App Marketplace. - [General](https://developer.squareup.com/docs/app-marketplace/requirements/general): Learn about the general requirements for getting your application approved for the App Marketplace. - [Gift Cards API](https://developer.squareup.com/docs/app-marketplace/requirements/gift-cards-api): Learn about the Gift Cards API requirements for getting your application approved for the App Marketplace. - [Inventory API](https://developer.squareup.com/docs/app-marketplace/requirements/inventory-api): Learn about the Square App Marketplaces requirements related to the Inventory API. - [Invoices API](https://developer.squareup.com/docs/app-marketplace/requirements/invoices-api): Learn about the Invoices API requirements for getting your application approved for the App Marketplace. - [Labor API](https://developer.squareup.com/docs/app-marketplace/requirements/labor-api): Learn about the Labor API requirements for getting your application approved for the App Marketplace. - [Locations API](https://developer.squareup.com/docs/app-marketplace/requirements/locations-api): Learn about the Locations API requirements for getting your application approved for the App Marketplace. - [Loyalty API](https://developer.squareup.com/docs/app-marketplace/requirements/loyalty-api): Learn about the Loyalty API requirements for getting your application approved for the App Marketplace. - [OAuth API](https://developer.squareup.com/docs/app-marketplace/requirements/oauth-api): Learn about the OAuth API requirements for getting your application approved for the App Marketplace. - [Orders API](https://developer.squareup.com/docs/app-marketplace/requirements/orders-api): Learn about the Orders API requirements for getting your application approved for the App Marketplace. - [Payments](https://developer.squareup.com/docs/app-marketplace/requirements/payments-api): Learn about the payments requirements for getting your application approved for the App Marketplace. - [Payouts API](https://developer.squareup.com/docs/app-marketplace/requirements/payouts-api): Learn about the Payouts API requirements for getting your application approved for the App Marketplace. - [Reader SDK](https://developer.squareup.com/docs/app-marketplace/requirements/reader-sdk): Learn about the Square App Marketplace requirements related to the Reader SDK. - [Snippets API](https://developer.squareup.com/docs/app-marketplace/requirements/snippets-api): Learn about the Snippets API requirements for getting your application approved for the App Marketplace. - [Subscriptions API](https://developer.squareup.com/docs/app-marketplace/requirements/subscriptions-api): Learn about the Subscriptions API requirements for getting your application approved for the App Marketplace. - [Team API](https://developer.squareup.com/docs/app-marketplace/requirements/team-api): Learn about the Team API requirements for getting your application approved for the App Marketplace. - [Terminal API](https://developer.squareup.com/docs/app-marketplace/requirements/terminal-api): Learn about the Terminal API requirements for getting your application approved for the App Marketplace. - [Webhooks](https://developer.squareup.com/docs/app-marketplace/requirements/webhooks): Learn about the webhook requirements for getting your application approved for the App Marketplace. - [App Marketplace Revenue Sharing](https://developer.squareup.com/docs/app-marketplace/rev-share): Learn about seller referral revenue sharing for applications published in the Square App Marketplace. - [Video Submission Requirements](https://developer.squareup.com/docs/app-marketplace/video-submission): Learn about the best practices for submitting a video with your App Marketplace submission. - [What Should I Build?](https://developer.squareup.com/docs/app-marketplace/what-should-i-build): Learn about the types of applications you can build for the Square App Marketplace. ## Release notes The Square Developer platform is periodically updated with new API features, additional documentation, and fixes for known issues. These release notes document these updates with new notes at every release of an updated API or new API. - [Overview](https://developer.squareup.com/docs/release-notes): The Square Developer platform is periodically updated with new API features, additional documentation, and fixes for known issues. - [Release notes](https://developer.squareup.com/docs/release-notes): The Square Developer platform is periodically updated with new API features, additional documentation, and fixes for known issues. - [Release notes](https://developer.squareup.com/docs/release-notes): The Square Developer platform is periodically updated with new API features, additional documentation, and fixes for known issues.