PaymentMethod

PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.Related guides: Payment Methods and More Payment Scenarios.See PaymentMethodCreateParams for PaymentMethod creation
data class PaymentMethod : StripeModel

Types

AuBecsDebit
Link copied to clipboard
data class AuBecsDebit : StripeModel
BacsDebit
Link copied to clipboard
data class BacsDebit : StripeModel
BillingDetails
Link copied to clipboard
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.billing_details
data class BillingDetails @JvmOverloads() constructor(address: Address?,email: String?,name: String?,phone: String?) : StripeModel, StripeParamsModel
Builder
Link copied to clipboard
class Builder : ObjectBuilder
Card
Link copied to clipboard
If this is a card PaymentMethod, this hash contains details about the card.card
data class Card : StripeModel
CardPresent
Link copied to clipboard
If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.card_present
data class CardPresent : StripeModel
Companion
Link copied to clipboard
object Companion
Fpx
Link copied to clipboard
Requires the FPX payment method enabled on your account via https://dashboard.stripe.com/account/payments/settings.To obtain the FPX bank's display name and icon, see com.stripe.android.view.FpxBank.
data class Fpx : StripeModel
Ideal
Link copied to clipboard
If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.ideal
data class Ideal : StripeModel
Netbanking
Link copied to clipboard
data class Netbanking : StripeModel
SepaDebit
Link copied to clipboard
If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.sepa_debit
data class SepaDebit : StripeModel
Sofort
Link copied to clipboard
data class Sofort : StripeModel
Type
Link copied to clipboard
enum Type : Enum, Parcelable
Upi
Link copied to clipboard
data class Upi : StripeModel

Functions

component1
Link copied to clipboard
operator fun component1(): String?
component10
Link copied to clipboard
operator fun component10(): PaymentMethod.Fpx?
component11
Link copied to clipboard
operator fun component11(): PaymentMethod.Ideal?
component12
Link copied to clipboard
operator fun component12(): PaymentMethod.SepaDebit?
component13
Link copied to clipboard
operator fun component13(): PaymentMethod.AuBecsDebit?
component14
Link copied to clipboard
operator fun component14(): PaymentMethod.BacsDebit?
component15
Link copied to clipboard
operator fun component15(): PaymentMethod.Sofort?
component16
Link copied to clipboard
operator fun component16(): PaymentMethod.Upi?
component2
Link copied to clipboard
operator fun component2(): Long?
component3
Link copied to clipboard
operator fun component3(): Boolean
component4
Link copied to clipboard
operator fun component4(): PaymentMethod.Type?
component5
Link copied to clipboard
operator fun component5(): PaymentMethod.BillingDetails?
component6
Link copied to clipboard
operator fun component6(): String?
component7
Link copied to clipboard
operator fun component7(): Map<String, String>?
component8
Link copied to clipboard
operator fun component8(): PaymentMethod.Card?
component9
Link copied to clipboard
operator fun component9(): PaymentMethod.CardPresent?
copy
Link copied to clipboard
fun copy(id: String?, created: Long?, liveMode: Boolean, type: PaymentMethod.Type?, billingDetails: PaymentMethod.BillingDetails?, customerId: String?, metadata: Map<String, String>?, card: PaymentMethod.Card?, cardPresent: PaymentMethod.CardPresent?, fpx: PaymentMethod.Fpx?, ideal: PaymentMethod.Ideal?, sepaDebit: PaymentMethod.SepaDebit?, auBecsDebit: PaymentMethod.AuBecsDebit?, bacsDebit: PaymentMethod.BacsDebit?, sofort: PaymentMethod.Sofort?, upi: PaymentMethod.Upi?): PaymentMethod
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
toString
Link copied to clipboard
open override fun toString(): String
writeToParcel
Link copied to clipboard
abstract override fun writeToParcel(p0: Parcel, p1: Int)

Properties

auBecsDebit
Link copied to clipboard
val auBecsDebit: PaymentMethod.AuBecsDebit?
bacsDebit
Link copied to clipboard
val bacsDebit: PaymentMethod.BacsDebit?
billingDetails
Link copied to clipboard
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.billing_details
val billingDetails: PaymentMethod.BillingDetails?
card
Link copied to clipboard
If this is a card PaymentMethod, this hash contains details about the card.card
val card: PaymentMethod.Card?
cardPresent
Link copied to clipboard
If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.card_present
val cardPresent: PaymentMethod.CardPresent?
created
Link copied to clipboard
Time at which the object was created. Measured in seconds since the Unix epoch.created
val created: Long?
customerId
Link copied to clipboard
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.customer
val customerId: String?
fpx
Link copied to clipboard
If this is a fpx PaymentMethod, this hash contains details about the FPX payment method.
val fpx: PaymentMethod.Fpx?
id
Link copied to clipboard
Unique identifier for the object.id
val id: String?
ideal
Link copied to clipboard
If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.ideal
val ideal: PaymentMethod.Ideal?
liveMode
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.livemode
val liveMode: Boolean
metadata
Link copied to clipboard
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.metadata
val metadata: Map<String, String>?
sepaDebit
Link copied to clipboard
If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.sepa_debit
val sepaDebit: PaymentMethod.SepaDebit?
sofort
Link copied to clipboard
val sofort: PaymentMethod.Sofort?
type
Link copied to clipboard
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.type
val type: PaymentMethod.Type?
upi
Link copied to clipboard
val upi: PaymentMethod.Upi?