FrameSDK/com.framepayments.framesdk.chargeintents/ChargeIntentsRequests/CreateChargeIntentRequest

CreateChargeIntentRequest

data class CreateChargeIntentRequest(val amount: Int, val currency: String, val customer: String?, val description: String?, val confirm: Boolean, val paymentMethod: String?, val receiptEmail: String?, val authorizationMode: AuthorizationMode?, val customerData: ChargeIntentsRequests.CustomerData?, val paymentMethodData: ChargeIntentsRequests.PaymentMethodData?, var fraudSignals: ChargeIntentsRequests.FraudSignals? = null, val useFrameSDK: Boolean = true, var sonarSessionId: String? = null)

Request body for creating a new charge intent.

Constructors

constructor(amount: Int, currency: String, customer: String?, description: String?, confirm: Boolean, paymentMethod: String?, receiptEmail: String?, authorizationMode: AuthorizationMode?, customerData: ChargeIntentsRequests.CustomerData?, paymentMethodData: ChargeIntentsRequests.PaymentMethodData?, fraudSignals: ChargeIntentsRequests.FraudSignals? = null, useFrameSDK: Boolean = true, sonarSessionId: String? = null)

Properties

amount

val amount: Int

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

authorizationMode

@SerializedName(value = "authorization_mode")

val authorizationMode: AuthorizationMode?

Whether to capture funds automatically or hold them for manual capture.

confirm

val confirm: Boolean

true to confirm and process the charge intent immediately upon creation.

currency

val currency: String

Three-letter ISO 4217 currency code.

customer

val customer: String?

ID of an existing customer to associate with this charge intent, or null.

customerData

@SerializedName(value = "customer_data")

val customerData: ChargeIntentsRequests.CustomerData?

Inline customer name and email to create or match a customer record, or null.

description

val description: String?

Merchant-supplied description of the charge.

fraudSignals

@SerializedName(value = "fraud_signals")

var fraudSignals: ChargeIntentsRequests.FraudSignals?

Device fraud signals attached automatically by the SDK before the request is sent.

paymentMethod

@SerializedName(value = "payment_method")

val paymentMethod: String?

ID of an existing payment method to attach to the charge intent, or null.

paymentMethodData

@SerializedName(value = "payment_method_data")

val paymentMethodData: ChargeIntentsRequests.PaymentMethodData?

Inline card details used to create a new payment method, or null.

receiptEmail

@SerializedName(value = "receipt_email")

val receiptEmail: String?

Email address to send a receipt to upon successful payment, or null.

sonarSessionId

@SerializedName(value = "sonar_session_id")

var sonarSessionId: String?

Session identifier from the Sonar fraud-detection service, attached automatically by the SDK.

useFrameSDK

@SerializedName(value = "use_frame_sdk")

val useFrameSDK: Boolean = true

Indicates the request originated from the Frame Android SDK; defaults to true.