PaymentIntent

A PaymentIntent tracks the process of collecting a payment from your customer.
data class PaymentIntent : StripeIntent

Types

CancellationReason
Link copied to clipboard
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).
enum CancellationReason : Enum
CaptureMethod
Link copied to clipboard
Controls when the funds will be captured from the customer’s account.
enum CaptureMethod : Enum
Companion
Link copied to clipboard
object Companion
ConfirmationMethod
Link copied to clipboard
enum ConfirmationMethod : Enum
Error
Link copied to clipboard
The payment error encountered in the previous PaymentIntent confirmation.See last_payment_error.
data class Error : StripeModel
Shipping
Link copied to clipboard
Shipping information for this PaymentIntent.See shipping
data class Shipping(address: Address,carrier: String?,name: String?,phone: String?,trackingNumber: String?) : StripeModel

Functions

component1
Link copied to clipboard
operator fun component1(): String?
component10
Link copied to clipboard
operator fun component10(): String?
component11
Link copied to clipboard
operator fun component11(): String?
component12
Link copied to clipboard
operator fun component12(): Boolean
component13
Link copied to clipboard
operator fun component13(): Map<String, Any??>?
component14
Link copied to clipboard
operator fun component14(): PaymentMethod?
component15
Link copied to clipboard
operator fun component15(): String?
component16
Link copied to clipboard
operator fun component16(): String?
component17
Link copied to clipboard
operator fun component17(): StripeIntent.Status?
component19
Link copied to clipboard
operator fun component19(): PaymentIntent.Error?
component2
Link copied to clipboard
operator fun component2(): List<String>
component20
Link copied to clipboard
operator fun component20(): PaymentIntent.Shipping?
component21
Link copied to clipboard
operator fun component21(): StripeIntent.NextActionData?
component3
Link copied to clipboard
operator fun component3(): Long?
component4
Link copied to clipboard
operator fun component4(): Long
component5
Link copied to clipboard
operator fun component5(): PaymentIntent.CancellationReason?
component6
Link copied to clipboard
operator fun component6(): PaymentIntent.CaptureMethod
component7
Link copied to clipboard
operator fun component7(): String?
component8
Link copied to clipboard
operator fun component8(): PaymentIntent.ConfirmationMethod
component9
Link copied to clipboard
operator fun component9(): Long
copy
Link copied to clipboard
fun copy(id: String?, paymentMethodTypes: List<String>, amount: Long?, canceledAt: Long, cancellationReason: PaymentIntent.CancellationReason?, captureMethod: PaymentIntent.CaptureMethod, clientSecret: String?, confirmationMethod: PaymentIntent.ConfirmationMethod, created: Long, currency: String?, description: String?, isLiveMode: Boolean, nextAction: Map<String, Any??>?, paymentMethod: PaymentMethod?, paymentMethodId: String?, receiptEmail: String?, status: StripeIntent.Status?, setupFutureUsage: StripeIntent.Usage?, lastPaymentError: PaymentIntent.Error?, shipping: PaymentIntent.Shipping?, nextActionData: StripeIntent.NextActionData?): PaymentIntent
describeContents
Link copied to clipboard
abstract override fun describeContents(): Int
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
requiresAction
Link copied to clipboard
open override fun requiresAction(): Boolean
requiresConfirmation
Link copied to clipboard
open override fun requiresConfirmation(): Boolean
toString
Link copied to clipboard
open override fun toString(): String
writeToParcel
Link copied to clipboard
abstract override fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount
Link copied to clipboard
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).
val amount: Long?
canceledAt
Link copied to clipboard
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.
val canceledAt: Long
cancellationReason
Link copied to clipboard
Reason for cancellation of this PaymentIntent.
val cancellationReason: PaymentIntent.CancellationReason?
captureMethod
Link copied to clipboard
Controls when the funds will be captured from the customer’s account. See CaptureMethod.
val captureMethod: PaymentIntent.CaptureMethod
clientSecret
Link copied to clipboard
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
open override val clientSecret: String?
confirmationMethod
Link copied to clipboard
One of automatic (default) or manual. See ConfirmationMethod.When confirmationMethod 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.When confirmationMethod is manual, all payment attempts must be made using a secret key. The PaymentIntent returns to the RequiresConfirmation state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.
val confirmationMethod: PaymentIntent.ConfirmationMethod
created
Link copied to clipboard
Time at which the object was created. Measured in seconds since the Unix epoch.
open override val created: Long
currency
Link copied to clipboard
Three-letter ISO currency code, in lowercase. Must be a supported currency.
val currency: String?
description
Link copied to clipboard
An arbitrary string attached to the object. Often useful for displaying to users.
open override val description: String?
id
Link copied to clipboard
Unique identifier for the object.
open override val id: String?
isLiveMode
Link copied to clipboard
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
open override val isLiveMode: Boolean
lastPaymentError
Link copied to clipboard
The payment error encountered in the previous PaymentIntent confirmation.
val lastPaymentError: PaymentIntent.Error?
nextAction
Link copied to clipboard
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
val nextAction: Map<String, Any??>?
nextActionData
Link copied to clipboard
open override val nextActionData: StripeIntent.NextActionData?
nextActionType
Link copied to clipboard
open override val nextActionType: StripeIntent.NextActionType?
paymentMethod
Link copied to clipboard
The expanded PaymentMethod represented by paymentMethodId.
open override val paymentMethod: PaymentMethod?
paymentMethodId
Link copied to clipboard
ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.
open override val paymentMethodId: String?
paymentMethodTypes
Link copied to clipboard
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
open override val paymentMethodTypes: List<String>
receiptEmail
Link copied to clipboard
Email address that the receipt for the resulting payment will be sent to.
val receiptEmail: String?
shipping
Link copied to clipboard
Shipping information for this PaymentIntent.
val shipping: PaymentIntent.Shipping?
status
Link copied to clipboard
Status of this PaymentIntent.
open override val status: StripeIntent.Status?