stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Person

Description

Contains the types generated from the schema Person

Synopsis

Documentation

data Person Source #

Defines the object schema located at components.schemas.person in the specification.

This is an object representing a person associated with a Stripe account.

A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

Related guide: Handling Identity Verification with the API.

Constructors

Person 

Fields

Instances

Instances details
Eq Person Source # 
Instance details

Defined in StripeAPI.Types.Person

Methods

(==) :: Person -> Person -> Bool #

(/=) :: Person -> Person -> Bool #

Show Person Source # 
Instance details

Defined in StripeAPI.Types.Person

ToJSON Person Source # 
Instance details

Defined in StripeAPI.Types.Person

FromJSON Person Source # 
Instance details

Defined in StripeAPI.Types.Person

mkPerson Source #

Create a new Person with all required fields.

data PersonAddressKana' Source #

Defines the object schema located at components.schemas.person.properties.address_kana.anyOf in the specification.

Constructors

PersonAddressKana' 

Fields

mkPersonAddressKana' :: PersonAddressKana' Source #

Create a new PersonAddressKana' with all required fields.

data PersonAddressKanji' Source #

Defines the object schema located at components.schemas.person.properties.address_kanji.anyOf in the specification.

Constructors

PersonAddressKanji' 

Fields

mkPersonAddressKanji' :: PersonAddressKanji' Source #

Create a new PersonAddressKanji' with all required fields.

data PersonPoliticalExposure' Source #

Defines the enum schema located at components.schemas.person.properties.political_exposure in the specification.

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.

Constructors

PersonPoliticalExposure'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PersonPoliticalExposure'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PersonPoliticalExposure'EnumExisting

Represents the JSON value "existing"

PersonPoliticalExposure'EnumNone

Represents the JSON value "none"

data PersonRequirements' Source #

Defines the object schema located at components.schemas.person.properties.requirements.anyOf in the specification.

Constructors

PersonRequirements' 

Fields

  • personRequirements'CurrentlyDue :: Maybe [Text]

    currently_due: Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.

  • personRequirements'Errors :: Maybe [AccountRequirementsError]

    errors: Fields that are `currently_due` and need to be collected again because validation or verification failed.

  • personRequirements'EventuallyDue :: Maybe [Text]

    eventually_due: Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.

  • personRequirements'PastDue :: Maybe [Text]

    past_due: Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.

  • personRequirements'PendingVerification :: Maybe [Text]

    pending_verification: Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.

mkPersonRequirements' :: PersonRequirements' Source #

Create a new PersonRequirements' with all required fields.