AirwallexRecurringSession

For recurring payment (without create payment intent)

Types

Link copied to clipboard
class Builder(customerId: String, clientSecret: String, currency: String, amount: BigDecimal, nextTriggerBy: PaymentConsent.NextTriggeredBy, countryCode: String) : ObjectBuilder<AirwallexRecurringSession>

Properties

Link copied to clipboard
open override val amount: BigDecimal

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

Link copied to clipboard
Link copied to clipboard
open override val countryCode: String

Country code

Link copied to clipboard
open override val currency: String

Amount currency. required.

Link copied to clipboard
open override val customerId: String

It is required if the PaymentIntent is created for recurring payment

Link copied to clipboard
open override val googlePayOptions: GooglePayOptions? = null

Google Pay options

Link copied to clipboard
open override val isBillingInformationRequired: Boolean = true

Whether or not billing information is required for payments. When set to false, any billing information will be ignored.

Link copied to clipboard
open override val isEmailRequired: Boolean = false

Whether or not email is required for card payments. Set to 'true' if you'd like to collect customers' email

Link copied to clipboard

Indicates whether this session is configured for Express Checkout. Returns true when the session uses a PaymentIntentProvider for lazy payment intent creation.

Link copied to clipboard

Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled. Default: unscheduled

Link copied to clipboard

The party to trigger subsequent payments. Can be one of merchant, customer. required.

Link copied to clipboard
open override val paymentMethods: List<String>? = null

An array of payment method type names to limit the payment methods displayed on the list screen. Only available ones from your Airwallex account will be applied, any other ones will be ignored. Also the order of payment method list will follow the order of this array. API reference: https://www.airwallex.com/docs/api#/Payment_Acceptance/Config/_api_v1_pa_config_payment_method_types/get JSON Object field: items.name

Link copied to clipboard
val requiresCVC: Boolean = false

Only applicable when next_triggered_by is customer and the payment_method.type is card.If true, the customer must provide cvc for the subsequent payment with this PaymentConsent. Default: false

Link copied to clipboard
open override val returnUrl: String?

The URL to redirect your customer back to after they authenticate or cancel their payment on the PaymentMethod’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.

Link copied to clipboard
open override val shipping: Shipping? = null

Shipping information. optional

Functions

Link copied to clipboard

Binds this session's PaymentIntentProvider to an Activity lifecycle. This ensures the provider is cleaned up when the Activity is destroyed. Should be called once when the session starts being used with a specific Activity.

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard

Extension function to resolve PaymentIntent from session. If paymentIntent is available, calls callback immediately. If paymentIntentProvider is available (transient field), uses it to get the intent asynchronously. If paymentIntentProviderId is available (after binding), retrieves from repository.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)