FrameObjects

Common Frame API domain objects shared across multiple SDK modules.

Types

data class BankAccount(val accountType: FrameObjects.PaymentAccountType?, val bankName: String?, val accountNumber: String?, val routingNumber: String?, val lastFour: String?)

Bank account details for a payment method of type PaymentMethodType.ACH.

data class BillingAddress(val city: String?, val country: String?, val state: String?, val postalCode: String?, val addressLine1: String?, val addressLine2: String?)

A postal billing or shipping address.

data class Customer(val id: String?, val created: Int?, val updated: Int?, val livemode: Boolean?, val name: String?, val status: FrameObjects.CustomerStatus?, val phone: String?, val email: String?, val description: String?, val dateOfBirth: String?, val customerObject: String?, val shippingAddress: FrameObjects.BillingAddress?, val billingAddress: FrameObjects.BillingAddress?, val paymentMethods: List<FrameObjects.PaymentMethod>?)

A customer record on the Frame platform.

Lifecycle status of a customer on the Frame platform.

The type of a bank account used for ACH payments.

data class PaymentCard(val brand: String?, val expirationMonth: String?, val expirationYear: String?, val issuer: String?, val currency: String?, val segment: String?, val type: String?, val lastFourDigits: String?, val wallet: FrameObjects.Wallet? = null)

Card details for a payment method of type PaymentMethodType.CARD.

data class PaymentMethod(val id: String?, val customerId: String? = null, val billing: FrameObjects.BillingAddress?, val type: FrameObjects.PaymentMethodType?, val methodObject: String?, val created: Int?, val updated: Int?, val livemode: Boolean?, val card: FrameObjects.PaymentCard?, val ach: FrameObjects.BankAccount?, val status: FrameObjects.PaymentMethodStatus?)

A payment method stored on the Frame platform.

Lifecycle status of a payment method on the Frame platform.

The funding instrument type of a payment method.

data class Wallet(val type: FrameObjects.WalletType?, val dynamicLast4: String?)

Digital wallet details for a card tokenized through Apple Pay or Google Pay.

The digital wallet type that tokenized a card.