Applies to: Reader SDK - Android
Learn how to delay the capture of payments authorized by a Reader SDK application.
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
By default, the Reader SDK immediately captures all card payments in a transaction, but the SDK also supports the delayed capture of card payments. For example, when a customer makes an in-store purchase from a seller, the seller might want to authorize funds at the time of purchase and capture the funds when the item ships from the warehouse. The CheckoutManager
Card payments are authorized by the issuing bank at the moment of purchase. An authorized transaction means that the bank has put a hold on the funds but the seller hasn't received the payment. Customers see this as a pending transaction on their credit card statement. At some later point, transactions are reconciled by capturing the transaction.
A captured transaction means that the seller receives the funds previously put on hold by the issuing bank.
You need to configure your Android project
To delay the capture of all card payments in a transaction, set delayCapture to true on the CheckoutParameters.Builder instance used to configure the checkout flow.
Setting delayCapture to true skips the receipt, tipping, and signature screens and the following parameters are ignored: tipSettings, skipReceipt, and collectSignature.
CheckoutParameters checkoutParameters = CheckoutParameters.newBuilder(new Money(100, USD)) .delayCapture(true) .build(); CheckoutManager checkoutManager = ReaderSdk.checkoutManager(); checkoutManager.startCheckoutActivity(this, checkoutParameters);
As of August 15, 2019, the CaptureTransaction
After the checkout completes successfully, you can call the CaptureTransaction
Square automatically cancels a transaction if it's not captured within 36 hours of its creation.
The CaptureTransaction
Delayed transactions cannot be voided with the VoidTransaction
private CheckoutManager checkoutManager; private CallbackReference checkoutCallbackRef; ... checkoutManager = ReaderSdk.checkoutManager(); checkoutCallbackRef = checkoutManager.addCheckoutActivityCallback(result -> { if (result.isSuccess()) { CheckoutResult checkoutResult = result.getSuccessValue(); // Parameters required in order to capture card payments // via the Square Connect CaptureTransaction endpoint. String transactionId = checkoutResult.getTransactionId(); String locationId = checkoutResult.getLocationId(); } else { // Show Error } });
You cannot capture a delayed transaction with the Reader SDK. Transactions are captured using the Transactions API
If you need more assistance, contact Developer and App Marketplace Support