ultracart_api 3.10.14 → 3.10.17

data/docs/PaymentsConfiguration.md

@@ -1,24 +0,0 @@
-# UltracartClient::PaymentsConfiguration
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**affirm** | [**PaymentsConfigurationAffirm**](PaymentsConfigurationAffirm.md) |  | [optional] 
-**amazon** | [**PaymentsConfigurationAmazon**](PaymentsConfigurationAmazon.md) |  | [optional] 
-**cash** | [**PaymentsConfigurationCash**](PaymentsConfigurationCash.md) |  | [optional] 
-**check** | [**PaymentsConfigurationCheck**](PaymentsConfigurationCheck.md) |  | [optional] 
-**cod** | [**PaymentsConfigurationCOD**](PaymentsConfigurationCOD.md) |  | [optional] 
-**credit_card** | [**PaymentsConfigurationCreditCard**](PaymentsConfigurationCreditCard.md) |  | [optional] 
-**echeck** | [**PaymentsConfigurationEcheck**](PaymentsConfigurationEcheck.md) |  | [optional] 
-**insurance** | [**PaymentsConfigurationInsurance**](PaymentsConfigurationInsurance.md) |  | [optional] 
-**loan_hero** | [**PaymentsConfigurationLoanHero**](PaymentsConfigurationLoanHero.md) |  | [optional] 
-**money_order** | [**PaymentsConfigurationMoneyOrder**](PaymentsConfigurationMoneyOrder.md) |  | [optional] 
-**paypal** | [**PaymentsConfigurationPayPal**](PaymentsConfigurationPayPal.md) |  | [optional] 
-**purchase_order** | [**PaymentsConfigurationPurchaseOrder**](PaymentsConfigurationPurchaseOrder.md) |  | [optional] 
-**quote_request** | [**PaymentsConfigurationQuoteRequest**](PaymentsConfigurationQuoteRequest.md) |  | [optional] 
-**sezzle** | [**PaymentsConfigurationSezzle**](PaymentsConfigurationSezzle.md) |  | [optional] 
-**show_accounting_code** | **BOOLEAN** | Internal flag used to determine if accounting codes should be shown on the screen or not.  This flag is true if the merchant has a Quickbooks integration configured. | [optional] 
-**ultracart_payments_wepay** | [**PaymentsConfigurationWePay**](PaymentsConfigurationWePay.md) |  | [optional] 
-**wire_transfer** | [**PaymentsConfigurationWireTransfer**](PaymentsConfigurationWireTransfer.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationAffirm.md

@@ -1,15 +0,0 @@
-# UltracartClient::PaymentsConfigurationAffirm
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_affirm** | **BOOLEAN** | Master flag indicating this merchant accepts Affirm payments | [optional] 
-**accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional] 
-**environment** | **String** | Environment | [optional] 
-**financial_product_key** | **String** | Financial product key | [optional] 
-**private_api_key** | **String** | Private API key | [optional] 
-**public_api_key** | **String** | Public API key | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationAmazon.md

@@ -1,15 +0,0 @@
-# UltracartClient::PaymentsConfigurationAmazon
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_amazon** | **BOOLEAN** | Master flag to determine if this merchant accepts Pay by Amazon | [optional] 
-**access_key_id** | **String** | Amazon access key ID | [optional] 
-**accounting_code** | **String** | Optional accounting code for use with Quickbooks integrations | [optional] 
-**amazon_merchant_id** | **String** | Amazon merchant ID | [optional] 
-**deposit_to_account** | **String** | Optional deposit to account field for use with Quickbooks integrations | [optional] 
-**environment** | **String** | Environment | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**secret_access_key** | **String** | Amazon secret access key | [optional] 
-
-

data/docs/PaymentsConfigurationCOD.md

