external/com.stripe.stripeterminal.external.models/PaymentIntent

PaymentIntent

@JsonClass(generateAdapter = true)

The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each PaymentIntent typically correlates with a single “cart” or customer session in your application.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Functions

describeContents

abstract fun describeContents(): Int

getCharges

fun getCharges(): List<Charge>

Return the Charge objects associated with this PaymentIntent

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount

val amount: Long = 0

Get the amount of the PaymentIntent

amountCapturable

val amountCapturable: Long = 0

Amount that can be captured from this PaymentIntent

amountDetails

val amountDetails: AmountDetails? = null

Details about items included in the amount

amountReceived

val amountReceived: Long = 0

Amount that was collected by this PaymentIntent.

amountTip

val amountTip: Long? = null

Indicates how much the user intends to tip in addition to the amount by at confirmation time.

application

val application: String? = null

ID of the Connect application that created the PaymentIntent

applicationFeeAmount

val applicationFeeAmount: Long = 0

The amount of the application fee for this PaymentIntent

canceledAt

val canceledAt: Long = 0

Populated when status is PaymentIntentStatus.CANCELED, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

cancellationReason

val cancellationReason: String? = null

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

captureMethod

val captureMethod: String? = null

One of automatic (default) or manual. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.

clientSecret

val clientSecret: String? = null

Get the client secret returned by this intent.

confirmationMethod

val confirmationMethod: String? = null

One of automatic (default) or manual. When the confirmation method is automatic, a PaymentIntent can be confirmed using a publishable key. After next_actions are handled, no additional confirmation is required to complete the payment.

created

val created: Long = 0

Time at which the PaymentIntent was created. Measured in seconds since the Unix epoch.

currency

val currency: String? = null

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer

val customer: String? = null

ID of the Customer this PaymentIntent belongs to, if one exists. If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.

description

val description: String? = null

An arbitrary string attached to the PaymentIntent. Often useful for displaying to users.

val id: String

Get the unique identifier for the PaymentIntent

invoice

val invoice: String? = null

ID of the invoice that created this PaymentIntent, if it exists.

lastPaymentError

val lastPaymentError: ApiError? = null

The payment error encountered in the previous PaymentIntent confirmation.

livemode

val livemode: Boolean = false

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

val metadata: Map<String, String>? = null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the PaymentIntent in a structured format.

onBehalfOf

val onBehalfOf: String? = null

Return the account that the PaymentIntent is on behalf of

paymentMethod

@Transient

val paymentMethod: PaymentMethod?

Full payment method object from the API.

paymentMethodData

@Transient

var paymentMethodData: PaymentMethodData? = null

paymentMethodId

@Transient

val paymentMethodId: String?

ID of the payment method used in this PaymentIntent.

paymentMethodOptions

val paymentMethodOptions: PaymentMethodOptions? = null

PaymentMethod options configured on the payment intent

receiptEmail

val receiptEmail: String? = null

Email address that the receipt for the resulting payment will be sent to.

review

val review: String? = null

ID of the review associated with this PaymentIntent, if any.

setupFutureUsage

val setupFutureUsage: String? = null

Value of setup_future_usage associated with this PaymentIntent, if any.

statementDescriptor

val statementDescriptor: String? = null

Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

statementDescriptorSuffix

val statementDescriptorSuffix: String? = null

Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on your customer’s statement when this PaymentIntent succeeds in creating a charge.

status

var status: PaymentIntentStatus? = null

Status of this PaymentIntent.

stripeAccountId

@Transient

val stripeAccountId: String? = null

When set, the connected account ID which created the PaymentIntent.

transferGroup

val transferGroup: String? = null

Get the transfer group of this PaymentIntent