airwallex-payment-elements 1.45.0 → 1.62.0

package/types/cardNumber.d.ts

@@ -1,24 +1,24 @@
 /**
- * The payment intent you would like to checkout
+ * The Payment Intent you would like to checkout.
  * Refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Intents/Intro)
  *
  * ***Hint***:
- * This interface only contain the necessary information when shopper checkout
- * For the detail meaning of each field you can refer to above api document
+ * This interface only contains information necessary for a checkout via UI elements. 
+ * For detailed information on each field refer to the API Reference. 
  */
 import { Billing } from './airwallex';
 
 export interface Intent {
   /**
-   * Id of intent
+   * The ID of the Paymnent Intent. 
    */
   id: string;
   /**
-   * client_secret of intent
+   * The `client_secret` of the Payment Intent when Payment Intent is provided. Otherwise, this should be the `client_secret` of the Customer object.
    */
   client_secret?: string;
   /**
-   * Your request id when create payment intent
+   * Unique request ID specified by the merchant.
    */
   request_id?: string;
   amount?: number;
@@ -70,7 +70,7 @@ export interface Intent {
 }
 
 /**
- * Interface for paymentmethod which will return to merchant, trigger by method call with createPaymentConsent
+ * Interface for Payment Method returned to the merchant when provided in createPaymentConsent. 
  * Refer to the type description: https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Methods/_api_v1_pa_payment_methods_create/post
  */
 export interface PaymentMethodBasicInfo {

package/types/dropInElement.d.ts

@@ -3,24 +3,25 @@ import { Mode, RecurringOptions, Billing, AuthorizationType } from './airwallex'
 import { ApplePayHppOrDropInRequestOptions, GooglePayRequestOptions, ContactField, LPMFlows } from './element';
 
 /**
- * Apply to dropIn element type integration, interface used when call createElement with type `dropIn`
+ * Apply to dropIn element type integration, interface used when createElement called with type `dropIn`
  */
 export interface DropInElementOptions extends ElementOptions {
   /**
-   * If the intent provided, this should be the client_secret of the intent
-   * If no intent provided, this should be the client_secret of the customer
+   * The `client_secret` of the Payment Intent when Payment Intent is provided. Otherwise, this should be the `client_secret` of the Customer object.
    */
   client_secret: string;
   /**
-   * Currency of your payment intent or consent. Three-letter ISO currency code
+   * The three-letter ISO currency code representing the currency of the Payment Intent or Payment Consent.
    */
   currency: string;
   /**
-   * The connected account associated with the payment when you are using Payments for Platforms. You should specify the specific connected account if you want to use its information to process the payment. This includes the statement descriptor displayed on the shopper's credit card or bank statement. The shopper will also see the available payment methods activated by the connected account.
+   * 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;
   /**
-   * Checkout mode, can be one of payment, recurring
+   * The checkout mode for the shopper, `payment` or `recurring`. 
    * @default payment
    */
   mode?: Mode;
@@ -30,34 +31,40 @@ export interface DropInElementOptions extends ElementOptions {
    */
   components?: Array<PaymentMethodType>;
   /**
-   * The payment methods your website would like to integrate with
+   * The payment methods your website would like to integrate with.
    */
   methods?: Array<PaymentMethodType>;
   /**
-   * Specifies whether the funds should be requested automatically after the payment is authorized. Set it to `false` if you want to capture the funds sometime later.
+   * 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`.
    */
   autoCapture?: boolean;
   /**
-   * The authorization type of 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. Currently it's only available when the card brand is visa or mastercard. You should also set `auto_capture` to be false if you want to enable pre-auth.
+   * 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`
    */
   authorizationType?: AuthorizationType;
   /**
-   * The options of wechatpay
+   * Whether you require the shopper to provide CVC when they checkout with a network tokenized card.
+   */
+  cvcRequired?: boolean;
+  /**
+   * The options for Wechat Pay.
    */
   wechatpay?: {
     desktopFlow?: LPMFlows;
     mobileFlow?: LPMFlows;
   };
   /**
-   * The options of apple pay
-   * If you want to integrate with apple pay, you need to provide the following options
+   * Checkout configuration options for Apple Pay. 
    */
   applePayRequestOptions?: ApplePayHppOrDropInRequestOptions;
   /**
-   * The options of apple pay
-   * If you want to integrate with apple pay, you need to provide the following options
+   * Checkout configuration options for Google Pay. 
    */
   googlePayRequestOptions?: GooglePayRequestOptions;
   /**
@@ -70,50 +77,50 @@ export interface DropInElementOptions extends ElementOptions {
    */
   requiredBillingContactFields?: ContactField[];
   /**
-   * Style for dropIn element
+   * Style for the dropIn element.
    */
   style?: BoxStyle;
   /**
-   * Container for authentication form, it's an element id
+   * The container ID of the authentication form used in 3D Secure authentication. 
    */
   authFormContainer?: string;
   /**
-   * The payment intent id you would like to checkout, it's required when mode is `payment`
+   * The ID of the Payment Intent you would like to checkout. Required when `mode` is `payment`.
    */
   intent_id?: string;
   /**
-   * Checkout for know customer, refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Customers/Intro)
+   * 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`.
    */
   customer_id?: string;
   /**
-   * The options of recurring flow
+   *  Options for recurring flow.
    */
   recurringOptions?: RecurringOptions;
   /**
-   * The 2-letter ISO country code from which the consumer will be paying
-   * If you want to integrate with `bank_transfer` payment method, it would be required
+   * The two-letter ISO country code of the shopper's country. This is required for `bank_transfer`, `online_banking`, `skrill` or `seven_eleven` payment methods.
    */
   country_code?: string;
   /**
-   * Customer name - minimum of 3 characters, up to 100 characters
+   * The shopper's full name.
    */
   shopper_name?: string;
   /**
-   * Customer phone
+   * The shoppers's phone number.
    */
   shopper_phone?: string;
   /**
-   * Customer email
+   * The shoppers's email address.
    */
   shopper_email?: string;
   /**
-   * Billing info from merchant
-   * This option would override the user input billing fields, so don't set 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 sett `withBilling` and `requiredBillingContactFields` when you use this option.
    */
   billing?: Billing;
 
   /**
-   * Customize DropIn Element Style
+   * Customize DropIn Element style.
    */
   theme?: {
     palette?: {