Inttegro SDK for Android/com.inttegro.payments/PaymentSheetSession

PaymentSheetSession

data class PaymentSheetSession(val id: String, val merchant: PaymentSheetSession.Merchant, val amount: PaymentSheetSession.Money, val paymentMethods: List<PaymentSheetSession.PaymentMethod>, val expiresAt: Instant, val lineItems: List<PaymentSheetSession.LineItem> = emptyList(), val documents: PaymentSheetSession.Documents = Documents())(source)

Client-safe Checkout data used during one payment-sheet presentation.

The default adapter constructs this from Inttegro's public projection. Applications normally use it only when implementing PaymentSheetAdapter; it is display and collection state, not an editable Order.

Constructors

PaymentSheetSession

constructor(id: String, merchant: PaymentSheetSession.Merchant, amount: PaymentSheetSession.Money, paymentMethods: List<PaymentSheetSession.PaymentMethod>, expiresAt: Instant, lineItems: List<PaymentSheetSession.LineItem> = emptyList(), documents: PaymentSheetSession.Documents = Documents())

Types

Documents

data class Documents(val invoiceUrl: String? = null, val receiptUrl: String? = null)

Documents that Checkout made available after payment completed.

LineItem

data class LineItem(val id: String, val name: String, val quantity: Int? = null, val total: PaymentSheetSession.Money, val amountSelection: PaymentSheetAmountSelection? = null)

Purchasable item displayed in the optional Order summary.

Merchant

data class Merchant(val displayName: String, val supportText: String? = null)

Merchant identity displayed to the payer.

Money

data class Money(val value: Long, val currency: String)

Monetary amount represented in the currency's minor unit.

PaymentMethod

data class PaymentMethod(val id: String, val kind: PaymentSheetSession.PaymentMethod.Kind, val source: PaymentSheetSession.PaymentMethod.Source = Source.SAVED, val label: String, val detail: String? = null)

Saved or newly collectable method shown to the payer.

Properties

amount

val amount: PaymentSheetSession.Money

Checkout-calculated amount being authorized.

documents

val documents: PaymentSheetSession.Documents

Secure document links available after completion.

expiresAt

val expiresAt: Instant

Time after which this projection must not be used.

val id: String

Public Order identifier backing Checkout.

lineItems

val lineItems: List<PaymentSheetSession.LineItem>

Optional Checkout-provided Order lines.

merchant

val merchant: PaymentSheetSession.Merchant

Merchant identity displayed to the payer.

paymentMethods

val paymentMethods: List<PaymentSheetSession.PaymentMethod>

Saved and collectable method choices.