zuora-sdk-js 3.3.0 → 3.4.0

package/docs/CreatePaymentDebitMemoApplicationItem.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreatePaymentDebitMemoApplicationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the payment associated with the specific debit memo or taxation item.  | 
+**debit_memo_item_id** | **String** | The ID of the specific debit memo item.  | [optional] 
+**tax_item_id** | **String** | The ID of the specific taxation item.  | [optional] 
+
+

package/docs/CreatePaymentInvoiceApplication.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.CreatePaymentInvoiceApplication
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.  | 
+**invoice_id** | **String** | The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`.  | [optional] 
+**invoice_number** | **String** |  | [optional] 
+**items** | [**[CreatePaymentInvoiceApplicationItem]**](CreatePaymentInvoiceApplicationItem.md) | Container for invoice items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
+
+

package/docs/CreatePaymentInvoiceApplicationItem.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreatePaymentInvoiceApplicationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the payment associated with the specific invoice or taxation item.  | 
+**invoice_item_id** | **String** | The ID of the specific invoice item.  | [optional] 
+**tax_item_id** | **String** | The ID of the specific taxation item.  | [optional] 
+
+

package/docs/CreatePaymentMethodACH.md

@@ -0,0 +1,21 @@
+# ZuoraSdkJs.CreatePaymentMethodACH
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line1** | **String** | First address line, 255 characters or less.  | [optional] 
+**address_line2** | **String** | Second address line, 255 characters or less.  | [optional] 
+**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.  | [optional] 
+**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.  For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields.  | [optional] 
+**bank_account_number** | **String** | 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.  | [optional] 
+**bank_account_mask_number** | **String** | The masked bank account number associated with the ACH payment. This field is only required if the ACH payment method is created using tokens.  | [optional] 
+**bank_account_type** | [**PaymentMethodACHBankAccountType**](PaymentMethodACHBankAccountType.md) |  | [optional] 
+**bank_name** | **String** | The name of the bank where the ACH payment account is held. This field is only required if the `type` field is set to `ACH`.  When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.  | [optional] 
+**city** | **String** | City, 40 characters or less.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.       | [optional] 
+**country** | **String** | Country, must be a valid country name or abbreviation.  See [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) for the list of supported country names and abbreviations.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.  | [optional] 
+**phone** | **String** | Phone number, 40 characters or less.  | [optional] 
+**state** | **String** | State, must be a valid state name or 2-character abbreviation.  See [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.  | [optional] 
+**zip_code** | **String** | Zip code, 20 characters or less.  | [optional] 
+
+

package/docs/CreatePaymentMethodApplePayAdyen.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.CreatePaymentMethodApplePayAdyen
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apple_payment_data** | **String** | 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).  | [optional] 
+
+

package/docs/CreatePaymentMethodBankTransfer.md

@@ -0,0 +1,17 @@
+# ZuoraSdkJs.CreatePaymentMethodBankTransfer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**IBAN** | **String** | The International Bank Account Number. This field is required if the `type` field is set to `SEPA`.  | [optional] 
+**account_holder_info** | [**CreatePaymentMethodBankTransferAccountHolderInfo**](CreatePaymentMethodBankTransferAccountHolderInfo.md) |  | [optional] 
+**account_number** | **String** | 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`)  | [optional] 
+**account_mask_number** | **String** | The masked account number of the payment method.  | [optional] 
+**bank_code** | **String** | 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`)  | [optional] 
+**branch_code** | **String** | 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`)  | [optional] 
+**business_identification_code** | **String** | The BIC code used for SEPA.  | [optional] 
+**currency_code** | **String** | 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.  | [optional] 
+**identity_number** | **String** | 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`)  | [optional] 
+
+

package/docs/CreatePaymentMethodBankTransferAccountHolderInfo.md

@@ -0,0 +1,19 @@
+# ZuoraSdkJs.CreatePaymentMethodBankTransferAccountHolderInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_holder_name** | **String** | Required.  The full name of the bank account holder.  | [optional] 
+**address_line1** | **String** | The first line of the address for the account holder.  This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).  | [optional] 
+**address_line2** | **String** | The second line of the address for the account holder.   | [optional] 
+**city** | **String** | The city where the account holder stays.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.  | [optional] 
+**country** | **String** | The country where the account holder stays.  This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).  | [optional] 
+**email** | **String** | The email address of the account holder.  | [optional] 
+**first_name** | **String** | The first name of the account holder.  | [optional] 
+**last_name** | **String** | The last name of the account holder.  | [optional] 
+**phone** | **String** | The phone number of the account holder.  | [optional] 
+**state** | **String** | The state where the account holder stays.  | [optional] 
+**zip_code** | **String** | The zip code for the address of the account holder.  | [optional] 
+
+

package/docs/CreatePaymentMethodCCReferenceTransaction.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreatePaymentMethodCCReferenceTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credit_card_mask_number** | **String** | 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.  | [optional] 
+**second_token_id** | **String** | 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.  | [optional] 
+**token_id** | **String** | 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.  | [optional] 
+
+

package/docs/CreatePaymentMethodCardholderInfo.md

@@ -0,0 +1,17 @@
+# ZuoraSdkJs.CreatePaymentMethodCardholderInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line1** | **String** | First address line, 255 characters or less.  | [optional] 
+**address_line2** | **String** | Second address line, 255 characters or less.  | [optional] 
+**card_holder_name** | **String** | The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.  | [optional] 
+**city** | **String** | City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.  | [optional] 
+**country** | **String** | Country, must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.  | [optional] 
+**email** | **String** | Card holder's email address, 80 characters or less.  | [optional] 
+**phone** | **String** | Phone number, 40 characters or less.  | [optional] 
+**state** | **String** | State; must be a valid state name or 2-character abbreviation.  | [optional] 
+**zip_code** | **String** | Zip code, 20 characters or less.  | [optional] 
+
+

package/docs/CreatePaymentMethodCommon.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.CreatePaymentMethodCommon
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_key** | **String** | Internal ID of the customer account that will own the payment method.  | [optional] 
+**auth_gateway** | **String** | 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.  | [optional] 
+**ip_address** | **String** | 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.  | [optional] 
+**make_default** | **Boolean** | 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.  | [optional] [default to false]
+
+

package/docs/CreatePaymentMethodCreditCard.md

@@ -0,0 +1,22 @@
+# ZuoraSdkJs.CreatePaymentMethodCreditCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_holder_info** | [**CreatePaymentMethodCardholderInfo**](CreatePaymentMethodCardholderInfo.md) |  | [optional] 
+**card_number** | **String** | 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.  | [optional] 
+**card_mask_number** | **String** | 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.   | [optional] 
+**card_type** | **String** | The type of the credit card. This field is required if `type` is set to `CreditCard`.  Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).  | [optional] 
+**check_duplicated** | **Boolean** | 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     ```  | [optional] 
+**expiration_month** | **Number** | 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.  | [optional] 
+**expiration_year** | **Number** | 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.  | [optional] 
+**mit_consent_agreement_ref** | **String** | Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.  | [optional] 
+**mit_consent_agreement_src** | [**StoredCredentialProfileConsentAgreementSrc**](StoredCredentialProfileConsentAgreementSrc.md) |  | [optional] 
+**mit_network_transaction_id** | **String** | Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.  | [optional] 
+**mit_profile_action** | [**StoredCredentialProfileAction**](StoredCredentialProfileAction.md) |  | [optional] 
+**mit_profile_agreed_on** | **String** | The date on which the profile is agreed. The date format is `yyyy-mm-dd`.  | [optional] 
+**mit_profile_type** | [**StoredCredentialProfileType**](StoredCredentialProfileType.md) |  | [optional] 
+**security_code** | **String** | CVV or CVV2 security code of the credit card.  To ensure PCI compliance, this value is not stored and cannot be queried.  | [optional] 
+
+

