FrameSDK/com.framepayments.framesdk.chargeintents/ChargeIntent

ChargeIntent

data class ChargeIntent(val id: String?, val currency: String?, val customer: FrameObjects.Customer?, val shipping: FrameObjects.BillingAddress?, val status: ChargeIntentStatus?, val description: String?, val amount: Int?, val created: Int?, val updated: Int?, val livemode: Boolean?, val latestCharge: LatestCharge?, val paymentMethod: FrameObjects.PaymentMethod?, val authorizationMode: AuthorizationMode?, val failureDescription: String?, val intentObject: String?)

Represents a charge intent returned by the Frame API.

Constructors

constructor(id: String?, currency: String?, customer: FrameObjects.Customer?, shipping: FrameObjects.BillingAddress?, status: ChargeIntentStatus?, description: String?, amount: Int?, created: Int?, updated: Int?, livemode: Boolean?, latestCharge: LatestCharge?, paymentMethod: FrameObjects.PaymentMethod?, authorizationMode: AuthorizationMode?, failureDescription: String?, intentObject: String?)

Properties

val amount: Int?

Total amount in the smallest currency unit (e.g., cents).

authorizationMode

@SerializedName(value = "authorization_mode")

val authorizationMode: AuthorizationMode?

Whether funds are captured automatically or held for manual capture.

val created: Int?

Unix timestamp of when the charge intent was created.

val currency: String?

Three-letter ISO 4217 currency code.

val customer: FrameObjects.Customer?

The customer associated with this charge intent.

val description: String?

Merchant-supplied description of the charge.

failureDescription

@SerializedName(value = "failure_description")

val failureDescription: String?

Human-readable explanation of why the charge intent failed, if applicable.

val id: String?

Unique identifier for the charge intent.

@SerializedName(value = "object")

val intentObject: String?

The object type identifier returned by the API (typically "charge_intent").

@SerializedName(value = "latest_charge")

val latestCharge: LatestCharge?

The most recent charge attempt associated with this intent.

val livemode: Boolean?

true if this charge intent was created in live mode; false for test mode.

@SerializedName(value = "payment_method")

val paymentMethod: FrameObjects.PaymentMethod?

The payment method attached to this charge intent.

val shipping: FrameObjects.BillingAddress?

The shipping address for the order.

val status: ChargeIntentStatus?

Current lifecycle status of the charge intent.

val updated: Int?

Unix timestamp of when the charge intent was last updated.