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

PersonTokenParams

data class PersonTokenParams(val address: Address? = null, val addressKana: AddressJapanParams? = null, val addressKanji: AddressJapanParams? = null, val dateOfBirth: DateOfBirth? = null, val email: String? = null, val firstName: String? = null, val firstNameKana: String? = null, val firstNameKanji: String? = null, val gender: String? = null, val idNumber: String? = null, val lastName: String? = null, val lastNameKana: String? = null, val lastNameKanji: String? = null, val maidenName: String? = null, val metadata: Map<String, String>? = null, val phone: String? = null, val relationship: PersonTokenParams.Relationship? = null, val ssnLast4: String? = null, val verification: PersonTokenParams.Verification? = null) : TokenParams

Creates a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the documentation to learn more.

See Create a person token

Constructors

PersonTokenParams

constructor(address: Address? = null, addressKana: AddressJapanParams? = null, addressKanji: AddressJapanParams? = null, dateOfBirth: DateOfBirth? = null, email: String? = null, firstName: String? = null, firstNameKana: String? = null, firstNameKanji: String? = null, gender: String? = null, idNumber: String? = null, lastName: String? = null, lastNameKana: String? = null, lastNameKanji: String? = null, maidenName: String? = null, metadata: Map<String, String>? = null, phone: String? = null, relationship: PersonTokenParams.Relationship? = null, ssnLast4: String? = null, verification: PersonTokenParams.Verification? = null)

Types

Builder

class Builder : ObjectBuilder<PersonTokenParams>

Document

data class Document @JvmOverloads constructor(val front: String? = null, val back: String? = null) : StripeParamsModel, Parcelable

Relationship

data class Relationship(val director: Boolean? = null, val executive: Boolean? = null, val owner: Boolean? = null, val percentOwnership: Int? = null, val representative: Boolean? = null, val title: String? = null) : StripeParamsModel, Parcelable

The relationship that this person has with the account’s legal entity.

Verification

data class Verification @JvmOverloads constructor(val document: PersonTokenParams.Document? = null, val additionalDocument: PersonTokenParams.Document? = null) : StripeParamsModel, Parcelable

The person’s verification status.

Functions

describeContents

abstract fun describeContents(): Int

toParamMap

open override fun toParamMap(): Map<String, Any>

writeToParcel

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

Properties

address

val address: Address? = null

The person’s address.

addressKana

val addressKana: AddressJapanParams? = null

The Kana variation of the person’s address (Japan only).

addressKanji

val addressKanji: AddressJapanParams? = null

The Kanji variation of the person’s address (Japan only).

attribution

val attribution: Set<String>

dateOfBirth

val dateOfBirth: DateOfBirth? = null

The person’s date of birth.

val email: String? = null

The person’s email address.

firstName

val firstName: String? = null

The person’s first name.

firstNameKana

val firstNameKana: String? = null

The Kana variation of the person’s first name (Japan only).

firstNameKanji

val firstNameKanji: String? = null

The Kanji variation of the person’s first name (Japan only).

gender

val gender: String? = null

The person’s gender (International regulations require either “male” or “female”).

idNumber

val idNumber: String? = null

The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token.

lastName

val lastName: String? = null

The person’s last name.

lastNameKana

val lastNameKana: String? = null

The Kana variation of the person’s last name (Japan only).

lastNameKanji

val lastNameKanji: String? = null

The Kanji variation of the person’s last name (Japan only).

maidenName

val maidenName: String? = null

The person’s maiden name.

metadata

val metadata: Map<String, String>? = null

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

phone

val phone: String? = null

The person’s phone number.

relationship

val relationship: PersonTokenParams.Relationship? = null

The relationship that this person has with the account’s legal entity.

ssnLast4

val ssnLast4: String? = null

The last 4 digits of the person’s social security number.

tokenType

val tokenType: Token.Type

typeDataParams

open override val typeDataParams: Map<String, Any>

verification

val verification: PersonTokenParams.Verification? = null

The person’s verification status.