package/docs/CreatePaymentMethodDecryptionRequest.md

@@ -0,0 +1,19 @@
+# ZuoraSdkJs.CreatePaymentMethodDecryptionRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account associated with this payment method. To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted. | [optional] 
+**card_holder_info** | [**CreatePaymentMethodCardholderInfo**](CreatePaymentMethodCardholderInfo.md) |  | [optional] 
+**integration_type** | **String** | Field to identify the token decryption type.  **Note:** The only value at this time is `ApplePay`.   | 
+**invoice_id** | **String** | The id of invoice this payment will apply to.  **Note:** When `processPayment` is `true`, this field is required. Only one invoice can be paid; for scenarios where you want to pay for multiple invoices, set `processPayment` to `false` and call payment API separately.  | [optional] 
+**merchant_id** | **String** | The Merchant ID that was configured for use with Apple Pay in the Apple iOS Developer Center.  | 
+**mit_consent_agreement_src** | [**StoredCredentialProfileConsentAgreementSrc**](StoredCredentialProfileConsentAgreementSrc.md) |  | [optional] 
+**mit_profile_action** | [**StoredCredentialProfileAction**](StoredCredentialProfileAction.md) |  | [optional] 
+**mit_profile_type** | [**StoredCredentialProfileType**](StoredCredentialProfileType.md) |  | [optional] 
+**payment_gateway** | **String** | The label name of the gateway instance configured in Zuora that should process the payment. When creating a Payment, this must be a valid gateway instance ID and this gateway must support the specific payment method. If not specified, the default gateway of your Zuora customer account will be used.  **Note:** When `processPayment` is `true`, this field is required. When `processPayment` is `false`, the default payment gateway of your Zuora customer account will be used no matter whether a payment gateway instance is specified in the `paymentGateway` field.  | [optional] 
+**payment_token** | **Object** | The complete JSON Object representing the encrypted payment token payload returned in the response from the Apple Pay session.   | 
+**process_payment** | **Boolean** | A boolean flag to control whether a payment should be processed after creating payment method. The payment amount will be equivalent to the amount the merchant supplied in the ApplePay session. Default is false.  If this field is set to `true`, you must specify the `paymentGateway` field with the payment gateway instance name.  If this field is set to `false`:   - The default payment gateway of your Zuora customer account will be used no matter whether a payment gateway instance is specified in the `paymentGateway` field.    - You must select the **Verify new credit card** check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway.   - A separate subscribe or payment API call is required after this payment method creation call.  | [optional] 
+
+

