Mobile Payments SDK Android Technical Reference/com.squareup.sdk.mobilepayments.payment/Payment/OfflinePayment

OfflinePayment

The description of a completed payment, that was taken while Offline. All currency amounts are specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

Types

Builder

class Builder(localId: String, amountMoney: Money, status: Payment.OfflineStatus, locationId: String, sourceType: Payment.SourceType)

Builder class for constructing OfflinePayment objects.

Properties

amountMoney

open override val amountMoney: Money

The base amount of money processed for this payment, not including tipMoney.

appFeeMoney

open override val appFeeMoney: Money?

The amount taken by the developer as a fee, not more than 90% of totalMoney.

cardDetails

val cardDetails: CardPaymentDetails.OfflineCardPaymentDetails?

Non-confidential details for the source card.

cashDetails

open override val cashDetails: CashPaymentDetails?

An optional field for a cash payment that holds information such as the buyer supplied amount and the change the user should get back.

createdAt

open override val createdAt: Date

Timestamp of when the payment was created.

externalDetails

open override val externalDetails: ExternalPaymentDetails?

Details about an external payment. The details are only populated if the sourceType is SourceType.EXTERNAL.

val id: String?

Unique ID for this payment, assigned by Square. Value stays null until payment is uploaded and gets a server-side ID.

localId

val localId: String

Unique ID for this payment, generated when device is offline. Can be used to identify this Payment until it is uploaded to server and id becomes available.

locationId

open override val locationId: String

The ID of the location associated with the payment, if available.

orderId

open override val orderId: String?

The ID of the order associated with this payment.

referenceId

open override val referenceId: String?

An optional ID that associates this payment with an entity in another system.

sourceType

open override val sourceType: Payment.SourceType

The source type of the payment (card, cash, etc).