payments-core/com.stripe.android.model/PaymentIntent

PaymentIntent

data class PaymentIntent @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val paymentMethodTypes: List<String>, val amount: Long?, val canceledAt: Long = 0, val cancellationReason: PaymentIntent.CancellationReason? = null, val captureMethod: PaymentIntent.CaptureMethod = CaptureMethod.Automatic, val clientSecret: String?, val confirmationMethod: PaymentIntent.ConfirmationMethod = ConfirmationMethod.Automatic, val countryCode: String?, val created: Long, val currency: String?, val description: String? = null, val isLiveMode: Boolean, val paymentMethod: PaymentMethod? = null, val paymentMethodId: String? = null, val receiptEmail: String? = null, val status: StripeIntent.Status? = null, val setupFutureUsage: StripeIntent.Usage? = null, val lastPaymentError: PaymentIntent.Error? = null, val shipping: PaymentIntent.Shipping? = null, val unactivatedPaymentMethods: List<String>, val linkFundingSources: List<String> = emptyList(), val nextActionData: StripeIntent.NextActionData? = null, paymentMethodOptionsJsonString: String? = null) : StripeIntent

A PaymentIntent tracks the process of collecting a payment from your customer.

Constructors

PaymentIntent

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

constructor(id: String?, paymentMethodTypes: List<String>, amount: Long?, canceledAt: Long = 0, cancellationReason: PaymentIntent.CancellationReason? = null, captureMethod: PaymentIntent.CaptureMethod = CaptureMethod.Automatic, clientSecret: String?, confirmationMethod: PaymentIntent.ConfirmationMethod = ConfirmationMethod.Automatic, countryCode: String?, created: Long, currency: String?, description: String? = null, isLiveMode: Boolean, paymentMethod: PaymentMethod? = null, paymentMethodId: String? = null, receiptEmail: String? = null, status: StripeIntent.Status? = null, setupFutureUsage: StripeIntent.Usage? = null, lastPaymentError: PaymentIntent.Error? = null, shipping: PaymentIntent.Shipping? = null, unactivatedPaymentMethods: List<String>, linkFundingSources: List<String> = emptyList(), nextActionData: StripeIntent.NextActionData? = null, paymentMethodOptionsJsonString: String? = null)

Types

CancellationReason

enum CancellationReason : Enum<PaymentIntent.CancellationReason>

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

enum CaptureMethod : Enum<PaymentIntent.CaptureMethod>

Controls when the funds will be captured from the customer’s account.

Companion

object Companion

ConfirmationMethod

enum ConfirmationMethod : Enum<PaymentIntent.ConfirmationMethod>

Error

data class Error : StripeModel

The payment error encountered in the previous PaymentIntent confirmation.

Shipping

data class Shipping(val address: Address, val carrier: String? = null, val name: String? = null, val phone: String? = null, val trackingNumber: String? = null) : StripeModel

Shipping information for this PaymentIntent.

Functions

describeContents

abstract fun describeContents(): Int

getPaymentMethodOptions

fun getPaymentMethodOptions(): Map<String, Any?>

isLpmLevelSetupFutureUsageSet

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun isLpmLevelSetupFutureUsageSet(code: PaymentMethodCode): Boolean

requiresAction

open override fun requiresAction(): Boolean

requiresConfirmation

open override fun requiresConfirmation(): Boolean

writeToParcel

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

Properties

amount

val amount: Long?

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

canceledAt

val canceledAt: Long = 0

Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. If unavailable, will return 0.

cancellationReason

val cancellationReason: PaymentIntent.CancellationReason? = null

Reason for cancellation of this PaymentIntent.

captureMethod

val captureMethod: PaymentIntent.CaptureMethod

Controls when the funds will be captured from the customer’s account. See CaptureMethod.

clientSecret

open override val clientSecret: String?

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

confirmationMethod

val confirmationMethod: PaymentIntent.ConfirmationMethod

One of automatic (default) or manual. See ConfirmationMethod.