@@ -1,13 +0,0 @@
-# UltracartClient::PaymentsConfigurationCOD
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_cod** | **BOOLEAN** | Master flag indicating this merchant accepts COD | [optional] 
-**approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with COD | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**surcharge_accounting_code** | **String** | Optional field, if surcharge is set, this is the accounting code the surcharge is tagged with when sent to Quickbooks | [optional] 
-**surcharge_fee** | **Float** | Additional cost for using COD | [optional] 
-**surcharge_percentage** | **Float** | Additional percentage cost for using COD | [optional] 
-
-

data/docs/PaymentsConfigurationCash.md

@@ -1,9 +0,0 @@
-# UltracartClient::PaymentsConfigurationCash
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_cash** | **BOOLEAN** | Master flag indicating this merchant accepts cash | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationCheck.md

@@ -1,19 +0,0 @@
-# UltracartClient::PaymentsConfigurationCheck
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_check_orders** | **BOOLEAN** | Master flag indicating this merchant accepts paper checks | [optional] 
-**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
-**checks_payable_to** | **String** | This is who the customer makes the check out to | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
-**mail_to_address1** | **String** | MailTo address line 1 | [optional] 
-**mail_to_address2** | **String** | MailTo address line 2 | [optional] 
-**mail_to_city** | **String** | MailTo city | [optional] 
-**mail_to_country** | **String** | MailTo country | [optional] 
-**mail_to_name** | **String** | MailTo name | [optional] 
-**mail_to_postal_code** | **String** | MailTo postal code | [optional] 
-**mail_to_store** | **String** | MailTo store | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationCreditCard.md

@@ -1,17 +0,0 @@
-# UltracartClient::PaymentsConfigurationCreditCard
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_credit_card** | **BOOLEAN** | Master flag indicating whether this merchant accepts credit card payments | [optional] 
-**billed_by** | **String** | Description that appears on customer statements | [optional] 
-**charge_during_checkout** | **BOOLEAN** | If false, order will be accepted and placed into Accounts Receivable without charging card first | [optional] 
-**collect_cvv2** | **BOOLEAN** | UltraCart will require customer to enter cvv if this is true | [optional] 
-**configured_gateway_details** | **String** | Human readable description of the credit card gateway currently configured | [optional] 
-**failed_attempts** | **Integer** | The number of failed attempts before the order is placed into Accounts Receivable for manual intervention | [optional] 
-**hide_connect_single_gateway** | **BOOLEAN** | This internal flag aids the UI in determining which buttons to show. | [optional] 
-**send_customer_billing_update_on_decline** | **BOOLEAN** | UltraCart will send customers emails to update their credit card if the card is declined | [optional] 
-**supported_cards** | [**Array<PaymentsConfigurationCreditCardType>**](PaymentsConfigurationCreditCardType.md) | A list of credit cards the merchant wishes to accept. | [optional] 
-**test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | An array of test methods for placing test orders.  The cards defined here may be real or fake, but any order placed with them will be marked as Test orders | [optional] 
-
-

data/docs/PaymentsConfigurationCreditCardType.md

@@ -1,18 +0,0 @@
-# UltracartClient::PaymentsConfigurationCreditCardType
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accounting_code** | **String** | Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks | [optional] 
-**card_type_icon** | **String** | Internally used icon information for this card type | [optional] 
-**credit_card** | **String** | Credit card type | [optional] 
-**deposit_to_account** | **String** | The name of the account to deposit funds | [optional] 
-**enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional] 
-**processing_fee** | **Float** | Optional additional fee applied to order for this card | [optional] 
-**processing_percentage** | **Float** | Optional additional fee applied to order for this card | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**surcharge_accounting_code** | **String** | Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders | [optional] 
-**transaction_fee** | **Float** | An optional additional fee to charge the customer for using this card. | [optional] 
-**transaction_percentage** | **Float** | An optional transaction percentage to charge the customer for using this card | [optional] 
-
-

data/docs/PaymentsConfigurationEcheck.md