package/docs/CreatePaymentMethodDecryptionResponse.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.CreatePaymentMethodDecryptionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The payment amount contained within the encrypted token.  | [optional] 
+**payment_id** | **String** | The ID of newly processed payment,  | [optional] 
+**payment_method_id** | **String** | ID of the newly-created payment method.  | [optional] 
+**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
+
+

package/docs/CreatePaymentMethodGooglePayAdyenChase.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.CreatePaymentMethodGooglePayAdyenChase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**google_payment_token** | **String** | 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).  | [optional] 
+
+

package/docs/CreatePaymentMethodPayPalAdaptive.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.CreatePaymentMethodPayPalAdaptive
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preapproval_key** | **String** | The PayPal preapproval key.  | [optional] 
+
+

package/docs/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreatePaymentMethodPayPalECPayPalNativeECPayPalCP
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**BAID** | **String** | ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.  | [optional] 
+**email** | **String** | 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`.  | [optional] 
+
+

package/docs/CreatePaymentMethodRequest.md

@@ -0,0 +1,64 @@
+# ZuoraSdkJs.CreatePaymentMethodRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**BAID** | **String** | ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.  | [optional] 
+**email** | **String** | 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`.  | [optional] 
+**preapproval_key** | **String** | The PayPal preapproval key.  | [optional] 
+**card_holder_info** | [**CreatePaymentMethodCardholderInfo**](CreatePaymentMethodCardholderInfo.md) |  | [optional] 
+**card_number** | **String** | 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.  | [optional] 
+**card_mask_number** | **String** | 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.   | [optional] 
+**card_type** | **String** | The type of the credit card. This field is required if `type` is set to `CreditCard`.  Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).  | [optional] 
+**check_duplicated** | **Boolean** | 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     ```  | [optional] 
+**expiration_month** | **Number** | 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.  | [optional] 
+**expiration_year** | **Number** | 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.  | [optional] 
+**mit_consent_agreement_ref** | **String** | Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.  | [optional] 
+**mit_consent_agreement_src** | [**StoredCredentialProfileConsentAgreementSrc**](StoredCredentialProfileConsentAgreementSrc.md) |  | [optional] 
+**mit_network_transaction_id** | **String** | Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.  | [optional] 
+**mit_profile_action** | [**StoredCredentialProfileAction**](StoredCredentialProfileAction.md) |  | [optional] 
+**mit_profile_agreed_on** | **String** | The date on which the profile is agreed. The date format is `yyyy-mm-dd`.  | [optional] 
+**mit_profile_type** | [**StoredCredentialProfileType**](StoredCredentialProfileType.md) |  | [optional] 
+**security_code** | **String** | CVV or CVV2 security code of the credit card.  To ensure PCI compliance, this value is not stored and cannot be queried.  | [optional] 
+**address_line1** | **String** | First address line, 255 characters or less.  | [optional] 
+**address_line2** | **String** | Second address line, 255 characters or less.  | [optional] 
+**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.  | [optional] 
+**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.  For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields.  | [optional] 
+**bank_account_number** | **String** | 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.  | [optional] 
+**bank_account_mask_number** | **String** | The masked bank account number associated with the ACH payment. This field is only required if the ACH payment method is created using tokens.  | [optional] 
+**bank_account_type** | [**PaymentMethodACHBankAccountType**](PaymentMethodACHBankAccountType.md) |  | [optional] 
+**bank_name** | **String** | The name of the bank where the ACH payment account is held. This field is only required if the `type` field is set to `ACH`.  When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.  | [optional] 
+**city** | **String** | City, 40 characters or less.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.       | [optional] 
+**country** | **String** | Country, must be a valid country name or abbreviation.  See [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) for the list of supported country names and abbreviations.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.  | [optional] 
+**phone** | **String** | Phone number, 40 characters or less.  | [optional] 
+**state** | **String** | State, must be a valid state name or 2-character abbreviation.  See [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.  | [optional] 
+**zip_code** | **String** | Zip code, 20 characters or less.  | [optional] 
+**IBAN** | **String** | The International Bank Account Number. This field is required if the `type` field is set to `SEPA`.  | [optional] 
+**account_holder_info** | [**CreatePaymentMethodBankTransferAccountHolderInfo**](CreatePaymentMethodBankTransferAccountHolderInfo.md) |  | [optional] 
+**account_number** | **String** | 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`)  | [optional] 
+**account_mask_number** | **String** | The masked account number of the payment method.  | [optional] 
+**bank_code** | **String** | 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`)  | [optional] 
+**branch_code** | **String** | 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`)  | [optional] 
+**business_identification_code** | **String** | The BIC code used for SEPA.  | [optional] 
+**currency_code** | **String** | 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.  | [optional] 
+**identity_number** | **String** | 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`)  | [optional] 
+**credit_card_mask_number** | **String** | 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.  | [optional] 
+**second_token_id** | **String** | 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.  | [optional] 
+**token_id** | **String** | 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.  | [optional] 
+**apple_payment_data** | **String** | 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).  | [optional] 
+**google_payment_token** | **String** | 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).  | [optional] 
+**account_key** | **String** | Internal ID of the customer account that will own the payment method.   To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted.  | [optional] 
+**payment_method_number** | **String** | To avoid the repetitive creation of identical payment methods, you can associate a unique identifier with the payment method.    You can specify a string within the allowed limits, or if none is provided, the system will automatically generate one for the payment method.  | [optional] 
+**auth_gateway** | **String** | 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.  | [optional] 
+**gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
+**ip_address** | **String** | 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.  | [optional] 
+**make_default** | **Boolean** | 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.  When you set this field to `true`, make sure the payment method is supported by the default payment gateway.  | [optional] [default to false]
+**mandate_info** | [**PaymentMethodRequestMandateInfo**](PaymentMethodRequestMandateInfo.md) |  | [optional] 
+**processing_options** | [**PaymentMethodRequestProcessingOptions**](PaymentMethodRequestProcessingOptions.md) |  | [optional] 
+**skip_validation** | **Boolean** | Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.   | [optional] [default to false]
+**type** | **String** | Type of the 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.  Note that Zuora is continuously adding new payment method types.  | 
+**tokenize** | **Boolean** | Specifies whether to tokenize the payment method. | [optional] [default to false]
+**tokens** | [**PaymentMethodRequestTokens**](PaymentMethodRequestTokens.md) |  | [optional] 
+
+

package/docs/CreatePaymentMethodResponse.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.CreatePaymentMethodResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[CreatePaymentMethodResponseReason]**](CreatePaymentMethodResponseReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**id** | **String** | Internal ID of the payment method that was created.  | [optional] 
+
+

package/docs/CreatePaymentMethodResponseReason.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreatePaymentMethodResponseReason
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code.  | [optional] 
+**message** | **String** | Error message.  | [optional] 
+
+

package/docs/CreatePaymentMethodUpdaterBatchRequest.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreatePaymentMethodUpdaterBatchRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_cycle_day** | **Number** | The billing cycle day. The allowed value is an integer in the range of 1 - 31.  The payment methods from accounts where the billing cycle day is the specified value in this field will be included in the updates.  | 
+**updater_account_id** | **String** | The ID (UUID) of the PMU account. This field must be a string of 32 characters consisting of digits and letters a - f.  | 
+
+

package/docs/CreatePaymentMethodUpdaterBatchResponse.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.CreatePaymentMethodUpdaterBatchResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The ID of the running process when the exception occurs. This field is available only if the `success` field is `false`.  | [optional] 
+**reasons** | [**[CreatePaymentMethodUpdaterBatchResponseReasons]**](CreatePaymentMethodUpdaterBatchResponseReasons.md) | The container of the error code and message. This field is available only if the `success` field is `false`.  | [optional] 
+**request_id** | **String** | The ID of the request. This field is available only if the `success` field is `false`  | [optional] 
+**success** | **Boolean** | Indicates whether the request to create a PMU batch is sent successfully.  | [optional] 
+
+

package/docs/CreatePaymentMethodUpdaterBatchResponseReasons.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreatePaymentMethodUpdaterBatchResponseReasons
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code.  | [optional] 
+**message** | **String** | Error message.  | [optional] 
+
+

package/docs/CreatePaymentPredebitNotifyRequest.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreatePaymentPredebitNotifyRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoice_key** | **String** | The unique ID or number of an invoice. For example, `4a8082e65b27f6c3015b89e4344c16b1`, or `INV00000003`.  | 
+**payment_method_id** | **String** | The ID of the payment method you want to use. If not provided, the default payment method of the customer account is used.  | [optional] 
+**payment_gateway_id** | **String** | The ID of the payment gateway instance you want to use. If not provided, the default payment gateway instance of the customer account is used.  | [optional] 
+
+

package/docs/CreatePaymentPredebitNotifyResponse.md

@@ -0,0 +1,18 @@
+# ZuoraSdkJs.CreatePaymentPredebitNotifyResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoice_id** | **String** | The ID of the invoice for which the pre-debit notification is triggered. | [optional] 
+**payment_method_id** | **String** | The id of the associated payment method. | [optional] 
+**gateway_id** | **String** | The id of the associated payment gateway. | [optional] 
+**gateway_type** | **String** | The gateway type used in this operation. Example - Adyen. | [optional] 
+**gateway_version** | **String** | The version number of the gateway used. | [optional] 
+**notification_reference_id** | **String** | The shopperNotificationReference value. | [optional] 
+**second_notification_reference_id** | **String** | The additional second reference ID returned from the gateway. | [optional] 
+**third_notification_reference_id** | **String** | The additional third reference ID returned from the gateway. | [optional] 
+**extra_parameters** | **String** | The extra optional parameter returned from the gateway. | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded. | [optional] 
+
+

package/docs/CreatePaymentRequest.md

@@ -0,0 +1,34 @@
+# ZuoraSdkJs.CreatePaymentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account that the payment is created for.  | [optional] 
+**account_number** | **String** | The number of the customer account that the payment is created for, such as `A00000001`.  You can specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.  | [optional] 
+**amount** | **Number** | The total amount of the payment.  | 
+**auth_transaction_id** | **String** | The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.  When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/Post_CreateAuthorization) operation, together with the `authTransactionId` field.  The following payment gateways support this field:   - Adyen Integration v2.0   - CyberSource 1.28   - CyberSource 1.97   - CyberSource 2.0   - Chase Paymentech Orbital   - Ingenico ePayments   - SlimPay   - Stripe v2   - Verifi Global Payment Gateway   - WePay Payment Gateway Integration  | [optional] 
+**comment** | **String** | Additional information related to the payment.  | [optional] 
+**currency** | **String** | When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.  When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.  | 
+**custom_rates** | [**[PaymentWithCustomRates]**](PaymentWithCustomRates.md) | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).  **Note**: The API custom rate feature is permission controlled.  | [optional] 
+**debit_memos** | [**[CreatePaymentDebitMemoApplication]**](CreatePaymentDebitMemoApplication.md) | Container for debit memos. The maximum number of debit memos is 1,000.  | [optional] 
+**effective_date** | **String** | The date when the payment takes effect, in `yyyy-mm-dd` format.  **Note:**   - This field is required for only electronic payments. It's an optional field for external payments.   - When specified, this field must be set to the date of today.  | [optional] 
+**finance_information** | [**PaymentRequestFinanceInformation**](PaymentRequestFinanceInformation.md) |  | [optional] 
+**gateway_id** | **String** | The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.   - When creating electronic payments, this field is required.  - When creating external payments, this field is optional.  | [optional] 
+**payment_gateway_number** | **String** | The natural key for the payment gateway.  | [optional] 
+**gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
+**gateway_order_id** | **String** | A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.  Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.  When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/Post_CreateAuthorization) operation, together with the `authTransactionId` field.  | [optional] 
+**invoices** | [**[CreatePaymentInvoiceApplication]**](CreatePaymentInvoiceApplication.md) | Container for invoices. The maximum number of invoices is 1,000.  | [optional] 
+**mit_transaction_source** | [**MitTransactionSource**](MitTransactionSource.md) |  | [optional] 
+**payment_method_id** | **String** | The unique ID of the payment method that the customer used to make the payment.   If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.  | [optional] 
+**payment_method_type** | **String** | The type of the payment method that the customer used to make the payment.   Specify this value when you are creating an external payment method. If both `paymentMethodType` and `paymentMethodId` are specified, only the `paymentMethodId` value is used to create the payment.  | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  You can use this field or the `gatewayOptions` field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the `paymentOption` field will be stored in the Payment Option object and can be easily retrieved.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to 337.0 or later.  | [optional] 
+**payment_schedule_key** | **String** | The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. | [optional] 
+**prepayment** | **Boolean** | Indicates whether the payment will be used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.  | [optional] 
+**reference_id** | **String** | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.  | [optional] 
+**soft_descriptor** | **String** | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | [optional] 
+**soft_descriptor_phone** | **String** | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | [optional] 
+**standalone** | **Boolean** | This field is only available if support for standalone payments is enabled.  Specify `true` to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora.  When `standalone` is set to `true`:   - `accountId`, `amount`, `currency`, and `type` are required.    - `type` must be `Electronic`.   - `currency` of the payment can be different from the payment currency in the customer account settings.   - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.   - No settlement data will be created.   - Either the applied amount or the unapplied amount of the payment is zero.   - The standalone payment cannot be applied, unapplied, or transferred.  Specify `false` to create an ordinary payment that will be created, processed, and settled in Zuora. The `currency` of an ordinary payment must be the same as the currency in the customer account settings.  | [optional] 
+**type** | [**PaymentType**](PaymentType.md) |  | 
+
+

package/docs/CreatePaymentRunData.md

@@ -0,0 +1,31 @@
+# ZuoraSdkJs.CreatePaymentRunData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | A valid account ID associated with the payment run.  If `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.  | [optional] 
+**account_number** | **String** | The number of the customer account associated with the payment run, such as `A00000001`.  You can specify either `accountNumber` or `accountId` for a customer account, but not both of them.  If `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices, debit memos, and standalone payments due on an account.  | [optional] 
+**amount** | **Number** | The amount to be collected for the specified invoice/debit memo. `amount` must be a positive numeric value no more than the balance of the specified invoice/debit memo.  This field is only available when `documentId` is specified. If `amount` is not specified, whole balance of the invoice/debit memo is collected.  | [optional] 
+**comment** | **String** | Additional comments.  | [optional] 
+**currency** | **String** | Note: This field is only available if support for standalone payments is enabled.  The currency of the standalone payment. Specify this field only if the `standalone` field is `true`. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.  | [optional] 
+**document_id** | **String** | The ID of a billing document associated with the payment run. `documentId` must be valid and match with `documentType`.  You must either specify both `documentId` and `documentType`, or specify neither of them.  If neither of `documentType` and `documentId` is specified, all invoices/debit memos with open balance of the account are collected.  | [optional] 
+**document_number** | **String** | The number of a billing document associated with the payment run. `documentNumber` must be valid and match with `documentType`.  You must either specify both `documentNumber` and `documentType`, or specify neither of them.  If neither of `documentType` and `documentNumber` is specified, all invoices/debit memos with open balance of the account are collected.  | [optional] 
+**document_type** | **String** | The type of a billing document associated with the payment run. The value can be `Invoice` or `DebitMemo`, but `DebitMemo` is only supported if the Invoice Settlement feature is enabled.  You must either specify both `documentType` and `documentId`, or specify neither of them.  If neither of `documentType` and `documentId` is specified, all invoices/debit memos with open balance of the account are collected.  | [optional] 
+**payment_gateway_id** | **String** | The ID of the payment gateway for collecting invoices/debit memos. The specified payment gateway must be valid and active. If it is not specified, the default payment gateway of the account is used. If no payment gateway is configured for the account, the default payment gateway of the tenant is used.  If `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.  | [optional] 
+**payment_method_id** | **String** | The ID of the payment method for collecting invoices/debit memos. The specified payment method must be a valid non-system payment method. If it is not specified, the default payment method of the account is used regardless of the `autoPay` value of the account.  If `processPaymentWithClosedPM` is set to `false`, the payment method cannot be closed.  If the payment retry rules are enabled, the payment method must meet the rules.  If `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.  | [optional] 
+**standalone** | **Boolean** | Note: This field is only available if support for standalone payments is enabled.  Specify `true` to indicate that this is a standalone payment that will be created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. When `standalone` is set to `true`:   - `accountId` or `accountNumber` is required.   - `amount` is required.    - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.   - No settlement data will be created.   - Either the applied amount or the unapplied amount of the payment is zero.   - The standalone payment cannot be applied, unapplied, or transferred.  | [optional] 
+**data_items** | [**[CreatePaymentRunDataItem]**](CreatePaymentRunDataItem.md) |  | [optional] 
+
+
+
+## Enum: DocumentTypeEnum
+
+
+* `Invoice` (value: `"Invoice"`)
+
+* `DebitMemo` (value: `"DebitMemo"`)
+
+
+
+

package/docs/CreatePaymentRunDataItem.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreatePaymentRunDataItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_item_id** | **String** |  | [optional] 
+**amount** | **Number** |  | [optional] 
+**tax_item_id** | **String** |  | [optional] 
+
+

package/docs/CreatePaymentRunRequest.md

@@ -0,0 +1,23 @@
+# ZuoraSdkJs.CreatePaymentRunRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account associated with the payment run.  This field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned.  | [optional] 
+**apply_credit_balance** | **Boolean** | If `applyCreditBalance` is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.  | [optional] 
+**auto_apply_credit_memo** | **Boolean** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply a posted credit memo to one or more receivables in the payment run.  | [optional] 
+**auto_apply_unapplied_payment** | **Boolean** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply unapplied payments to  one or more receivables in the payment run.  | [optional] 
+**batch** | **String** | The alias name given to a batch. The batch name is a string of 50 characters or less.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.   | [optional] 
+**bill_cycle_day** | **String** | The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**billing_run_id** | **String** | The ID of a bill run.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**collect_payment** | **Boolean** | Whether to process electronic payments during the execution of payment runs.   If the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.  | [optional] 
+**consolidated_payment** | **Boolean** | **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process a single payment for all receivables that are due on an account.  | [optional] 
+**currency** | **String** | A currency defined in the web-based UI administrative settings.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**data** | [**[CreatePaymentRunData]**](CreatePaymentRunData.md) |  The array of data for specifying records of accounts and invoices/debit memos that will be collected and processed by a payment run.  When you specify the data array, ensure that at least one record is passed in. If an empty array is specified, `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields will be used to define the billing documents to be collected.  A maximum of 50K records are allowed to be passed into the `data` array.  Here is an example: ```   {     \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",     \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",     \"documentType\": \"Invoice\",     \"amount\": 80,     \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",     \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",     \"comment\": \"Payment Comments\",     \"customField1__c\": \"cf_value1\",     \"customField2__c\": \"cf_value2\"   } ```  Here is another example for a standalone payment: ```   {     \"accountId\": \"account2\",     \"amount\": 100,     \"currency\": \"GBP\",     \"standalone\": true   } ```  | [optional] 
+**payment_gateway_id** | **String** | The ID of the gateway instance that processes the payment.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**process_payment_with_closed_pm** | **Boolean** | **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process payments even if the default payment method is closed.  | [optional] 
+**run_date** | **String** | The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.  You must specify either the `runDate` field or the `targetDate` field in the request body. If you specify the `runDate` field, the scheduced payment run is to be executed on the run date. If you specify the `targetDate` field, the payment run is executed immediately after it is created.   | [optional] 
+**target_date** | **String** | The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.  You must specify either the `runDate` field or the `targetDate` field in the request body. If you specify the `runDate` field, the scheduced payment run is to be executed on the run date. If you specify the `targetDate` field, the payment run is executed immediately after it is created.   | [optional] 
+
+