Package com.stripe.stripeterminal.external.models

Types

Address
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Address @JvmOverloads() constructor(city: String?, country: String?, line1: String?, line2: String?, postalCode: String?, state: String?) : Parcelable
The Address class stores address data for use with the Location classUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
CardDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class CardDetails : Parcelable
The CardDetails object contains details about a specific card presented to a readerFor more information, see the official Stripe docs: CardUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
CardOptions
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class CardOptions(@Json(name = requestThreeDSecurerequest3dSecure: Request3dSecureType?) : Parcelable
Configurations that will be applied to each setup attempt.
CardPresentDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class CardPresentDetails : Parcelable
CardPresentDetails contains payment method details for a payment method of type CARD_PRESENTFor more information, see the official Stripe docs: Card presentUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
Cart
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Cart
Cart contains information on what items are included in a transaction that will be shown on a reader when using setReaderDisplay.
CartLineItem
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class CartLineItem
CartLineItem contains information for a line item in a CartFor more information, see the official Stripe docs: Set the reader displayTo create an instance of this class, use the CartLineItem.BuilderUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
Charge
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Charge : Parcelable
The Charge object contains details about a charge made to a PaymentIntentUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
ConnectionConfiguration
Link copied to clipboard
sealed class ConnectionConfiguration
The ConnectionConfiguration class contains configuration information for connecting to a reader.
ConnectionStatus
Link copied to clipboard
enum ConnectionStatus : Enum<ConnectionStatus>
The ConnectionStatus represents the current state of the reader-terminal connection.
ConnectionTokenException
Link copied to clipboard
class ConnectionTokenException @JvmOverloads() constructor(message: String, cause: Throwable?) : Exception
The ConnectionTokenException is an exception type that should be thrown by the ConnectionTokenProvider when there's an unresolvable error that prevents us from fetching a connection tokenUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
CustomerAcceptanceParameters
Link copied to clipboard
class CustomerAcceptanceParameters
Details about the customer acceptance of a Mandate.
CustomerAcceptanceType
Link copied to clipboard
enum CustomerAcceptanceType : Enum<CustomerAcceptanceType>
Type of customer acceptance information included with the Mandate.
DeviceType
Link copied to clipboard
enum DeviceType : Enum<DeviceType>
The possible device types for a reader.
DiscoveryConfiguration
Link copied to clipboard
data class DiscoveryConfiguration @JvmOverloads() constructor(timeout: Int, discoveryMethod: DiscoveryMethod, isSimulated: Boolean, location: String?)
The DiscoveryConfiguration contains configuration information relevant to the reader discovery process.
DiscoveryMethod
Link copied to clipboard
enum DiscoveryMethod : Enum<DiscoveryMethod>
The DiscoveryMethod enum represents the possible ways of discovery readers.
EmvBlob
Link copied to clipboard
data class EmvBlob
The EmvBlob is an internal data class meant to wrap the EMV blob generated for a specific SimulatedCard.
ExpandableLocation
Link copied to clipboard
interface ExpandableLocation
Expandable Location Union Type.
ListLocationsParameters
Link copied to clipboard
data class ListLocationsParameters
Arguments used when fetching a list of Locations.
Location
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Location @JvmOverloads() constructor(id: String?, address: Address?, displayName: String?, livemode: Boolean?, metadata: Map<String, String>?) : Parcelable
The Location class contains details about the location object to which readers can be registered.
LocationStatus
Link copied to clipboard
enum LocationStatus : Enum<LocationStatus>
LocationStatus represents the potential states of a Reader object with respect to its registeredLocation field.
MandateOnlineAcceptanceData
Link copied to clipboard
data class MandateOnlineAcceptanceData(ipAddress: String, userAgent: String)
If a Mandate is accepted online, this contains details about the online acceptance.
MandateParameters
Link copied to clipboard
data class MandateParameters(customerAcceptance: CustomerAcceptanceParameters)
Details about a Mandate to be created.
PaymentIntent
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PaymentIntent : Parcelable
The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step.
PaymentIntentParameters
Link copied to clipboard
class PaymentIntentParameters
The PaymentIntentParameters class contains information that will be used for the creation of a new PaymentIntent.
PaymentIntentStatus
Link copied to clipboard
enum PaymentIntentStatus : Enum<PaymentIntentStatus>
A PaymentIntentStatus represents the state that a given PaymentIntent is currently in.
PaymentMethod
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PaymentMethod : Parcelable
PaymentMethod objects represent your customer's payment instruments.
PaymentMethodDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PaymentMethodDetails : Parcelable
PaymentMethodDetails contains details about the payment method used to complete a PaymentIntentFor more information, see the official Stripe docs: Payment method detailsUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
PaymentMethodOptions
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PaymentMethodOptions(card: CardOptions?) : Parcelable
Payment-method-specific configuration for a SetupIntent.
PaymentMethodType
Link copied to clipboard
enum PaymentMethodType : Enum<PaymentMethodType>
An enum representing the type of payment method being handledUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
PaymentStatus
Link copied to clipboard
enum PaymentStatus : Enum<PaymentStatus>
A PaymentStatus represents any of the states that a single payment can be in.
Reader
Link copied to clipboard
@JsonClass(generateAdapter = true)
class Reader @JvmOverloads() constructor(deviceType: DeviceType, @Json(name = locationlocationRaw: ExpandableLocation?, locationStatus: LocationStatus, id: String?, readerInfo: ReaderInfo?, isSimulated: Boolean, @Json(name = statusnetworkStatus: Reader.NetworkStatus?, @Json(name = serialNumberrawSerialNumber: String?, label: String?, deviceSwVersion: String?, baseUrl: String?, ipAddress: String?, livemode: Boolean?, device: BluetoothDevice?, location: Location?)
The Reader is a representation of a physical reader device.
ReaderDisplayMessage
Link copied to clipboard
enum ReaderDisplayMessage : Enum<ReaderDisplayMessage>
A ReaderDisplayMessage represents any of the possible messages emitted by the reader as it is accepting input.
ReaderEvent
Link copied to clipboard
enum ReaderEvent : Enum<ReaderEvent>
A ReaderEvent represents any of the possible events you can receive from a connected reader.
ReaderInputOptions
Link copied to clipboard
class ReaderInputOptions(options: List<ReaderInputOptions.ReaderInputOption>)
The ReaderInputOptions represents the set of ReaderInputOptions currently available to your user.
ReaderSoftwareUpdate
Link copied to clipboard
class ReaderSoftwareUpdate(requiredAt: Date, timeEstimate: ReaderSoftwareUpdate.UpdateTimeEstimate, version: String, configSpec: ClientVersionSpecPb?, firmwareSpec: ClientVersionSpecPb?, keyProfileName: String?, settingsVersion: String?, imageRef: ImageRef?, config: MobileClientConfig?)
ReaderSoftwareUpdate contains information about a potential software update to the reader.
ReadReusableCardParameters
Link copied to clipboard
class ReadReusableCardParameters
Parameters for reading a reusable card.
ReceiptDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ReceiptDetails : Parcelable
All necessary information for generating receiptsUse of this SDK is subject to the Stripe Terminal Terms: https://stripe.
RedirectUrl
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class RedirectUrl(returnUrl: String?, url: String?) : Parcelable
instructions for authenticating by redirecting your customer to another page or application.
Refund
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Refund : Parcelable
Refund objects allow you to refund a charge that has previously been created but not yet refunded.
RefundParameters
Link copied to clipboard
class RefundParameters
The RefundParameters object allows you to set the options you need to create a refund for an existing charge.
Request3dSecureType
Link copied to clipboard
enum Request3dSecureType : Enum<Request3dSecureType>
3D Secure flow type.
SetupAttempt
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupAttempt : Parcelable
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful.
SetupAttemptStatus
Link copied to clipboard
enum SetupAttemptStatus : Enum<SetupAttemptStatus>
Statuses for a SetupAttempt
SetupAttemptUnion
Link copied to clipboard
sealed class SetupAttemptUnion : Parcelable
Union type for an expandable SetupAttempt.
SetupAttemptUnionJsonAdapter
Link copied to clipboard
class SetupAttemptUnionJsonAdapter
SetupError
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupError : Parcelable
Information for an erroneous SetupAttempt
SetupErrorType
Link copied to clipboard
enum SetupErrorType : Enum<SetupErrorType>
Types of SetupAttempt errors.
SetupIntent
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupIntent : Parcelable
A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.
SetupIntentCancellationParameters
Link copied to clipboard
class SetupIntentCancellationParameters
Parameters used for cancelling a SetupIntent.
SetupIntentCancellationReason
Link copied to clipboard
Reason for cancellation of a SetupIntent.
SetupIntentCardPresentDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupIntentCardPresentDetails : Parcelable
SetupIntentCardPresentDetails contains payment method details for a payment method of type CARD_PRESENT specifically for SetupIntent transaction.
SetupIntentNextAction
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupIntentNextAction(redirectToUrl: RedirectUrl?, type: String?) : Parcelable
Actions you need to take in order for your customer to continue payment setup.
SetupIntentParameters
Link copied to clipboard
class SetupIntentParameters
Parameters used for the creation of a new SetupIntent.
SetupIntentPaymentMethodDetails
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SetupIntentPaymentMethodDetails : Parcelable
PaymentMethodDetails contains details about the payment method used to complete a PaymentIntent It's different from CardPresentDetails.
SetupIntentStatus
Link copied to clipboard
enum SetupIntentStatus : Enum<SetupIntentStatus>
Represents the state of a SetupIntent.
SetupIntentUsage
Link copied to clipboard
enum SetupIntentUsage : Enum<SetupIntentUsage>
Indicates how the payment method is intended to be used in the future.
SimulatedCard
Link copied to clipboard
data class SimulatedCard
A SimulatedCard contains all information necessary to simulate the experience of paying with specific card brands / error conditions.
SimulatedCardType
Link copied to clipboard
enum SimulatedCardType : Enum<SimulatedCardType>
A SimulatedCardType represents a specific type of payment card that can be used for testing.
SimulateReaderUpdate
Link copied to clipboard
enum SimulateReaderUpdate : Enum<SimulateReaderUpdate>
The SimulateReaderUpdate enumerates the possible types of updates that a user might want to simulate.
SimulatorConfiguration
Link copied to clipboard
data class SimulatorConfiguration(update: SimulateReaderUpdate, simulatedCard: SimulatedCard)
A configuration object that can be set on the main Terminal class.
SingleUseMandate
Link copied to clipboard
data class SingleUseMandate(amount: Long, currency: String)
Used to generate a single-use Mandate when creating a SetupIntent
TerminalException
Link copied to clipboard
class TerminalException @JvmOverloads() constructor(errorCode: TerminalException.TerminalErrorCode, errorMessage: String, apiError: ApiError?) : Exception
A TerminalException represents an error thrown during SDK operations and will contain a TerminalErrorCode and an errorMessage to provide more specific details.