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

PaymentMethod

data class PaymentMethod @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val created: Long?, val liveMode: Boolean, code: PaymentMethodCode?, val type: PaymentMethod.Type?, val billingDetails: PaymentMethod.BillingDetails? = null, val customerId: String? = null, val card: PaymentMethod.Card? = null, val cardPresent: PaymentMethod.CardPresent? = null, val fpx: PaymentMethod.Fpx? = null, val ideal: PaymentMethod.Ideal? = null, val sepaDebit: PaymentMethod.SepaDebit? = null, val auBecsDebit: PaymentMethod.AuBecsDebit? = null, val bacsDebit: PaymentMethod.BacsDebit? = null, val sofort: PaymentMethod.Sofort? = null, val upi: PaymentMethod.Upi? = null, val netbanking: PaymentMethod.Netbanking? = null, val usBankAccount: PaymentMethod.USBankAccount? = null) : StripeModel

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

Constructors

PaymentMethod

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

constructor(id: String?, created: Long?, liveMode: Boolean, code: PaymentMethodCode?, type: PaymentMethod.Type?, billingDetails: PaymentMethod.BillingDetails? = null, customerId: String? = null, card: PaymentMethod.Card? = null, cardPresent: PaymentMethod.CardPresent? = null, fpx: PaymentMethod.Fpx? = null, ideal: PaymentMethod.Ideal? = null, sepaDebit: PaymentMethod.SepaDebit? = null, auBecsDebit: PaymentMethod.AuBecsDebit? = null, bacsDebit: PaymentMethod.BacsDebit? = null, sofort: PaymentMethod.Sofort? = null, upi: PaymentMethod.Upi? = null, netbanking: PaymentMethod.Netbanking? = null, usBankAccount: PaymentMethod.USBankAccount? = null)

Types

AuBecsDebit

data class AuBecsDebit @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val bsbNumber: String?, val fingerprint: String?, val last4: String?) : PaymentMethod.TypeData

BacsDebit

data class BacsDebit : PaymentMethod.TypeData

BillingDetails

data class BillingDetails @JvmOverloads constructor(val address: Address? = null, val email: String? = null, val name: String? = null, val phone: String? = null) : StripeModel, StripeParamsModel

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

Builder

class Builder : ObjectBuilder<PaymentMethod>

Card

data class Card @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val brand: CardBrand = CardBrand.Unknown, val checks: PaymentMethod.Card.Checks? = null, val country: String? = null, val expiryMonth: Int? = null, val expiryYear: Int? = null, val fingerprint: String? = null, val funding: String? = null, val last4: String? = null, val threeDSecureUsage: PaymentMethod.Card.ThreeDSecureUsage? = null, val wallet: Wallet? = null, val networks: PaymentMethod.Card.Networks? = null) : PaymentMethod.TypeData

If this is a card PaymentMethod, this hash contains details about the card.

CardPresent

data class CardPresent : PaymentMethod.TypeData

If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.

Companion

object Companion

Fpx

data class Fpx : PaymentMethod.TypeData

Requires the FPX payment method enabled on your account via https://dashboard.stripe.com/account/payments/settings.

Ideal

data class Ideal : PaymentMethod.TypeData

If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

Netbanking

data class Netbanking : PaymentMethod.TypeData

SepaDebit

data class SepaDebit : PaymentMethod.TypeData

If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

Sofort

data class Sofort : PaymentMethod.TypeData

Type

enum Type : Enum<PaymentMethod.Type> , Parcelable

TypeData

sealed class TypeData : StripeModel

USBankAccount

data class USBankAccount @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val accountHolderType: PaymentMethod.USBankAccount.USBankAccountHolderType, val accountType: PaymentMethod.USBankAccount.USBankAccountType, val bankName: String?, val fingerprint: String?, val last4: String?, val linkedAccount: String?, val networks: PaymentMethod.USBankAccount.USBankNetworks?, val routingNumber: String?) : PaymentMethod.TypeData

Upi

data class Upi : PaymentMethod.TypeData

Functions

describeContents

abstract fun describeContents(): Int

hasExpectedDetails

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

fun hasExpectedDetails(): Boolean

writeToParcel

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

Properties

auBecsDebit

@JvmField

val auBecsDebit: PaymentMethod.AuBecsDebit? = null

If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

bacsDebit

@JvmField

val bacsDebit: PaymentMethod.BacsDebit? = null

If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

billingDetails

@JvmField

val billingDetails: PaymentMethod.BillingDetails? = null

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

card

@JvmField

val card: PaymentMethod.Card? = null

If this is a card PaymentMethod, this hash contains details about the card.

cardPresent

@JvmField

val cardPresent: PaymentMethod.CardPresent? = null

If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.

created

@JvmField

val created: Long?

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

customerId

@JvmField

val customerId: String? = null

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.

fpx

@JvmField

val fpx: PaymentMethod.Fpx? = null

If this is a fpx PaymentMethod, this hash contains details about the FPX payment method.

@JvmField

val id: String?

Unique identifier for the object.

ideal

@JvmField

val ideal: PaymentMethod.Ideal? = null

If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

liveMode

@JvmField

val liveMode: Boolean

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

netbanking

@JvmField

val netbanking: PaymentMethod.Netbanking? = null

sepaDebit

@JvmField

val sepaDebit: PaymentMethod.SepaDebit? = null

If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

sofort

@JvmField

val sofort: PaymentMethod.Sofort? = null

If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

type

@JvmField

val type: PaymentMethod.Type?

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.

upi

@JvmField

val upi: PaymentMethod.Upi? = null

usBankAccount

@JvmField

val usBankAccount: PaymentMethod.USBankAccount? = null

If this is an us_bank_account PaymentMethod, this hash contains details about the bank account.