@@ -1,12 +0,0 @@
-# UltracartClient::PaymentsConfigurationEcheck
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_echeck** | **BOOLEAN** | Master flag indicating this merchant accepts eChecks | [optional] 
-**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | Test methods for this payment method | [optional] 
-
-

data/docs/PaymentsConfigurationInsurance.md

@@ -1,9 +0,0 @@
-# UltracartClient::PaymentsConfigurationInsurance
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_insurance** | **BOOLEAN** | Master flag indicating this merchant accepts insurance | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationLoanHero.md

@@ -1,12 +0,0 @@
-# UltracartClient::PaymentsConfigurationLoanHero
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_loan_hero** | **BOOLEAN** | Master flag indicating this merchant accepts Loan Hero | [optional] 
-**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**show_loan_hero** | **BOOLEAN** | Internal field to aid UI | [optional] 
-
-

data/docs/PaymentsConfigurationMoneyOrder.md

@@ -1,11 +0,0 @@
-# UltracartClient::PaymentsConfigurationMoneyOrder
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_money_orders** | **BOOLEAN** | Master flag for this merchant accepting money orders | [optional] 
-**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationPayPal.md

@@ -1,36 +0,0 @@
-# UltracartClient::PaymentsConfigurationPayPal
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_paypal** | **BOOLEAN** | Master flag that determine if PayPal is an active payment for this account | [optional] 
-**accounting_code** | **String** | Optional accounting code that is set to Quickbooks when an order uses this payment method. | [optional] 
-**api_password** | **String** | PayPal API password | [optional] 
-**api_username** | **String** | PayPal API username | [optional] 
-**certificate_on_file** | **BOOLEAN** | (Legacy) true if there is a PayPal certificate already on file. Used to manage the internal UI | [optional] 
-**deposit_to_account** | **String** | The account to deposit funds | [optional] 
-**email** | **String** | The main PayPal email address | [optional] 
-**environment** | **String** | PayPal configuration, live or sandbox | [optional] 
-**header_image_url** | **String** | The URL for the PayPal header | [optional] 
-**hide_bill_me_later** | **BOOLEAN** | True if the Bill Me Later button should be hidden during checkout | [optional] 
-**hide_express_checkout_on_view_cart** | **BOOLEAN** | True if the PayPal express checkout button should be hidden on the view cart page.  This will force the customer to enter address information before being able to checkout with PayPal | [optional] 
-**hide_for_unshipped_orders** | **BOOLEAN** | True if PayPal should be hidden for orders with no shippable product, such as digital orders | [optional] 
-**hold_in_ar** | **BOOLEAN** | If true, PayPal orders are held in Accounts Receivable for review | [optional] 
-**landing_page** | **String** | PayPal landing page | [optional] 
-**mode** | **String** | The PayPal mode | [optional] 
-**private_key_password** | **String** | PayPal API private key password | [optional] 
-**processing_fee** | **Float** | Optional additional fee to charge if PayPal is used.  It is rare for this to be used. | [optional] 
-**processing_percentage** | **Float** | The processing percentage charged by PayPal | [optional] 
-**push_paypal** | **BOOLEAN** | True if the internal UI should recommend opening a PayPal account | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**send_recurring** | **BOOLEAN** | True if UltraCart should send recurring orders to PayPal.  There are restrictions to what PayPal will accept for recurring orders.  Be careful. | [optional] 
-**short_paypal_marketing_text** | **BOOLEAN** | Short marketing text | [optional] 
-**show_card_logos_not_directly_supported** | **BOOLEAN** | internal ui flag | [optional] 
-**show_signature** | **BOOLEAN** | Internal flag used to manage UI | [optional] 
-**signature** | **String** | PayPal signature | [optional] 
-**solution_type** | **String** | PayPal solution type | [optional] 
-**summary_email** | **String** | The email where PayPal summaries should be sent | [optional] 
-**summary_mode** | **String** | Description of what mode PayPal is operating | [optional] 
-**zero_dollar_penny** | **BOOLEAN** | Send free items to PayPal as one cent items and subtract this penny from shipping.  PayPal does not allow the sale of free items. | [optional] 
-
-

