Docs Home
Dev Essentials
PaymentsCommerceCustomersStaffMerchants
Publish
Release notes

Docs

Docs Home
Dev Essentials
Payments
Commerce
Customers
Staff
Merchants
Publish
Release notes
Overview
Build a Tip Report
Split an Online Payment
Build a Sales Report
Delayed Capture
Partial Payments
Statement Descriptions
ACH Bank Transfer Payment
Afterpay and Clearpay Payments
Cash App Payments
Cash Payments
External Payments
House Accounts
Collect Application Fees
Update Payment and Tip Amounts
Retrieve Payments
Troubleshoot
Webhooks
Refund Payments
Refund a Payment with an App Fee
Retrieve Refunds
Process an Unlinked Refund
Webhooks
Process Disputes
Test in the Sandbox
Take Payments on Hardware
Quickstart
Take Payments
POS App Pairing with Square Terminal
Dismiss Terminal Checkouts and Refunds
Monitor Square Terminals
Take and Process Orders
Manage Terminal Actions
Save Card on File
Check Device Information
Print or Issue Receipts
Customize the Idle Screen
Confirmation Screen
Signature Capture Screen
Data Collection Screen
Menu Selection List Screen
QR Code Screen
Link and Dismiss Actions
Refund Interac Payments
Take E-Money Payments
Take QR Code Payments for Digital Wallets
Authorize the Mobile Payments SDK
Pair and Manage Card Readers
Take a Payment
Tap to Pay on Android
Offline Payments
Handling Errors
Authorize the Mobile Payments SDK
Pair and Manage Card Readers
Take a Payment
Tap to Pay on iPhone
Offline Payments
Configure for Square Stand or Square Kiosk
Handling Errors
Migrate from Reader SDK
React Native Plugin
Reader SDK
Migrate to Mobile Payments SDK
Quickstart
Get Credentials
Configure the Sample Application
Take a Cash Payment
Customize the Checkout Amount
Take a Credit Card Payment
How It Works
Build on Android
Build on iOS
Connect a Contactless Reader
Charge a Card on File
Save a Card on File
Configure on iOS for Square Stand
Deauthorize Reader SDK
Capture a Transaction
Delay the Capture of Payments
Configure APK Splits
Update to New Reader SDK Version
Flutter Plugin
React Native Plugin
How It Works
Build on Android
Build on iOS
Build on Mobile Web
Find Your Android Fingerprint
Use the API in Offline Mode
Add an Alert Dialog Helper Class
Accept E-Money Payments
Accept PayPay Payments
Mobile Web Technical Reference
Payments API Integration
Clone the Quickstart Project Template
Add the SDK to the Web Client
Verify the Payment
Add Strong Customer Authentication
Deploy the Application
Take a Card Payment
Apple Pay
Google Pay
Digital Wallet Payment Requests
ACH Bank Transfer
Afterpay
Cash App Pay
Take a Gift Card Payment
Take Partial Payments
Customize the Card Entry Form
Add SCA to a Card Payment
Store a Card on File
Charge a Card on File
Charge and Store a Card on File
Add a Content Security Policy
Set up the Client
Deploy the Server
Install the SDK
Build on Android
Build on iOS
Google Pay
Apple Pay
Enable SRC for Android
Enable SRC for iOS
Localize an Application
Gift Card Payments
Flutter Plugin
React Native Plugin
Customize the Payment Entry Form
Connect to a Backend Service
Remove the Postal Code Requirement
Troubleshoot
How It Works
Verify a Buyer
Quick Pay Checkout
Square Order Checkout
Subscription Plan Checkout
Checkout Settings
Checkout Configurations
Manage Checkout
Guidelines and Limitations
Subscription Plans and Variations
Manage Subscriptions
Subscription Actions and Events
Pause, Resume, or Cancel Subscriptions
Subscription Billing and Invoices
Swap Subscription Plan Variations
Create and Publish Invoices
Retrieve, List, or Search Invoices
Create or Delete Invoice Attachments
Update Invoices
Cancel or Delete Invoices
Pay or Refund Invoices
Walkthrough: Create and Publish Invoices
Manage Cards
Create a Card on File from Payment ID
Create a Card on File and Make a Payment
Create a Shared Card on File and Make a Payment
List Payouts
Get Payout
List Payout Entries
Bank Accounts
How It Works
Build with Mobile Authorization
Get Authorization Code on Command Line
Payment Methods by Country
Payments Pricing
Strong Customer Authentication
Payment Minimums

/

Payments

/

Take Payments on Hardware

/

Reader SDK

/

Quickstart

Configure the Reader SDK Sample Application

Applies to: Reader SDK - Android | Reader SDK - iOS

Learn how to download and configure the Reader SDK sample application from GitHub and configure it for your environment.

Warning

The Square Reader SDK is deprecated and will be retired on December 31, 2025. The SDK is no longer receiving new releases and support for new operating systems isn't guaranteed.

The Mobile Payments SDK launched as the successor of the Reader SDK and is now in General Availability (GA). To ensure continued support and functionality, you should migrate your application from the Reader SDK to the Mobile Payments SDK before the retirement date.

Overview
Link to section

Overview

Download the Reader SDK sample application from GitHub and complete the following steps to configure the sample application for your environment:

  1. Download the Reader SDK sample application for Android and then return to this page to proceed.

  2. Sign in to the Developer Console and open your application.

  3. In the left pane, choose Reader SDK.

  4. At the top of the page, change the environment from Sandbox to Production.

  5. Copy the application ID and repository password.

  6. In ./gradle.properties, set the variables for your Square application ID and repository password from the Reader SDK page by replacing the '{}' characters and the uppercase placeholder text between them with your application credentials.

    SQUARE_READER_SDK_APPLICATION_ID="{APPLICATION ID FROM STEP 1}"
SQUARE_READER_SDK_REPOSITORY_PASSWORD="{REPO PASSWORD FROM STEP 1}"

  7. Import the project into Android Studio.

    If you run into errors while building the project, you should clean the project and reopen Android Studio before continuing.

On this page
OverviewSee also