SQRDCheckoutResult

@interface SQRDCheckoutResult : NSObject <NSCopying>

The result of the checkout flow.

  • A unique ID issued by Square servers for successful transactions that include one or more card tenders.

    The transaction ID is nil for transactions that have no card tenders (for example, a cash transaction). Transaction IDs can be used to look up transaction details or refund transactions via the Transactions API.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *transactionID;

    Swift

    var transactionID: String? { get }

  • A unique client-generated ID for successful transactions.

    All successful transactions include a client-generated ID. Transactions with card
    tenders also include a transactionID that is assigned when the card is processed.

    To reconcile transactions that do not have card tenders, use transactionClientID to match client-generated transactions to the client_id field in transactions returned by the ListTransactions endpoint of the Transactions API.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) NSString *transactionClientID;

    Swift

    var transactionClientID: String { get }

  • The unique ID of the location to which the transaction was credited.

    Location IDs are generated by Square for store locations listed in Square Dashboard, and can be accessed through the Locations API.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) NSString *locationID;

    Swift

    var locationID: String { get }

  • The date and time when the transaction was completed as determined by the client device.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) NSDate *createdAt;

    Swift

    var createdAt: Date { get }

  • The total amount of money collected during checkout.

    This is the sum of the totalMoney amounts for all tenders, including tips.

    Declaration

    Objective-C

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

    Swift

    var totalMoney: SQRDMoney { get }

  • The total tip amount applied across all tenders.

    Included as part of totalMoney.

    Declaration

    Objective-C

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

    Swift

    var totalTipMoney: SQRDMoney { get }

  • The set of tenders associated with a successful transaction.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) NSSet<SQRDTender *> *tenders;

    Swift

    var tenders: Set<AnyHashable> { get }