data/docs/PaymentsConfigurationPurchaseOrder.md

@@ -1,11 +0,0 @@
-# UltracartClient::PaymentsConfigurationPurchaseOrder
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_purchase_orders** | **BOOLEAN** | Master flag indicating this merchant accepts purchase orders | [optional] 
-**approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with a purchase order | [optional] 
-**prevent_duplicate_number** | **BOOLEAN** | If true, customers may not use duplicate PO numbers for any order | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationQuoteRequest.md

@@ -1,10 +0,0 @@
-# UltracartClient::PaymentsConfigurationQuoteRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_quote_requests** | **BOOLEAN** | Master flag indicating this merchant accepts quote requests | [optional] 
-**approved_customers_only** | **BOOLEAN** | If true, only approved customers may use quote requests | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationResponse.md

@@ -1,12 +0,0 @@
-# UltracartClient::PaymentsConfigurationResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**Error**](Error.md) |  | [optional] 
-**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**payments_configuration** | [**PaymentsConfiguration**](PaymentsConfiguration.md) |  | [optional] 
-**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
-**warning** | [**Warning**](Warning.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationRestrictions.md

@@ -1,21 +0,0 @@
-# UltracartClient::PaymentsConfigurationRestrictions
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**descriptions** | **Array<String>** |  | [optional] 
-**maximum_subtotal** | **Float** | Maximum subtotal | [optional] 
-**minimum_subtotal** | **Float** | Minimum subtotal | [optional] 
-**payment_method** | **String** | Payment method | [optional] 
-**restriction_alaska_hawaii** | **String** | Alaska and Hawaii restriction | [optional] 
-**restriction_apo_fpo** | **String** | APO/FPO restriction | [optional] 
-**restriction_canada** | **String** | Canada restriction | [optional] 
-**restriction_continental_us** | **String** | Continental US restriction | [optional] 
-**restriction_domestic_only** | **String** | Domestic only restriction | [optional] 
-**restriction_international_only** | **String** | International only restriction | [optional] 
-**restriction_po_box** | **String** | PO Box restriction | [optional] 
-**restriction_puerto_rico** | **String** | Puerto Rico restriction | [optional] 
-**restriction_us_territories** | **String** | US Territories restriction | [optional] 
-**themes** | [**Array<PaymentsConfigurationRestrictionsTheme>**](PaymentsConfigurationRestrictionsTheme.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationRestrictionsTheme.md

@@ -1,10 +0,0 @@
-# UltracartClient::PaymentsConfigurationRestrictionsTheme
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** |  | [optional] 
-**restriction** | **String** |  | [optional] 
-**store_front_host_name** | **String** |  | [optional] 
-
-

data/docs/PaymentsConfigurationSezzle.md

@@ -1,15 +0,0 @@
-# UltracartClient::PaymentsConfigurationSezzle
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_sezzle** | **BOOLEAN** | Master flag for this merchant accepting Sezzle payments | [optional] 
-**accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional] 
-**business_id** | **String** | Business ID | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional] 
-**environment** | **String** | Sezzle environment | [optional] 
-**private_api_key** | **String** | Private API key | [optional] 
-**public_api_key** | **String** | Public API key | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-
-

data/docs/PaymentsConfigurationTestMethod.md

@@ -1,18 +0,0 @@
-# UltracartClient::PaymentsConfigurationTestMethod
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bank_account_number** | **String** | Bank account number | [optional] 
-**bank_routing_number** | **String** | Bank routing number | [optional] 
-**credit_card_number** | **String** | Credit card number | [optional] 
-**credit_card_number_existing** | **String** | The existing credit card number | [optional] 
-**description** | **String** | Description | [optional] 
-**payment_action** | **String** | Payment action | [optional] 
-**payment_method** | **String** | Payment method | [optional] 
-**payment_method_test_oid** | **Integer** | Payment method test oid | [optional] 
-**skip_affiliate_transaction** | **BOOLEAN** | Skip affiliate transaction | [optional] 
-**skip_conversion_pixels** | **BOOLEAN** | If true, skips recording any conversion pixels to avoid sending test orders to your analysis sites | [optional] 
-**skip_fraud_filter** | **BOOLEAN** | Skip fraud filter | [optional] 
-
-

data/docs/PaymentsConfigurationWePay.md

@@ -1,35 +0,0 @@
-# UltracartClient::PaymentsConfigurationWePay
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_wepay** | **BOOLEAN** | Master flag indicating this merchant accepts UltraCart Payments WePay | [optional] 
-**account_update_uri** | **String** | URI for updating the WePay account | [optional] 
-**address1** | **String** | Address line 1 | [optional] 
-**address2** | **String** | Address line 2 | [optional] 
-**canada_accept_debit_cards** | **BOOLEAN** | For Canadian merchants, true if they wish to accept debit cards | [optional] 
-**city** | **String** | City | [optional] 
-**company** | **String** | Company | [optional] 
-**company_description** | **String** | Company description | [optional] 
-**console_hostname** | **String** | Console hostname | [optional] 
-**country** | **String** | Country | [optional] 
-**credit_card_rate** | **String** | WePay credit card rate | [optional] 
-**currency** | **String** | Base currency for transactions | [optional] 
-**expected_revenue** | **String** | Expected Revenue | [optional] 
-**hide_credit_card_non_ultracart_payments** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**hide_surcharge_amount** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**industry** | **String** | Industry | [optional] 
-**owner_email** | **String** | Owner email | [optional] 
-**owner_name** | **String** | Owner name | [optional] 
-**owner_phone** | **String** | Owner phone | [optional] 
-**postal_code** | **String** | Postal code | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**short_paypal_marketing_text** | **BOOLEAN** | Internal UI aid | [optional] 
-**show_ultracart_payments_disabled** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**show_ultracart_payments_intro** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**show_ultracart_payments_verification** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**show_ultracart_payments_verified** | **BOOLEAN** | Internal flag to aid UI | [optional] 
-**state** | **String** | State | [optional] 
-**website_url** | **String** | Website URL | [optional] 
-
-

data/docs/PaymentsConfigurationWireTransfer.md

@@ -1,18 +0,0 @@
-# UltracartClient::PaymentsConfigurationWireTransfer
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_wire_transfer** | **BOOLEAN** | Master flag indicating this merchant accepts wire transfers | [optional] 
-**account_number** | **String** | account_number | [optional] 
-**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
-**bank_address** | **String** | Bank address | [optional] 
-**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
-**intermediate_routing_number** | **String** | Intermediate routing number | [optional] 
-**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**routing_number** | **String** | Routing number | [optional] 
-**surcharge_accounting_code** | **String** | If a surcharge is present and this merchant is integrated with Quickbooks, this is the accounting code for the surcharge amount | [optional] 
-**surcharge_fee** | **Float** | surcharge_fee | [optional] 
-**surcharge_percentage** | **Float** | surcharge_percentage | [optional] 
-
-

data/docs/PaymentsThemeTransactionType.md

@@ -1,10 +0,0 @@
-# UltracartClient::PaymentsThemeTransactionType
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | External human readable identifier for a theme | [optional] 
-**credit_card_transaction_type** | **String** | The credit card transaction type for this theme | [optional] 
-**screen_branding_theme_oid** | **Integer** | Internal identifier for a theme | [optional] 
-
-

data/docs/PaymentsWepayEnroll.md

@@ -1,22 +0,0 @@
-# UltracartClient::PaymentsWepayEnroll
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address1** | **String** |  | [optional] 
-**address2** | **String** |  | [optional] 
-**canada_accept_debit_cards** | **BOOLEAN** |  | [optional] 
-**city** | **String** |  | [optional] 
-**company** | **String** |  | [optional] 
-**company_description** | **String** |  | [optional] 
-**country** | **String** |  | [optional] 
-**expected_revenue** | **String** |  | [optional] 
-**industry** | **String** |  | [optional] 
-**owner_email** | **String** |  | [optional] 
-**owner_name** | **String** |  | [optional] 
-**owner_phone** | **String** |  | [optional] 
-**state** | **String** |  | [optional] 
-**webiste_url** | **String** |  | [optional] 
-**zip** | **String** |  | [optional] 
-
-

data/docs/RotatingTransactionGateway.md

@@ -1,51 +0,0 @@
-# UltracartClient::RotatingTransactionGateway
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**additional_native_currency_codes** | [**Array<RtgCurrency>**](RtgCurrency.md) | An array of all currencies known to the UltraCart system and a boolean indicating whether this gateway supports that currency. | [optional] 
-**auto_order_cancel_unless_response_name** | **String** | Advanced feature for canceling an auto order unless the transaction gateway response contains a field with this name.  If specified, this field must exist and the value must equal a value in the auto_order_cancel_unless_response_values array | [optional] 
-**auto_order_cancel_unless_response_values** | **Array<String>** | Advanced feature for canceling an auto order unless the transaction gateway response contains a field with the name specified in auto_order_cancel_unless_response_name.  If specified, this field must exist and the value must equal a value in this array.  If nothing matches, the auto order is canceled. | [optional] 
-**base_currency_code** | **String** | The base currency code for your gateway.  For example, USD. | [optional] 
-**cascade_code** | **String** | Optional field specifying a different rotating gateway to use if this gateway fails to process the transaction. | [optional] 
-**cascade_codes** | **Array<String>** | A list of other rotating transaction gateways that can be used as a lookup to assign actions based on failures of this gateway | [optional] 
-**cascade_daily_auto_order_code** | **String** | The code for the next rotating gateway that should be used when this gateway reaches a daily limit | [optional] 
-**charge_appears_on_statement_as** | **String** | Optional field providing an alternate Charge Appears As value for this rotating gateway | [optional] 
-**code** | **String** | A human friendly short code used to recognize and differentiate this rotating gateway with other rotating gateways | [optional] 
-**current_daily** | **Float** | The current daily dollar amount this gateway has processed.  Providing this will allow UltraCart to track the monthly amount going forward. | [optional] 
-**current_daily_auto_order** | **Float** | The current daily dollar amount of auto orders (recurring) this gateway has processed.  Providing this will allow UltraCart to track the monthly amount going forward. | [optional] 
-**current_monthly** | **Float** | The current monthly dollar amount this gateway has processed.  Providing this will allow UltraCart to track the monthly amount going forward. | [optional] 
-**customer_service_email** | **String** | The customer service email address for this gateway | [optional] 
-**customer_service_phone** | **String** | The customer service phone number for this gateway | [optional] 
-**day_of_month_restrictions** | [**Array<RtgDayOfMonthRestriction>**](RtgDayOfMonthRestriction.md) | Array containing all 31 (possible) days and any optional restrictions for one or more days. | [optional] 
-**day_of_week_restrictions** | [**Array<RtgDayOfWeekRestriction>**](RtgDayOfWeekRestriction.md) | Array containing all seven days of the week and any optional restrictions for one or more days | [optional] 
-**deactivate_after_failures** | **Integer** | If non-zero, this gateway will be deactivated after reaching this amount of consecutive failures. | [optional] 
-**end_date** | **String** | Optional field to specify an absolute date when this gateway should stop accepting transactions | [optional] 
-**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | An array of all transaction gateways, not just the one currently configured for this rotating gateway. This allows for easy switching to another gateway.  The enabled property on the transaction gateway indicates which one is actually being used. | [optional] 
-**maximum_daily** | **Float** | The maximum daily dollar amount this gateway may process | [optional] 
-**maximum_daily_auto_order** | **Float** | The maximum daily dollar amount of auto orders (recurring) this gateway may process | [optional] 
-**maximum_monthly** | **Float** | The maximum monthly dollar amount this gateway may process. | [optional] 
-**next_daily_auto_order_reset** | **String** | The date and time when this gateway daily limit for auto orders will reset | [optional] 
-**next_daily_reset** | **String** | The date and time when this gateway daily limit will reset | [optional] 
-**next_monthly_reset** | **String** | The date and time when this gateway monthly limit will reset | [optional] 
-**order_total** | **Float** | This optional field is combined with order_total_comparison to determine if an order should be processed thorugh this gateway. | [optional] 
-**order_total_comparison** | **String** | The math operator used to determine if the order total is allowed to process through this gateway. | [optional] 
-**rebill_auto_orders_against_this_rtg_code** | **String** | If specified auto orders (rebills) are routed to this rotating gateway.  This may be needed because rebills lack a credit card cvv. | [optional] 
-**reserve_days** | **Integer** | The number of days that your gateway holds any reserves.  This aids in profitability reporting. | [optional] 
-**reserve_percentage** | **Float** | The percentage of an order which your gateway is holding in reserve.  This aids in profitability reporting. | [optional] 
-**reserve_refunded** | **BOOLEAN** | If true, reserves are refunded when an order is refunded.  This aids in profitability reporting. | [optional] 
-**reserves_released_through** | **String** | An optional date specifying the date up to which your gateway has released all reserve funds.  This aids in profitability reporting. | [optional] 
-**rotating_transaction_gateway_oid** | **Integer** | Internal identifier used to store and retrieve this gateway information | [optional] 
-**selected_gateway_name** | **String** | The name of the currently selected transaction gateway used by this rotating gateway | [optional] 
-**show_cascade_codes** | **BOOLEAN** | A boolean used by the builtin UltraCart UI to determine if cascading rtg codes should be shown | [optional] 
-**show_merchant_account_profiles** | **BOOLEAN** | A flag to help the UltraCart UI to know whether to show merchant account profiles or not. | [optional] 
-**start_date** | **String** | Optional field to specify an absolute date when this gateway should begin accepting transactions | [optional] 
-**status** | **String** | A field used to take a gateway offline without removing/deleting the configuration. Inactive marks the gateway as completely unusable.  Standby takes the gateway offline and will not be used unless all other active gateways fail. | [optional] 
-**theme_restrictions** | [**Array<RtgThemeRestriction>**](RtgThemeRestriction.md) | Optional restrictions by theme/storefront | [optional] 
-**traffic_percentage** | **Float** | Required field between 0 and 1 that dictates the percentage of traffic that should flow through this gateway | [optional] 
-**trial_daily_amount** | **Integer** | If specified, limits the total daily count of trial orders | [optional] 
-**trial_daily_limit** | **Integer** | If specified, limits the total daily dollar amount of trial orders | [optional] 
-**trial_monthly_amount** | **Integer** | If specified, limits the total month dollar amount of trial orders | [optional] 
-**trial_monthly_limit** | **Integer** | If specified, limits the total month count of trial orders | [optional] 
-
-

