Reader SDK Quickstart

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

Learn how to take cash and credit card payments with the Android and iOS Reader SDK sample application.

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.

Link to section

Overview

Follow this quickstart to begin taking cash and credit card payments with the Android and iOS Reader SDK sample application:

  1. Get Reader SDK Credentials

  2. Configure the Reader SDK Sample Application

  3. Take a Cash Payment

  4. Customize the Checkout Amount

  5. Take a Credit Card Payment

The Reader SDK lets you take cash payments in addition to credit card payments. This Quickstart begins with cash transactions, which you can do right away, even without deploying the sample application to a physical device.

To take a credit card payment, you must deploy the sample application to a physical device and have a Square Reader available.

Did you know?

If you don't have a Square Reader, you can purchase a Magstripe Reader online or buy a Square Reader online or in person.

Link to section

See also

On this page