airwallex-android

6.3.1

components-core/com.airwallex.android.core.model/PaymentIntent

PaymentIntent

data class PaymentIntent(val id: String, val requestId: String? = null, val amount: BigDecimal, val currency: String, val merchantOrderId: String? = null, val order: PurchaseOrder? = null, val customerId: String? = null, val descriptor: String? = null, val metadata: Map<String, Any?>? = null, val status: PaymentIntentStatus? = null, val capturedAmount: BigDecimal? = null, val latestPaymentAttempt: PaymentIntent.PaymentAttempt? = null, val availablePaymentMethodTypes: List<PaymentMethodType>? = null, val customerPaymentMethods: List<PaymentMethod>? = null, val customerPaymentConsents: List<PaymentConsent>? = null, val clientSecret: String? = null, val nextAction: NextAction? = null, val createdAt: Date? = null, val updatedAt: Date? = null, val cancelledAt: Date? = null, val cancellationReason: String? = null) : AirwallexModel, Parcelable

A PaymentIntent guides you through the process of collecting a payment from your customer. It tracks a payment when your customer first checks out, through to when payment is successfully paid by your customer. A PaymentIntent transitions through a number of states throughout the customer's payment journey.

Constructors

constructor(id: String, requestId: String? = null, amount: BigDecimal, currency: String, merchantOrderId: String? = null, order: PurchaseOrder? = null, customerId: String? = null, descriptor: String? = null, metadata: Map<String, Any?>? = null, status: PaymentIntentStatus? = null, capturedAmount: BigDecimal? = null, latestPaymentAttempt: PaymentIntent.PaymentAttempt? = null, availablePaymentMethodTypes: List<PaymentMethodType>? = null, customerPaymentMethods: List<PaymentMethod>? = null, customerPaymentConsents: List<PaymentConsent>? = null, clientSecret: String? = null, nextAction: NextAction? = null, createdAt: Date? = null, updatedAt: Date? = null, cancelledAt: Date? = null, cancellationReason: String? = null)

Types

data class PaymentAttempt(val id: String?, val amount: BigDecimal?, val currency: String? = null, val paymentMethod: PaymentMethod, val capturedAmount: BigDecimal?, val refundedAmount: BigDecimal?, val createdAt: Date?, val updatedAt: Date?, val authenticationData: PaymentIntent.PaymentAttemptAuthData?) : AirwallexModel, Parcelable

PaymentAttemptAuthData

data class PaymentAttemptAuthData(val dsData: PaymentIntent.PaymentAttemptAuthDSData?, val fraudData: PaymentIntent.PaymentAttemptAuthFraudData?, val avsResult: String?, val cvcResult: String?) : AirwallexModel, Parcelable

PaymentAttemptAuthDSData

data class PaymentAttemptAuthDSData : AirwallexModel, Parcelable

PaymentAttemptAuthFraudData

data class PaymentAttemptAuthFraudData : AirwallexModel, Parcelable

Properties

val amount: BigDecimal

Payment amount. This is the order amount you would like to charge your customer

availablePaymentMethodTypes

val availablePaymentMethodTypes: List<PaymentMethodType>? = null

Available payment method types

cancellationReason

val cancellationReason: String? = null

Reason for cancelling the payment intent. Only present when the payment intent was successfully cancelled, i.e. status is CANCELLED

val cancelledAt: Date? = null

Last time at which this payment intent was cancelled. Only present when the payment intent was successfully cancelled, i.e. status is CANCELLED

val capturedAmount: BigDecimal? = null

Amount that captured from this payment intent

val clientSecret: String? = null

Client secret for browser or app

val createdAt: Date? = null

Time at which this payment intent was created

val currency: String

Amount currency

val customerId: String? = null

The customer who is paying for this payment intent

customerPaymentConsents

val customerPaymentConsents: List<PaymentConsent>? = null

PaymentConsents of the Customer if Customer ID is provided

customerPaymentMethods

val customerPaymentMethods: List<PaymentMethod>? = null

Payment methods of the customer if customer ID is provided

val descriptor: String? = null

Descriptor that will be displayed to the customer

Unique identifier for the payment intent

latestPaymentAttempt

val latestPaymentAttempt: PaymentIntent.PaymentAttempt? = null

Latest payment attempt that was created under the payment intent

merchantOrderId

val merchantOrderId: String? = null

The order ID created in merchant's order system that corresponds to this payment intent

val metadata: Map<String, Any?>? = null

A set of key-value pairs that you can attach to this customer

val nextAction: NextAction? = null

Next action for the payment intent

val order: PurchaseOrder? = null

The purchase order info

val requestId: String? = null

Unique request ID specified by the merchant in the last operation

val status: PaymentIntentStatus? = null

The status for the payment intent

val updatedAt: Date? = null

Last time at which this payment intent was updated or operated on

Functions

describeContents

abstract fun describeContents(): Int

abstract fun writeToParcel(p0: Parcel, p1: Int)