zuora-sdk-js 3.6.0 → 3.7.0

package/dist/zuora_api/model/CreateAccountPaymentMethod.js

@@ -45,12 +45,12 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateAccountPaymentMethod model module.
  * @module model/CreateAccountPaymentMethod
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateAccountPaymentMethod = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateAccountPaymentMethod</code>.
-   * Container for information on payment methods to associate with this account. To associate a credit card payment method when creating an account, Zuora recommends that you use this field instead of the &#x60;creditCard&#x60; field.  Note that you can not use this field together with &#x60;creditCard&#x60; or &#x60;hpmCreditCardPaymentMethodId&#x60; to associate a payment method to an account. 
+   * Container for information on payment methods to associate with this account. To associate a credit card payment method when creating an account, Zuora recommends that you use this field instead of the &#x60;creditCard&#x60; field.   Note that you can not use this field together with &#x60;creditCard&#x60; or &#x60;hpmCreditCardPaymentMethodId&#x60; to associate a payment method to an account.
    * @alias module:model/CreateAccountPaymentMethod
    * @implements module:model/CreatePaymentMethodCommon
    * @implements module:model/CreatePaymentMethodACH
@@ -62,7 +62,7 @@ var CreateAccountPaymentMethod = /*#__PURE__*/function () {
    * @implements module:model/CreatePaymentMethodApplePayAdyen
    * @implements module:model/CreatePaymentMethodGooglePayAdyenChase
    * @implements module:model/PaymentMethodObjectCustomFields
-   * @param type {String} Type of payment method. Possible values include:  * `CreditCard` - Credit card payment method. * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method. * `ACH` - ACH payment method. * `SEPA` - Single Euro Payments Area. * `Betalingsservice` - Direct Debit DK. * `Autogiro` - Direct Debit SE. * `Bacs` - Direct Debit UK. * `Becs` - Direct Entry AU. * `Becsnz` - Direct Debit NZ. * `PAD` - Pre-Authorized Debit. * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance. * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance. * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance. * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance. * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details. * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details. * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details. * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details. 
+   * @param type {String} Type of payment method. Possible values include:   * `CreditCard` - Credit card payment method.  * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.  * `ACH` - ACH payment method.  * `SEPA` - Single Euro Payments Area.  * `Betalingsservice` - Direct Debit DK.  * `Autogiro` - Direct Debit SE.  * `Bacs` - Direct Debit UK.  * `Becs` - Direct Entry AU.  * `Becsnz` - Direct Debit NZ.  * `PAD` - Pre-Authorized Debit.  * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.  * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.  * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.  * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.  * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.  * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.  * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.  * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.
    */
   function CreateAccountPaymentMethod(type) {
     _classCallCheck(this, CreateAccountPaymentMethod);
@@ -488,19 +488,19 @@ CreateAccountPaymentMethod.RequiredProperties = ["type"];
 CreateAccountPaymentMethod.prototype['accountKey'] = undefined;
 
 /**
- * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.  If you do not set this field, Zuora will use one of the following payment gateways instead:  * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. 
+ * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   If you do not set this field, Zuora will use one of the following payment gateways instead:   * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.  * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
  * @member {String} authGateway
  */
 CreateAccountPaymentMethod.prototype['authGateway'] = undefined;
 
 /**
- * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  For validating SEPA payment methods on Stripe v2, this field is required. 
+ * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.    If the IP address length is beyond 45 characters, a validation error occurs.   For validating SEPA payment methods on Stripe v2, this field is required.
  * @member {String} ipAddress
  */
 CreateAccountPaymentMethod.prototype['ipAddress'] = undefined;
 
 /**
- * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. 
+ * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.
  * @member {Boolean} makeDefault
  * @default false
  */
@@ -531,7 +531,7 @@ CreateAccountPaymentMethod.prototype['bankABACode'] = undefined;
 CreateAccountPaymentMethod.prototype['bankAccountName'] = undefined;
 
 /**
- * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on  Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
+ * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
  * @member {String} bankAccountNumber
  */
 CreateAccountPaymentMethod.prototype['bankAccountNumber'] = undefined;
@@ -584,7 +584,7 @@ CreateAccountPaymentMethod.prototype['state'] = undefined;
 CreateAccountPaymentMethod.prototype['zipCode'] = undefined;
 
 /**
- * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`. 
+ * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`.
  * @member {String} IBAN
  */
 CreateAccountPaymentMethod.prototype['IBAN'] = undefined;
@@ -595,25 +595,25 @@ CreateAccountPaymentMethod.prototype['IBAN'] = undefined;
 CreateAccountPaymentMethod.prototype['accountHolderInfo'] = undefined;
 
 /**
- * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} accountNumber
  */
 CreateAccountPaymentMethod.prototype['accountNumber'] = undefined;
 
 /**
- * The masked account number of the payment method. 
+ * The masked account number of the payment method.
  * @member {String} accountMaskNumber
  */
 CreateAccountPaymentMethod.prototype['accountMaskNumber'] = undefined;
 
 /**
- * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} bankCode
  */
 CreateAccountPaymentMethod.prototype['bankCode'] = undefined;
 
 /**
- * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} branchCode
  */
 CreateAccountPaymentMethod.prototype['branchCode'] = undefined;
@@ -625,13 +625,13 @@ CreateAccountPaymentMethod.prototype['branchCode'] = undefined;
 CreateAccountPaymentMethod.prototype['businessIdentificationCode'] = undefined;
 
 /**
- * The currency used for payment method authorization.  If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used. 
+ * The currency used for payment method authorization.   If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
  * @member {String} currencyCode
  */
 CreateAccountPaymentMethod.prototype['currencyCode'] = undefined;
 
 /**
- * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`) 
+ * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)
  * @member {String} identityNumber
  */
 CreateAccountPaymentMethod.prototype['identityNumber'] = undefined;
@@ -642,13 +642,13 @@ CreateAccountPaymentMethod.prototype['identityNumber'] = undefined;
 CreateAccountPaymentMethod.prototype['cardHolderInfo'] = undefined;
 
 /**
- * Credit card number. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * Credit card number. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {String} cardNumber
  */
 CreateAccountPaymentMethod.prototype['cardNumber'] = undefined;
 
 /**
- * The masked card number associated with the credit card payment. This field is only required if the credit card payment method is created using tokens.  
+ * The masked card number associated with the credit card payment. This field is only required if the credit card payment method is created using tokens. 
  * @member {String} cardMaskNumber
  */
 CreateAccountPaymentMethod.prototype['cardMaskNumber'] = undefined;
@@ -660,19 +660,19 @@ CreateAccountPaymentMethod.prototype['cardMaskNumber'] = undefined;
 CreateAccountPaymentMethod.prototype['cardType'] = undefined;
 
 /**
- * Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.  With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.          The following fields are used for the duplication check:   - `cardHolderName`   - `expirationMonth`   - `expirationYear`   - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example:     ```     ************1234     ``` 
+ * Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.  With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.          The following fields are used for the duplication check:  - `cardHolderName`   - `expirationMonth`   - `expirationYear`   - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example:  ```     ************1234     ``` 
  * @member {Boolean} checkDuplicated
  */
 CreateAccountPaymentMethod.prototype['checkDuplicated'] = undefined;
 
 /**
- * One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {Number} expirationMonth
  */
 CreateAccountPaymentMethod.prototype['expirationMonth'] = undefined;
 
 /**
- * Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {Number} expirationYear
  */
 CreateAccountPaymentMethod.prototype['expirationYear'] = undefined;
@@ -717,19 +717,19 @@ CreateAccountPaymentMethod.prototype['mitProfileType'] = undefined;
 CreateAccountPaymentMethod.prototype['securityCode'] = undefined;
 
 /**
- * The masked credit card number, such as: ``` *********1112 ```  This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.  Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked. 
+ * The masked credit card number, such as:  ```  *********1112  ```   This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.   Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
  * @member {String} creditCardMaskNumber
  */
 CreateAccountPaymentMethod.prototype['creditCardMaskNumber'] = undefined;
 
 /**
- * A gateway unique identifier that replaces sensitive payment method data.   `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method. 
+ * A gateway unique identifier that replaces sensitive payment method data.    `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.
  * @member {String} secondTokenId
  */
 CreateAccountPaymentMethod.prototype['secondTokenId'] = undefined;
 
 /**
- * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.  When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.  The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.  **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field. 
+ * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.   When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.   The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.   **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.
  * @member {String} tokenId
  */
 CreateAccountPaymentMethod.prototype['tokenId'] = undefined;
@@ -741,7 +741,7 @@ CreateAccountPaymentMethod.prototype['tokenId'] = undefined;
 CreateAccountPaymentMethod.prototype['BAID'] = undefined;
 
 /**
- * Email address associated with the payment method. This field is supported for the following payment methods:   - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.     - PayPal Express Checkout     - PayPal Adaptive     - PayPal Commerce Platform   - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`. 
+ * Email address associated with the payment method. This field is supported for the following payment methods:   - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.     - PayPal Express Checkout     - PayPal Adaptive     - PayPal Commerce Platform   - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.
  * @member {String} email
  */
 CreateAccountPaymentMethod.prototype['email'] = undefined;
@@ -753,19 +753,19 @@ CreateAccountPaymentMethod.prototype['email'] = undefined;
 CreateAccountPaymentMethod.prototype['preapprovalKey'] = undefined;
 
 /**
- * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay). 
+ * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).
  * @member {String} applePaymentData
  */
 CreateAccountPaymentMethod.prototype['applePaymentData'] = undefined;
 
 /**
- * This field is specific for setting up Google Pay for Adyen and Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) and [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase). 
+ * This field is specific for setting up Google Pay for Adyen and Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) and [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase).
  * @member {String} googlePaymentToken
  */
 CreateAccountPaymentMethod.prototype['googlePaymentToken'] = undefined;
 
 /**
- * Type of payment method. Possible values include:  * `CreditCard` - Credit card payment method. * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method. * `ACH` - ACH payment method. * `SEPA` - Single Euro Payments Area. * `Betalingsservice` - Direct Debit DK. * `Autogiro` - Direct Debit SE. * `Bacs` - Direct Debit UK. * `Becs` - Direct Entry AU. * `Becsnz` - Direct Debit NZ. * `PAD` - Pre-Authorized Debit. * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance. * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance. * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance. * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance. * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details. * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details. * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details. * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details. 
+ * Type of payment method. Possible values include:   * `CreditCard` - Credit card payment method.  * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.  * `ACH` - ACH payment method.  * `SEPA` - Single Euro Payments Area.  * `Betalingsservice` - Direct Debit DK.  * `Autogiro` - Direct Debit SE.  * `Bacs` - Direct Debit UK.  * `Becs` - Direct Entry AU.  * `Becsnz` - Direct Debit NZ.  * `PAD` - Pre-Authorized Debit.  * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.  * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.  * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.  * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.  * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.  * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.  * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.  * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.
  * @member {String} type
  */
 CreateAccountPaymentMethod.prototype['type'] = undefined;
@@ -777,17 +777,17 @@ CreateAccountPaymentMethod.prototype['type'] = undefined;
  */
 _CreatePaymentMethodCommon["default"].prototype['accountKey'] = undefined;
 /**
- * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.  If you do not set this field, Zuora will use one of the following payment gateways instead:  * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. 
+ * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   If you do not set this field, Zuora will use one of the following payment gateways instead:   * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.  * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
  * @member {String} authGateway
  */
 _CreatePaymentMethodCommon["default"].prototype['authGateway'] = undefined;
 /**
- * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  For validating SEPA payment methods on Stripe v2, this field is required. 
+ * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.    If the IP address length is beyond 45 characters, a validation error occurs.   For validating SEPA payment methods on Stripe v2, this field is required.
  * @member {String} ipAddress
  */
 _CreatePaymentMethodCommon["default"].prototype['ipAddress'] = undefined;
 /**
- * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. 
+ * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.
  * @member {Boolean} makeDefault
  * @default false
  */
@@ -814,7 +814,7 @@ _CreatePaymentMethodACH["default"].prototype['bankABACode'] = undefined;
  */
 _CreatePaymentMethodACH["default"].prototype['bankAccountName'] = undefined;
 /**
- * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on  Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
+ * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
  * @member {String} bankAccountNumber
  */
 _CreatePaymentMethodACH["default"].prototype['bankAccountNumber'] = undefined;
@@ -859,7 +859,7 @@ _CreatePaymentMethodACH["default"].prototype['state'] = undefined;
 _CreatePaymentMethodACH["default"].prototype['zipCode'] = undefined;
 // Implement CreatePaymentMethodBankTransfer interface:
 /**
- * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`. 
+ * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`.
  * @member {String} IBAN
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['IBAN'] = undefined;
@@ -868,22 +868,22 @@ _CreatePaymentMethodBankTransfer["default"].prototype['IBAN'] = undefined;
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['accountHolderInfo'] = undefined;
 /**
- * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} accountNumber
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['accountNumber'] = undefined;
 /**
- * The masked account number of the payment method. 
+ * The masked account number of the payment method.
  * @member {String} accountMaskNumber
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['accountMaskNumber'] = undefined;
 /**
- * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} bankCode
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['bankCode'] = undefined;
 /**
- * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} branchCode
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['branchCode'] = undefined;
@@ -893,12 +893,12 @@ _CreatePaymentMethodBankTransfer["default"].prototype['branchCode'] = undefined;
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['businessIdentificationCode'] = undefined;
 /**
- * The currency used for payment method authorization.  If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used. 
+ * The currency used for payment method authorization.   If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
  * @member {String} currencyCode
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['currencyCode'] = undefined;
 /**
- * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`) 
+ * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)
  * @member {String} identityNumber
  */
 _CreatePaymentMethodBankTransfer["default"].prototype['identityNumber'] = undefined;
@@ -908,12 +908,12 @@ _CreatePaymentMethodBankTransfer["default"].prototype['identityNumber'] = undefi
  */
 _CreatePaymentMethodCreditCard["default"].prototype['cardHolderInfo'] = undefined;
 /**
- * Credit card number. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * Credit card number. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {String} cardNumber
  */
 _CreatePaymentMethodCreditCard["default"].prototype['cardNumber'] = undefined;
 /**
- * The masked card number associated with the credit card payment. This field is only required if the credit card payment method is created using tokens.  
+ * The masked card number associated with the credit card payment. This field is only required if the credit card payment method is created using tokens. 
  * @member {String} cardMaskNumber
  */
 _CreatePaymentMethodCreditCard["default"].prototype['cardMaskNumber'] = undefined;
@@ -923,17 +923,17 @@ _CreatePaymentMethodCreditCard["default"].prototype['cardMaskNumber'] = undefine
  */
 _CreatePaymentMethodCreditCard["default"].prototype['cardType'] = undefined;
 /**
- * Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.  With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.          The following fields are used for the duplication check:   - `cardHolderName`   - `expirationMonth`   - `expirationYear`   - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example:     ```     ************1234     ``` 
+ * Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.  With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.          The following fields are used for the duplication check:  - `cardHolderName`   - `expirationMonth`   - `expirationYear`   - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example:  ```     ************1234     ``` 
  * @member {Boolean} checkDuplicated
  */
 _CreatePaymentMethodCreditCard["default"].prototype['checkDuplicated'] = undefined;
 /**
- * One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {Number} expirationMonth
  */
 _CreatePaymentMethodCreditCard["default"].prototype['expirationMonth'] = undefined;
 /**
- * Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods,  this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
+ * Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`. However, for creating tokenized credit card payment methods, this field is optional if the `tokens` and `cardMaskNumber` fields are specified. 
  * @member {Number} expirationYear
  */
 _CreatePaymentMethodCreditCard["default"].prototype['expirationYear'] = undefined;
@@ -971,17 +971,17 @@ _CreatePaymentMethodCreditCard["default"].prototype['mitProfileType'] = undefine
 _CreatePaymentMethodCreditCard["default"].prototype['securityCode'] = undefined;
 // Implement CreatePaymentMethodCCReferenceTransaction interface:
 /**
- * The masked credit card number, such as: ``` *********1112 ```  This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.  Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked. 
+ * The masked credit card number, such as:  ```  *********1112  ```   This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.   Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
  * @member {String} creditCardMaskNumber
  */
 _CreatePaymentMethodCCReferenceTransaction["default"].prototype['creditCardMaskNumber'] = undefined;
 /**
- * A gateway unique identifier that replaces sensitive payment method data.   `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method. 
+ * A gateway unique identifier that replaces sensitive payment method data.    `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.
  * @member {String} secondTokenId
  */
 _CreatePaymentMethodCCReferenceTransaction["default"].prototype['secondTokenId'] = undefined;
 /**
- * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.  When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.  The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.  **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field. 
+ * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.   When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.   The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.   **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.
  * @member {String} tokenId
  */
 _CreatePaymentMethodCCReferenceTransaction["default"].prototype['tokenId'] = undefined;
@@ -992,7 +992,7 @@ _CreatePaymentMethodCCReferenceTransaction["default"].prototype['tokenId'] = und
  */
 _CreatePaymentMethodPayPalECPayPalNativeECPayPalCP["default"].prototype['BAID'] = undefined;
 /**
- * Email address associated with the payment method. This field is supported for the following payment methods:   - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.     - PayPal Express Checkout     - PayPal Adaptive     - PayPal Commerce Platform   - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`. 
+ * Email address associated with the payment method. This field is supported for the following payment methods:   - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.     - PayPal Express Checkout     - PayPal Adaptive     - PayPal Commerce Platform   - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.
  * @member {String} email
  */
 _CreatePaymentMethodPayPalECPayPalNativeECPayPalCP["default"].prototype['email'] = undefined;
@@ -1004,13 +1004,13 @@ _CreatePaymentMethodPayPalECPayPalNativeECPayPalCP["default"].prototype['email']
 _CreatePaymentMethodPayPalAdaptive["default"].prototype['preapprovalKey'] = undefined;
 // Implement CreatePaymentMethodApplePayAdyen interface:
 /**
- * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay). 
+ * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).
  * @member {String} applePaymentData
  */
 _CreatePaymentMethodApplePayAdyen["default"].prototype['applePaymentData'] = undefined;
 // Implement CreatePaymentMethodGooglePayAdyenChase interface:
 /**
- * This field is specific for setting up Google Pay for Adyen and Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) and [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase). 
+ * This field is specific for setting up Google Pay for Adyen and Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) and [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase).
  * @member {String} googlePaymentToken
  */
 _CreatePaymentMethodGooglePayAdyenChase["default"].prototype['googlePaymentToken'] = undefined;