SQRDCheckoutParameters

@interface SQRDCheckoutParameters : NSObject <NSCopying>

Parameters for SQRDCheckoutController.

Default values:

  • note: nil
  • additionalPaymentTypes: []
  • tipSettings: nil
  • skipReceipt: false
  • collectSignature: false
  • allowSplitTender: false
  • delayCapture: false

  • Create a SQRDCheckoutParameters with default values.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAmountMoney:(nonnull SQRDMoney *)amountMoney;

    Swift

    init(amountMoney: SQRDMoney)

    Parameters

    amountMoney

    The charge amount.

  • The amount of money to charge in the checkout flow.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) SQRDMoney *amountMoney;

    Swift

    var amountMoney: SQRDMoney { get }

  • An optional note to associate with the transaction.

    This note will be included in the itemizations field of Payment objects returned by the List Payments and Retrieve Payment endpoints of the Square Connect v1 API.

    It is also included on Square digital receipts.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *note;

    Swift

    var note: String? { get set }

  • A set of payment types accepted during the checkout flow in addition to payments via Square Readers. For example, manually entered cards and cash. Defaults to an empty set.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    SQRDAdditionalPaymentTypes additionalPaymentTypes;

    Swift

    var additionalPaymentTypes: SQRDAdditionalPaymentTypes { get set }

  • Configures tipping behavior of the checkout flow.

    When tipSettings is nil, tipping is disabled. Defaults to nil.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) SQRDTipSettings *tipSettings;

    Swift

    @NSCopying var tipSettings: SQRDTipSettings? { get set }

  • Indicates that the digital receipt options screen should not be displayed during checkout.

    skipReceipt does not override receipt options previously set by the customer. Square will always send digital receipts to customers who have opted-in to automatic receipts.

    Defaults to false.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL skipReceipt;

    Swift

    var skipReceipt: Bool { get set }

  • Indicates that signatures should be collected during checkout.

    When true, the signature screen will be displayed during checkout. Defaults to false.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL collectSignature;

    Swift

    var collectSignature: Bool { get set }

  • Indicates that the transaction may be split into multiple tenders during the checkout flow.

    Defaults to false.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL allowSplitTender;

    Swift

    var allowSplitTender: Bool { get set }

  • When true, if checkout completes successfully, the SDK will only authorize, but not capture any card payments. You can then use the Square Connect CaptureTransaction endpoint to capture the card payments at a later time.

    Setting delayCapture to true will skip the receipt, tipping, and signature screens, and the following parameters will be ignored:

    Defaults to false. By default, the SDK will immediately capture all card payments.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL delayCapture;

    Swift

    var delayCapture: Bool { get set }

Deprecated

  • Warning

    Deprecated. Use collectSignature instead. This property is a no-op and will be removed in a future major release.

    Indicates that signature collection is required during checkout.

    When false, the signature screen will only be displayed when required. Defaults to true.

    See

    collectSignature

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL alwaysRequireSignature;

    Swift

    var alwaysRequireSignature: Bool { get set }