Account

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.

Constructors

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

Properties

Link copied to clipboard
@SerializedName(value = "object")
val accountObject: String?

The API object type string (always "account").

Link copied to clipboard

List of payment capabilities enabled for this account.

Link copied to clipboard
val created: Int?

Unix timestamp of account creation.

Link copied to clipboard
@SerializedName(value = "external_id")
val externalId: String? = null

Merchant-assigned external identifier.

Link copied to clipboard
val id: String?

Unique account identifier.

Link copied to clipboard

true when the account exists in the live environment.

Link copied to clipboard
val metadata: Map<String, String>? = null

Arbitrary key-value pairs set by the merchant.

Link copied to clipboard

Business or individual profile data.

Link copied to clipboard

The current lifecycle status of the account.

Link copied to clipboard

Outstanding onboarding or compliance steps.

Link copied to clipboard
@SerializedName(value = "terms_of_service")
val termsOfService: AccountObjects.AccountTermsOfService? = null

Terms-of-service acceptance record.

Link copied to clipboard
Link copied to clipboard
val updated: Int?

Unix timestamp of the last account update.