Interface

HostPaymentPage

HostPaymentPage

Config option for Hosted Payment Page(HPP) when doing redirect checkout using Airwallex payment page

View Source types/airwallex.d.ts, line 93

Members

ApplePayHppOrDropInRequestOptions

# applePayRequestOptions Optional

The options of apple pay If you want to integrate with apple pay, you need to provide the following options

View Source types/airwallex.d.ts, line 195

boolean

# autoCapture Optional

Only support for card payment, indicate whether to capture immediate when authentication success

View Source types/airwallex.d.ts, line 140

string

# cancelUrl Optional

The cancel return url when shopper canceled the payment intent

View Source types/airwallex.d.ts, line 158

string

# client_secret

The client_secret when you create payment intent, contain in the response

View Source types/airwallex.d.ts, line 110

Array.<PaymentMethodType>

# components Optional

The payment methods your website would like to integrate with
Deprecated:
  • use `methods` instead

View Source types/airwallex.d.ts, line 127

string

# country_code Optional

The 2-letter ISO country code from which the consumer will be paying If you want to integrate with `bank_transfer`, `online_banking`, `skrill` or `seven_eleven` payment method, it would be required

View Source types/airwallex.d.ts, line 213

string

# currency

Currency of your payment intent or consent. Three-letter ISO currency code

View Source types/airwallex.d.ts, line 208

string

# customer_id Optional

Checkout for know customer, refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Customers/Intro)

View Source types/airwallex.d.ts, line 121

boolean

# disableAutoRedirect Optional

Disable redirect, return the hpp url to the merchant instead
Default Value:
  • false

View Source types/airwallex.d.ts, line 238

AirwallexEnv

# env Optional

Indicate which airwallex integration env your merchant site would like to connect with If not provide default will be prod which point to [Airwallex Checkout](https://checkout.airwallex.com)

View Source types/airwallex.d.ts, line 97

string

# failUrl Optional

The failed return url when shopper can not fulfill the payment intent

View Source types/airwallex.d.ts, line 152

GooglePayHppRequestOptions

# googlePayRequestOptions Optional

Define google pay type and it's mapped option type

View Source types/airwallex.d.ts, line 202

string

# intent_id Optional

The intent id you shopper want to checkout

View Source types/airwallex.d.ts, line 104

'en' | 'zh' | 'ja' | 'ko' | 'ar' | 'fr' | 'es' | 'nl' | 'de' | 'it' | 'zh-HK' | 'pl' | 'fi' | 'ru'

# locale Optional

i18n localization config

View Source types/airwallex.d.ts, line 170

string

# logoUrl Optional

The logo url of your website you want to show in the HPP head

View Source types/airwallex.d.ts, line 164

Array.<PaymentMethodType>

# methods Optional

The payment methods your website would like to integrate with

View Source types/airwallex.d.ts, line 134

Mode

# mode Optional

Checkout mode, can be one of payment, recurring
Default Value:
  • payment

View Source types/airwallex.d.ts, line 182

RecurringOptions

# recurringOptions Optional

The options of recurring flow

View Source types/airwallex.d.ts, line 189

string

# shopper_email Optional

Customer email

View Source types/airwallex.d.ts, line 232

string

# shopper_name Optional

Customer name - minimum of 3 characters, up to 100 characters

View Source types/airwallex.d.ts, line 220

string

# shopper_phone Optional

Customer phone

View Source types/airwallex.d.ts, line 226

string

# successUrl Optional

The success return url after shopper succeeded the payment

View Source types/airwallex.d.ts, line 146

HppTheme

# theme Optional

Option with limited support for HPP page style customization

View Source types/airwallex.d.ts, line 115

boolean

# withBilling Optional

Apply only for card, to improve 3DS experience, indicate if the payment form will collect billing info from shopper

View Source types/airwallex.d.ts, line 176