Module token

Source

Structs§

CreateToken
Creates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.
CreateTokenAccount
Information for the account this token represents.
CreateTokenAccountCompany
Information about the company or business.
CreateTokenAccountCompanyAddress
The company’s primary address.
CreateTokenAccountCompanyAddressKana
The Kana variation of the company’s primary address (Japan only).
CreateTokenAccountCompanyAddressKanji
The Kanji variation of the company’s primary address (Japan only).
CreateTokenAccountCompanyDirectorshipDeclaration
This hash is used to attest that the directors information provided to Stripe is both current and correct.
CreateTokenAccountCompanyOwnershipDeclaration
This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
CreateTokenAccountCompanyRegistrationDate
CreateTokenAccountCompanyVerification
Information on the verification state of the company.
CreateTokenAccountCompanyVerificationDocument
A document verifying the business.
CreateTokenAccountIndividual
Information about the person represented by the account.
CreateTokenAccountIndividualAddress
The individual’s primary address.
CreateTokenAccountIndividualAddressKana
The Kana variation of the individual’s primary address (Japan only).
CreateTokenAccountIndividualAddressKanji
The Kanji variation of the individual’s primary address (Japan only).
CreateTokenAccountIndividualRegisteredAddress
The individual’s registered address.
CreateTokenAccountIndividualRelationship
Describes the person’s relationship to the account.
CreateTokenBankAccount
The bank account this token will represent.
CreateTokenCreditCardSpecs
The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user’s credit card details, with the options described below.
CreateTokenCreditCardSpecsNetworks
Contains information about card networks used to process the payment.
CreateTokenCvcUpdate
The updated CVC value this token represents.
CreateTokenPerson
Information for the person this token represents.
CreateTokenPersonAdditionalTosAcceptances
Details on the legal guardian’s or authorizer’s acceptance of the required Stripe agreements.
CreateTokenPersonAdditionalTosAcceptancesAccount
Details on the legal guardian’s acceptance of the main Stripe service agreement.
CreateTokenPersonAddress
The person’s address.
CreateTokenPersonAddressKana
The Kana variation of the person’s address (Japan only).
CreateTokenPersonAddressKanji
The Kanji variation of the person’s address (Japan only).
CreateTokenPersonDocuments
Documents that may be submitted to satisfy various informational requests.
CreateTokenPersonRegisteredAddress
The person’s registered address.
CreateTokenPersonRelationship
The relationship that this person has with the account’s legal entity.
CreateTokenPersonUsCfpbData
Demographic data related to the person.
CreateTokenPersonUsCfpbDataEthnicityDetails
The persons ethnicity details
CreateTokenPersonUsCfpbDataRaceDetails
The persons race details
CreateTokenPii
The PII this token represents.
DateOfBirthSpecs
DocumentsParam
PersonVerificationDocumentSpecs
PersonVerificationSpecs
RetrieveToken
Retrieves the token with the given ID.

Enums§

CreateTokenAccountBusinessType
The business type.
CreateTokenAccountCompanyOwnershipExemptionReason
This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details.
CreateTokenAccountCompanyStructure
The category identifying the legal structure of the company or legal entity. See Business structure for more details. Pass an empty string to unset this value.
CreateTokenAccountIndividualPoliticalExposure
Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
CreateTokenBankAccountAccountHolderType
The type of entity that holds the account. It can be company or individual. This field is required when attaching the bank account to a Customer object.
CreateTokenBankAccountAccountType
The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
CreateTokenCard
The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user’s credit card details, with the options described below.
CreateTokenCreditCardSpecsNetworksPreferred
The customer’s preferred card network for co-branded cards. Supports cartes_bancaires, mastercard, or visa. Selection of a network that does not apply to the card will be stored as invalid_preference on the card.
CreateTokenPersonPoliticalExposure
Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
CreateTokenPersonUsCfpbDataEthnicityDetailsEthnicity
The persons ethnicity
CreateTokenPersonUsCfpbDataRaceDetailsRace
The persons race.