Payment

sealed class Payment

The description of a completed payment, returned in the success value of Payment Result. All currency amounts are specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

Inheritors

Types

Link copied to clipboard
data class Capabilities(val allCapabilities: Set<String>)

Actions that can be performed on a payment, e.g. modifying the tip amount up or down.

Link copied to clipboard

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.

Link copied to clipboard

The status of the offline payment.

Link copied to clipboard

The description of a completed payment, returned in the success value of Payment Result. All currency amounts are specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

Link copied to clipboard

The source type of the payment.

Link copied to clipboard

The status of the payment.

Properties

Link copied to clipboard
abstract val amountMoney: Money

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

Link copied to clipboard
abstract val appFeeMoney: Money?

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

Link copied to clipboard

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

Link copied to clipboard
abstract val createdAt: Date

Timestamp of when the payment was created.

Link copied to clipboard

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

Link copied to clipboard
abstract val locationId: String

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

Link copied to clipboard
abstract val orderId: String?

The ID of the order associated with this payment.

Link copied to clipboard
abstract val referenceId: String?

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

Link copied to clipboard

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

Link copied to clipboard
abstract val tipMoney: Money?

The portion of totalMoney that is designated as a tip.

Link copied to clipboard

Total money is defined as base amount plus any tip; it doesn't need its own storage allocated, and definitely doesn't need an independent setter.

Link copied to clipboard
abstract val updatedAt: Date

Timestamp when the payment was last updated.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard