AccountObjects

Namespace for account domain model types.

Types

data class Account(val id: String?, val accountObject: String?, val type: AccountObjects.AccountType?, val status: AccountObjects.AccountStatus?, val externalId: String? = null, val metadata: Map<String, String>? = null, val termsOfService: AccountObjects.AccountTermsOfService? = null, val profile: AccountObjects.AccountProfile? = null, val capabilities: List<CapabilityObjects.Capability>? = null, val steps: List<AccountObjects.AccountStep>? = null, val created: Int?, val updated: Int?, val livemode: Boolean?)

Represents a Frame account belonging to a merchant or their sub-merchant.

data class AccountBillingAddress(val city: String? = null, val country: String? = null, val state: String? = null, val postalCode: String?, val addressLine1: String? = null, val addressLine2: String? = null)

A billing or mailing address associated with an account.

data class AccountPhoneNumber(val number: String?, val countryCode: String?)

A phone number associated with an account.

Profile information for an account, containing either business or individual data.

Lifecycle status of an account.

data class AccountStep(val key: String?, val status: String?, val label: String?, val fields: List<String>?, val currentlyDue: List<String>?)

A single onboarding or compliance step required for an account.

data class AccountTermsOfService(val token: String? = null, val acceptedAt: String? = null, val ipAddress: String? = null)

Terms-of-service acceptance record for an account.

Classifies whether an account belongs to an individual or a business.

data class BusinessAccount(val legalBusinessName: String?, val doingBusinessAs: String? = null, val businessType: String?, val email: String?, val website: String? = null, val description: String? = null, val einLastFour: String? = null, val mcc: String? = null, val naics: String? = null, val address: AccountObjects.AccountBillingAddress? = null, val phone: AccountObjects.AccountPhoneNumber? = null)

Business profile data for a business account.

data class IndividualAccount(val name: AccountObjects.IndividualAccountName? = null, val email: String? = null, val ssnLastFour: String? = null, val phoneNumber: String? = null, val phoneCountryCode: String? = null, val address: AccountObjects.AccountBillingAddress? = null, val birthdate: String? = null, val ssn: String? = null)

Individual profile data for a personal account.

data class IndividualAccountName(val firstName: String? = null, val middleName: String? = null, val lastName: String? = null, val suffix: String? = null)

The name components of an individual account holder.

data class PhoneVerification(val id: String?, val verificationObject: String?, val accountId: String?, val status: String?, val created: Int?, val updated: Int?, val livemode: Boolean?)

Represents a phone number verification attempt for an account.