data/docs/RotatingTransactionGatewayResponse.md

@@ -1,12 +0,0 @@
-# UltracartClient::RotatingTransactionGatewayResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**Error**](Error.md) |  | [optional] 
-**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**rotating_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md) |  | [optional] 
-**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
-**warning** | [**Warning**](Warning.md) |  | [optional] 
-
-

data/docs/RotatingTransactionGatewaysResponse.md

@@ -1,12 +0,0 @@
-# UltracartClient::RotatingTransactionGatewaysResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**Error**](Error.md) |  | [optional] 
-**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**rotating_gateways** | [**Array<RotatingTransactionGateway>**](RotatingTransactionGateway.md) |  | [optional] 
-**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
-**warning** | [**Warning**](Warning.md) |  | [optional] 
-
-

data/docs/RtgCurrency.md

@@ -1,10 +0,0 @@
-# UltracartClient::RtgCurrency
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency_code** | **String** | Standard three letter currency code, for example USD | [optional] 
-**description** | **String** | Human friendly description of currency | [optional] 
-**selected** | **BOOLEAN** | true if this rotating gateway supports this currency | [optional] 
-
-

data/docs/RtgDayOfMonthRestriction.md

@@ -1,9 +0,0 @@
-# UltracartClient::RtgDayOfMonthRestriction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**day_of_month** | **Integer** | The day of the month. 1 equals the first day of the month, 31 is the last possible value. | [optional] 
-**selected** | **BOOLEAN** | True if this rotating gateway is allowed to operate on this day of month.  If no days are selected, all days are allowed. | [optional] 
-
-

