Save a Card on File

Use the Reader SDK card-on-file workflow to create a customer card for an existing Customer object. The card-on-file workflow is a sequence of screens used by customers to specify that they want to save their card information for future purchases.

• You need an access token. If you're using OAuth, you need CUSTOMERS_WRITE permission to save a card on file and PAYMENTS_WRITE permission to process payments with the saved card. Cards on file are automatically updated on a monthly basis to confirm that they are still valid and can be charged.
• You need to create a Customer object using the Customers API. To create your first Customer object, see Customers API.

• You need to install the Reader SDK and configure your Android project.

• You need to install the Reader SDK and configure your iOS project.

Use the CustomerCardManager class to create a new customer card manager to securely collect card information. Customer card information is stored on Square servers, not on the device running the Reader SDK, so you need to implement a callback to handle the response from Square.

import com.squareup.sdk.reader.ReaderSdk;
import com.squareup.sdk.reader.crm.CustomerCardManager;
import com.squareup.sdk.reader.core.CallbackReference;

CustomerCardManager customerCardManager =
    ReaderSdk.customerCardManager();

...

CallbackReference storeCardCallbackRef = customerCardManager.addStoreCardActivityCallback(result -> {
 hideLoadingIndicatorOnYourActivity();
 if (result.isSuccess()) {
   showStoreCardSuccessDialog(result.getSuccessValue());
 } else {
   showErrorDialog(result.getError());
 }
});

Use the customer card manager to start the StoreCard activity and link the card to an existing customer ID.

showLoadingIndicatorOnYourActivity();
customerCardManager.startStoreCardActivity(activity, customerId));