airwallex-payment-elements 1.62.0 → 1.89.0

package/types/dropInElement.d.ts

@@ -1,11 +1,25 @@
-import { ElementOptions, PaymentMethodType, BoxStyle } from './element';
+import { PaymentMethodType, BoxStyle, Appearance, CardNetwork } from './element';
 import { Mode, RecurringOptions, Billing, AuthorizationType } from './airwallex';
 import { ApplePayHppOrDropInRequestOptions, GooglePayRequestOptions, ContactField, LPMFlows } from './element';
+interface WeChatPayFlow {
+  desktopFlow?: LPMFlows;
+  mobileFlow?: LPMFlows;
+}
+
+interface DropinTheme {
+  palette?: {
+    primary?: string;
+  };
+}
 
 /**
- * Apply to dropIn element type integration, interface used when createElement called with type `dropIn`
+ * Apply to `dropIn` element type integration, interface used when `createElement` called with type `dropIn`
  */
-export interface DropInElementOptions extends ElementOptions {
+export interface DropInElementOptions {
+  /**
+   * The layout of each element stays consistent, but you can modify confirm button, inputs, and more.
+   */
+  appearance?: Appearance;
   /**
    * The `client_secret` of the Payment Intent when Payment Intent is provided. Otherwise, this should be the `client_secret` of the Customer object.
    */
@@ -15,19 +29,19 @@ export interface DropInElementOptions extends ElementOptions {
    */
   currency: string;
   /**
-   * When using Payments for Platforms, specify the ID of the connected account associated with the payment if you want to use its information to process the payment. 
+   * When using Payments for Platforms, specify the ID of the connected account associated with the payment if you want to use its information to process the payment.
    * For example, the statement descriptor displayed on the shopper's credit card or bank statement and the payment methods activated by the connected account.
-   * 
+   *
    */
   platformConnectedAccount?: string;
   /**
-   * The checkout mode for the shopper, `payment` or `recurring`. 
-   * @default payment
+   * The checkout mode for the shopper, `'payment'` or `'recurring'`.
+   * @defaultValue `'payment'`
    */
   mode?: Mode;
   /**
    * The payment methods your website would like to integrate with
-   * @deprecated use `methods` instead
+   * @deprecated use {@link methods} instead
    */
   components?: Array<PaymentMethodType>;
   /**
@@ -35,41 +49,41 @@ export interface DropInElementOptions extends ElementOptions {
    */
   methods?: Array<PaymentMethodType>;
   /**
-   * Whether the amount should be captured automatically upon successful payment authorization.  
+   * Whether the amount should be captured automatically upon successful payment authorization.
    * Set it to `false` if you want to place a hold on the payment method and capture the funds sometime later.
-   * @defaultValue `true` if authorization type is `final_auth` and `false` for `pre_auth`.
+   * @defaultValue `true`
    */
   autoCapture?: boolean;
   /**
-   * The authorization type for the card payment. Options include: `pre_auth`, `final_auth`.
-   * Defaults to `final_auth` to enable funds to be captured immediately after successful authorization. 
-   * Set it to `pre_auth` if you want to place a hold on your customer’s card for more than 7 days, i.e., extend the authorization time window. 
-   * Currently `pre_auth` is only available when the card brand is Visa or Mastercard. You should also set `autoCapture` to `false` if you want to enable `pre_auth`.
-   * @defaultValue `final_auth`
+   * The authorization type for the card payment.
+   * Set it to `pre_auth` if you want to place a hold on your customer’s card for more than 7 days, i.e., extend the authorization time window.
+   * Currently `pre_auth` is only available when the card brand is Visa or Mastercard. `autoCapture` will be automatically set to `false` if you enable `pre_auth`.
+   * @defaultValue `'final_auth'`
    */
   authorizationType?: AuthorizationType;
   /**
    * Whether you require the shopper to provide CVC when they checkout with a network tokenized card.
    */
   cvcRequired?: boolean;
+  /**
+   * One or more card networks that you support.
+   */
+  allowedCardNetworks?: CardNetwork[];
   /**
    * The options for Wechat Pay.
    */
-  wechatpay?: {
-    desktopFlow?: LPMFlows;
-    mobileFlow?: LPMFlows;
-  };
+  wechatpay?: WeChatPayFlow;
   /**
-   * Checkout configuration options for Apple Pay. 
+   * Checkout configuration options for Apple Pay.
    */
   applePayRequestOptions?: ApplePayHppOrDropInRequestOptions;
   /**
-   * Checkout configuration options for Google Pay. 
+   * Checkout configuration options for Google Pay.
    */
   googlePayRequestOptions?: GooglePayRequestOptions;
   /**
    * Indicate to improve 3DS experience, indicate if the payment form will collect billing info from shopper
-   * @deprecated please use `requiredBillingContactFields` instead
+   * @deprecated please use {@link requiredBillingContactFields} instead
    */
   withBilling?: boolean;
   /**
@@ -77,20 +91,20 @@ export interface DropInElementOptions extends ElementOptions {
    */
   requiredBillingContactFields?: ContactField[];
   /**
-   * Style for the dropIn element.
+   * Box style for the dropIn element.
    */
   style?: BoxStyle;
   /**
-   * The container ID of the authentication form used in 3D Secure authentication. 
+   * The container of the authentication form used in 3D Secure authentication.
    */
   authFormContainer?: string;
   /**
-   * The ID of the Payment Intent you would like to checkout. Required when `mode` is `payment`.
+   * The ID of the Payment Intent you would like to checkout. Required when `mode` is `'payment'`.
    */
   intent_id?: string;
   /**
    * The ID of the Customer used in registered user checkout. Refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Customers/Intro)
-   * This field is required when `mode` is `recurring`.
+   * This field is required when `mode` is `'recurring'`.
    */
   customer_id?: string;
   /**
@@ -106,25 +120,21 @@ export interface DropInElementOptions extends ElementOptions {
    */
   shopper_name?: string;
   /**
-   * The shoppers's phone number.
+   * The shopper's phone number.
    */
   shopper_phone?: string;
   /**
-   * The shoppers's email address.
+   * The shopper's email address.
    */
   shopper_email?: string;
   /**
-   * Billing information provided by the merchant. 
-   * This option overrides the billing information from the shopper as provided in the input billing fields. Do not sett `withBilling` and `requiredBillingContactFields` when you use this option.
+   * Billing information provided by the merchant.
+   * This option overrides the billing information from the shopper as provided in the input billing fields. Do not set `withBilling` and `requiredBillingContactFields` when you use this option.
    */
   billing?: Billing;
 
   /**
    * Customize DropIn Element style.
    */
-  theme?: {
-    palette?: {
-      primary?: string;
-    };
-  };
+  theme?: DropinTheme;
 }