data/docs/RtgDayOfWeekRestriction.md

@@ -1,10 +0,0 @@
-# UltracartClient::RtgDayOfWeekRestriction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**abbreviation** | **String** | Human readable day of week abbreviation | [optional] 
-**day_of_week** | **Integer** | 1=Sun,2=Mon,3=Tue,4=Wed,5=Thu,6=Fri,7=Sat | [optional] 
-**selected** | **BOOLEAN** | True if this rotating gateway is allowed to operate on this day of week.  If no days are selected, all days are allowed. | [optional] 
-
-

data/docs/RtgSummaryGateway.md

@@ -1,24 +0,0 @@
-# UltracartClient::RtgSummaryGateway
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cascade_code** | **String** |  | [optional] 
-**code** | **String** |  | [optional] 
-**delay_auto_orders** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**reserve_percentage** | **Float** |  | [optional] 
-**reserves_released_through** | **String** | An optional date specifying the date up to which your gateway has released all reserve funds.  This aids in profitability reporting. | [optional] 
-**rotating_transaction_gateway_oid** | **Integer** |  | [optional] 
-**show_ultracart_payments_verification** | **BOOLEAN** |  | [optional] 
-**show_ultracart_payments_verified** | **BOOLEAN** |  | [optional] 
-**status** | **String** |  | [optional] 
-**supports_auth** | **String** |  | [optional] 
-**supports_refund** | **String** |  | [optional] 
-**third_party** | **String** |  | [optional] 
-**traffic_percentage** | **Float** |  | [optional] 
-**warning** | **String** |  | [optional] 
-**wepay_account_update_uri** | **String** |  | [optional] 
-**wepay_console_hostname** | **String** |  | [optional] 
-
-

data/docs/RtgSummaryResponse.md

@@ -1,14 +0,0 @@
-# UltracartClient::RtgSummaryResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**gateways** | [**Array<RtgSummaryGateway>**](RtgSummaryGateway.md) |  | [optional] 
-**info_message** | **String** |  | [optional] 
-**migration_rtg_code** | **String** |  | [optional] 
-**migration_single_gateway_name** | **String** |  | [optional] 
-**show_delay_auto_orders** | **BOOLEAN** |  | [optional] 
-**show_migration** | **BOOLEAN** |  | [optional] 
-**warning** | **String** |  | [optional] 
-
-

data/docs/RtgThemeRestriction.md

@@ -1,10 +0,0 @@
-# UltracartClient::RtgThemeRestriction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**restriction** | **String** | Any restriction for this theme | [optional] 
-**storefront_host_name** | **String** | The server name for this theme.  This will not be populated for legacy (ancient) themes | [optional] 
-**theme_code** | **String** | Human friendly short code for this theme | [optional] 
-
-

data/docs/StripeConnectResponse.md

@@ -1,12 +0,0 @@
-# UltracartClient::StripeConnectResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connect_url** | **String** |  | [optional] 
-**error** | [**Error**](Error.md) |  | [optional] 
-**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
-**warning** | [**Warning**](Warning.md) |  | [optional] 
-
-