PaymentIntent

@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. 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
Link copied to clipboard
abstract fun describeContents(): Int
getCharges
Link copied to clipboard
fun getCharges(): List<Charge>
Return the Charge objects associated with this PaymentIntent
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount
Link copied to clipboard
val amount: Long = 0
Get the amount of the PaymentIntent
amountCapturable
Link copied to clipboard
val amountCapturable: Long = 0
Amount that can be captured from this PaymentIntent
amountReceived
Link copied to clipboard
val amountReceived: Long = 0
Amount that was collected by this PaymentIntent.
application
Link copied to clipboard
val application: String? = null
ID of the Connect application that created the PaymentIntent
applicationFeeAmount
Link copied to clipboard
val applicationFeeAmount: Long = 0
The amount of the application fee for this PaymentIntent
canceledAt
Link copied to clipboard
val canceledAt: Long = 0
Populated when status is PaymentIntentStatus.CANCELED, this is the time at which the PaymentIntent was canceled.
cancellationReason
Link copied to clipboard
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
Link copied to clipboard
val captureMethod: String? = null
One of automatic (default) or manual.
clientSecret
Link copied to clipboard
val clientSecret: String? = null
Get the client secret returned by this intent.
confirmationMethod
Link copied to clipboard
val confirmationMethod: String? = null
One of automatic (default) or manual.
created
Link copied to clipboard
val created: Long = 0
Time at which the PaymentIntent was created.
currency
Link copied to clipboard
val currency: String? = null
Three-letter ISO currency code, in lowercase.
customer
Link copied to clipboard
val customer: String? = null
ID of the Customer this PaymentIntent belongs to, if one exists.
description
Link copied to clipboard
val description: String? = null
An arbitrary string attached to the PaymentIntent.
id
Link copied to clipboard
val id: String
Get the unique identifier for the PaymentIntent
invoice
Link copied to clipboard
val invoice: String? = null
ID of the invoice that created this PaymentIntent, if it exists.
lastPaymentError
Link copied to clipboard
val lastPaymentError: ApiError? = null
The payment error encountered in the previous PaymentIntent confirmation.
livemode
Link copied to clipboard
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
Link copied to clipboard
val metadata: Map<String, String>? = null
Set of key-value pairs that you can attach to an object.
onBehalfOf
Link copied to clipboard
val onBehalfOf: String? = null
Return the account that the PaymentIntent is on behalf of
paymentMethodData
Link copied to clipboard
var paymentMethodData: PaymentMethodData? = null
paymentMethodId
Link copied to clipboard
val paymentMethodId: String? = null
ID of the payment method used in this PaymentIntent.
receiptEmail
Link copied to clipboard
val receiptEmail: String? = null
Email address that the receipt for the resulting payment will be sent to.
review
Link copied to clipboard
val review: String? = null
ID of the review associated with this PaymentIntent, if any.
setupFutureUsage
Link copied to clipboard
val setupFutureUsage: String? = null
Value of setup_future_usage associated with this PaymentIntent, if any.
statementDescriptor
Link copied to clipboard
val statementDescriptor: String? = null
Extra information about a PaymentIntent.
status
Link copied to clipboard
var status: PaymentIntentStatus? = null
Status of this PaymentIntent.
transferGroup
Link copied to clipboard
val transferGroup: String? = null
Get the transfer group of this PaymentIntent