ultracart_api 3.3.1 → 3.4.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +63 -4
- data/docs/ConfigurationApi.md +756 -0
- data/docs/DelayAutoOrdersResponse.md +12 -0
- data/docs/IntegrationLogApi.md +51 -0
- data/docs/IntegrationLogSummary.md +16 -0
- data/docs/IntegrationLogSummaryQueryRequest.md +9 -0
- data/docs/IntegrationLogSummaryQueryResponse.md +12 -0
- data/docs/PaymentsConfiguration.md +23 -0
- data/docs/PaymentsConfigurationAffirm.md +15 -0
- data/docs/PaymentsConfigurationAmazon.md +15 -0
- data/docs/PaymentsConfigurationCOD.md +13 -0
- data/docs/PaymentsConfigurationCash.md +9 -0
- data/docs/PaymentsConfigurationCheck.md +25 -0
- data/docs/PaymentsConfigurationCreditCard.md +16 -0
- data/docs/PaymentsConfigurationLoanHero.md +12 -0
- data/docs/PaymentsConfigurationPayPal.md +36 -0
- data/docs/PaymentsConfigurationPurchaseOrder.md +11 -0
- data/docs/PaymentsConfigurationQuoteRequest.md +10 -0
- data/docs/PaymentsConfigurationResponse.md +12 -0
- data/docs/PaymentsConfigurationRestrictions.md +19 -0
- data/docs/PaymentsConfigurationSezzle.md +15 -0
- data/docs/PaymentsConfigurationWePay.md +35 -0
- data/docs/PaymentsConfigurationWireTransfer.md +18 -0
- data/docs/PaymentsThemeTransactionType.md +10 -0
- data/docs/PaymentsWepayEnroll.md +22 -0
- data/docs/RotatingTransactionGateway.md +50 -0
- data/docs/RotatingTransactionGatewayResponse.md +12 -0
- data/docs/RotatingTransactionGatewaysResponse.md +12 -0
- data/docs/RtgCurrency.md +10 -0
- data/docs/RtgDayOfMonthRestriction.md +9 -0
- data/docs/RtgDayOfWeekRestriction.md +10 -0
- data/docs/RtgSummaryGateway.md +24 -0
- data/docs/RtgSummaryResponse.md +14 -0
- data/docs/RtgThemeRestriction.md +10 -0
- data/docs/SingleSignOnAuthorizeResponse.md +9 -0
- data/docs/SingleSignOnTokenResponse.md +10 -0
- data/docs/SsoApi.md +4 -4
- data/docs/StripeConnectResponse.md +12 -0
- data/docs/TransactionGateway.md +71 -0
- data/docs/TransactionGatewaysRequest.md +10 -0
- data/docs/TransactionGatewaysResponse.md +12 -0
- data/lib/ultracart_api.rb +38 -0
- data/lib/ultracart_api/api/configuration_api.rb +843 -0
- data/lib/ultracart_api/api/integration_log_api.rb +55 -0
- data/lib/ultracart_api/api/sso_api.rb +6 -6
- data/lib/ultracart_api/models/delay_auto_orders_response.rb +221 -0
- data/lib/ultracart_api/models/integration_log_summary.rb +256 -0
- data/lib/ultracart_api/models/integration_log_summary_query_request.rb +195 -0
- data/lib/ultracart_api/models/integration_log_summary_query_response.rb +223 -0
- data/lib/ultracart_api/models/payments_configuration.rb +319 -0
- data/lib/ultracart_api/models/payments_configuration_affirm.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_amazon.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_cash.rb +193 -0
- data/lib/ultracart_api/models/payments_configuration_check.rb +337 -0
- data/lib/ultracart_api/models/payments_configuration_cod.rb +229 -0
- data/lib/ultracart_api/models/payments_configuration_credit_card.rb +256 -0
- data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +220 -0
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +436 -0
- data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +211 -0
- data/lib/ultracart_api/models/payments_configuration_quote_request.rb +202 -0
- data/lib/ultracart_api/models/payments_configuration_response.rb +221 -0
- data/lib/ultracart_api/models/payments_configuration_restrictions.rb +283 -0
- data/lib/ultracart_api/models/payments_configuration_sezzle.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_we_pay.rb +427 -0
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +274 -0
- data/lib/ultracart_api/models/payments_theme_transaction_type.rb +239 -0
- data/lib/ultracart_api/models/payments_wepay_enroll.rb +310 -0
- data/lib/ultracart_api/models/rotating_transaction_gateway.rb +665 -0
- data/lib/ultracart_api/models/rotating_transaction_gateway_response.rb +221 -0
- data/lib/ultracart_api/models/rotating_transaction_gateways_response.rb +223 -0
- data/lib/ultracart_api/models/rtg_currency.rb +205 -0
- data/lib/ultracart_api/models/rtg_day_of_month_restriction.rb +195 -0
- data/lib/ultracart_api/models/rtg_day_of_week_restriction.rb +205 -0
- data/lib/ultracart_api/models/rtg_summary_gateway.rb +329 -0
- data/lib/ultracart_api/models/rtg_summary_response.rb +240 -0
- data/lib/ultracart_api/models/rtg_theme_restriction.rb +239 -0
- data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_token_response.rb +205 -0
- data/lib/ultracart_api/models/stripe_connect_response.rb +221 -0
- data/lib/ultracart_api/models/transaction_gateway.rb +823 -0
- data/lib/ultracart_api/models/transaction_gateways_request.rb +242 -0
- data/lib/ultracart_api/models/transaction_gateways_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +78 -2
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::PaymentsWepayEnroll
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**address1** | **String** | | [optional]
|
7
|
+
**address2** | **String** | | [optional]
|
8
|
+
**canada_accept_debit_cards** | **BOOLEAN** | | [optional]
|
9
|
+
**city** | **String** | | [optional]
|
10
|
+
**company** | **String** | | [optional]
|
11
|
+
**company_description** | **String** | | [optional]
|
12
|
+
**country** | **String** | | [optional]
|
13
|
+
**expected_revenue** | **String** | | [optional]
|
14
|
+
**industry** | **String** | | [optional]
|
15
|
+
**owner_email** | **String** | | [optional]
|
16
|
+
**owner_name** | **String** | | [optional]
|
17
|
+
**owner_phone** | **String** | | [optional]
|
18
|
+
**state** | **String** | | [optional]
|
19
|
+
**webiste_url** | **String** | | [optional]
|
20
|
+
**zip** | **String** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**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]
|
7
|
+
**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]
|
8
|
+
**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]
|
9
|
+
**base_currency_code** | **String** | The base currency code for your gateway. For example, USD. | [optional]
|
10
|
+
**cascade_code** | **String** | Optional field specifying a different rotating gateway to use if this gateway fails to process the transaction. | [optional]
|
11
|
+
**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]
|
12
|
+
**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]
|
13
|
+
**charge_appears_on_statement_as** | **String** | Optional field providing an alternate Charge Appears As value for this rotating gateway | [optional]
|
14
|
+
**code** | **String** | A human friendly short code used to recognize and differentiate this rotating gateway with other rotating gateways | [optional]
|
15
|
+
**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]
|
16
|
+
**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]
|
17
|
+
**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]
|
18
|
+
**customer_service_email** | **String** | The customer service email address for this gateway | [optional]
|
19
|
+
**customer_service_phone** | **String** | The customer service phone number for this gateway | [optional]
|
20
|
+
**day_of_month_restrictions** | [**Array<RtgDayOfMonthRestriction>**](RtgDayOfMonthRestriction.md) | Array containing all 31 (possible) days and any optional restrictions for one or more days. | [optional]
|
21
|
+
**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]
|
22
|
+
**deactivate_after_failures** | **Integer** | If non-zero, this gateway will be deactivated after reaching this amount of consecutive failures. | [optional]
|
23
|
+
**end_date** | **String** | Optional field to specify an absolute date when this gateway should stop accepting transactions | [optional]
|
24
|
+
**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]
|
25
|
+
**maximum_daily** | **Float** | The maximum daily dollar amount this gateway may process | [optional]
|
26
|
+
**maximum_daily_auto_order** | **Float** | The maximum daily dollar amount of auto orders (recurring) this gateway may process | [optional]
|
27
|
+
**maximum_monthly** | **Float** | The maximum monthly dollar amount this gateway may process. | [optional]
|
28
|
+
**next_daily_auto_order_reset** | **String** | The date and time when this gateway daily limit for auto orders will reset | [optional]
|
29
|
+
**next_daily_reset** | **String** | The date and time when this gateway daily limit will reset | [optional]
|
30
|
+
**next_monthly_reset** | **String** | The date and time when this gateway monthly limit will reset | [optional]
|
31
|
+
**order_total** | **Float** | This optional field is combined with order_total_comparison to determine if an order should be processed thorugh this gateway. | [optional]
|
32
|
+
**order_total_comparison** | **String** | The math operator used to determine if the order total is allowed to process through this gateway. | [optional]
|
33
|
+
**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]
|
34
|
+
**reserve_days** | **Integer** | The number of days that your gateway holds any reserves. This aids in profitability reporting. | [optional]
|
35
|
+
**reserve_percentage** | **Float** | The percentage of an order which your gateway is holding in reserve. This aids in profitability reporting. | [optional]
|
36
|
+
**reserve_refunded** | **BOOLEAN** | If true, reserves are refunded when an order is refunded. This aids in profitability reporting. | [optional]
|
37
|
+
**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]
|
38
|
+
**rotating_transaction_gateway_oid** | **Integer** | Internal identifier used to store and retrieve this gateway information | [optional]
|
39
|
+
**selected_gateway_name** | **String** | The name of the currently selected transaction gateway used by this rotating gateway | [optional]
|
40
|
+
**show_cascade_codes** | **BOOLEAN** | A boolean used by the builtin UltraCart UI to determine if cascading rtg codes should be shown | [optional]
|
41
|
+
**show_merchant_account_profiles** | **BOOLEAN** | A flag to help the UltraCart UI to know whether to show merchant account profiles or not. | [optional]
|
42
|
+
**start_date** | **String** | Optional field to specify an absolute date when this gateway should begin accepting transactions | [optional]
|
43
|
+
**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]
|
44
|
+
**theme_restrictions** | [**Array<RtgThemeRestriction>**](RtgThemeRestriction.md) | Optional restrictions by theme/storefront | [optional]
|
45
|
+
**traffic_percentage** | **Float** | Required field between 0 and 1 that dictates the percentage of traffic that should flow through this gateway | [optional]
|
46
|
+
**trial_daily_amount** | **Integer** | If specified, limits the total daily dollar amount of trial orders | [optional]
|
47
|
+
**trial_daily_limit** | **Integer** | If specified, limits the total month count of trial orders | [optional]
|
48
|
+
**trial_monthly_limit** | **Integer** | If specified, limits the total month dollar amount of trial orders | [optional]
|
49
|
+
|
50
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGatewayResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**rotating_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGatewaysResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**rotating_gateways** | [**Array<RotatingTransactionGateway>**](RotatingTransactionGateway.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/RtgCurrency.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgCurrency
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**currency_code** | **String** | Standard three letter currency code, for example USD | [optional]
|
7
|
+
**description** | **String** | Human friendly description of currency | [optional]
|
8
|
+
**selected** | **BOOLEAN** | true if this rotating gateway supports this currency | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::RtgDayOfMonthRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**day_of_month** | **Integer** | The day of the month. 1 equals the first day of the month, 31 is the last possible value. | [optional]
|
7
|
+
**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]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgDayOfWeekRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**abbreviation** | **String** | Human readable day of week abbreviation | [optional]
|
7
|
+
**day_of_week** | **Integer** | 1=Sun,2=Mon,3=Tue,4=Wed,5=Thu,6=Fri,7=Sat | [optional]
|
8
|
+
**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]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# UltracartClient::RtgSummaryGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cascade_code** | **String** | | [optional]
|
7
|
+
**code** | **String** | | [optional]
|
8
|
+
**delay_auto_orders** | **String** | | [optional]
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**reserve_percentage** | **Float** | | [optional]
|
11
|
+
**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]
|
12
|
+
**rotating_transaction_gateway_oid** | **Integer** | | [optional]
|
13
|
+
**show_ultracart_payments_verification** | **BOOLEAN** | | [optional]
|
14
|
+
**show_ultracart_payments_verified** | **BOOLEAN** | | [optional]
|
15
|
+
**status** | **String** | | [optional]
|
16
|
+
**supports_auth** | **String** | | [optional]
|
17
|
+
**supports_refund** | **String** | | [optional]
|
18
|
+
**third_party** | **String** | | [optional]
|
19
|
+
**traffic_percentage** | **Float** | | [optional]
|
20
|
+
**warning** | **String** | | [optional]
|
21
|
+
**wepay_account_update_uri** | **String** | | [optional]
|
22
|
+
**wepay_console_hostname** | **String** | | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::RtgSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**gateways** | [**Array<RtgSummaryGateway>**](RtgSummaryGateway.md) | | [optional]
|
7
|
+
**info_message** | **String** | | [optional]
|
8
|
+
**migration_rtg_code** | **String** | | [optional]
|
9
|
+
**migration_single_gateway_name** | **String** | | [optional]
|
10
|
+
**show_delay_auto_orders** | **BOOLEAN** | | [optional]
|
11
|
+
**show_migration** | **BOOLEAN** | | [optional]
|
12
|
+
**warning** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgThemeRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**restriction** | **String** | Any restriction for this theme | [optional]
|
7
|
+
**storefront_host_name** | **String** | The server name for this theme. This will not be populated for legacy (ancient) themes | [optional]
|
8
|
+
**theme_code** | **String** | Human friendly short code for this theme | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::SingleSignOnAuthorizeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_dts** | **String** | Expiration date/time after which the single sign-on login operation will have timed out | [optional]
|
7
|
+
**login_url** | **String** | The URL that you should redirect the customer's browser to. This URL will begin the login process. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::SingleSignOnTokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_dts** | **String** | Expiration date/time after which time the key is no longer valid | [optional]
|
7
|
+
**ip_address** | **String** | IP address of the user which we recommend you lock the simple key's usage to. | [optional]
|
8
|
+
**simple_key** | **String** | The simple key that can then be used to make SDK calls on the users behalf. | [optional]
|
9
|
+
|
10
|
+
|
data/docs/SsoApi.md
CHANGED
@@ -56,7 +56,7 @@ This endpoint does not need any parameter.
|
|
56
56
|
|
57
57
|
|
58
58
|
# **sso_authorize**
|
59
|
-
>
|
59
|
+
> SingleSignOnAuthorizeResponse sso_authorize(authorization_request)
|
60
60
|
|
61
61
|
Authorize a single sign on session
|
62
62
|
|
@@ -92,7 +92,7 @@ Name | Type | Description | Notes
|
|
92
92
|
|
93
93
|
### Return type
|
94
94
|
|
95
|
-
[**
|
95
|
+
[**SingleSignOnAuthorizeResponse**](SingleSignOnAuthorizeResponse.md)
|
96
96
|
|
97
97
|
### Authorization
|
98
98
|
|
@@ -150,7 +150,7 @@ nil (empty response body)
|
|
150
150
|
|
151
151
|
|
152
152
|
# **sso_token**
|
153
|
-
>
|
153
|
+
> SingleSignOnTokenResponse sso_token(token_request)
|
154
154
|
|
155
155
|
Exchange a single sign on code for a simple key token
|
156
156
|
|
@@ -186,7 +186,7 @@ Name | Type | Description | Notes
|
|
186
186
|
|
187
187
|
### Return type
|
188
188
|
|
189
|
-
[**
|
189
|
+
[**SingleSignOnTokenResponse**](SingleSignOnTokenResponse.md)
|
190
190
|
|
191
191
|
### Authorization
|
192
192
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::StripeConnectResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**connect_url** | **String** | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# UltracartClient::TransactionGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**arbitrary_html** | **String** | Additional html to display for this transaction gateway. This html will include instructions and connection links | [optional]
|
7
|
+
**comment** | **String** | Additional comments | [optional]
|
8
|
+
**credit_card_capable** | **BOOLEAN** | True if this gateway supports credit cards | [optional]
|
9
|
+
**echeck_capable** | **BOOLEAN** | True if this gateway supports eChecks | [optional]
|
10
|
+
**echeck_supported** | **String** | True if this gateway supports eChecks | [optional]
|
11
|
+
**enabled** | **BOOLEAN** | True if this transaction gateway is the currently active gateway. | [optional]
|
12
|
+
**gateway_cert_pem** | **String** | Cryptographic public certificate allowing UltraCart to communicate securely with this gateway. | [optional]
|
13
|
+
**gateway_cert_pem_label** | **String** | The label for the gateway certificate pem. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
14
|
+
**gateway_email** | **String** | Gateway Email | [optional]
|
15
|
+
**gateway_email_label** | **String** | The label for the gateway email. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
16
|
+
**gateway_environment** | **String** | Gateway Environment to indicate sandbox versus production environments | [optional]
|
17
|
+
**gateway_environment_label** | **String** | The label for the gateway environment. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
18
|
+
**gateway_environments** | **Array<String>** | Used to populate drop down lists for the gateway environment. Varies by gateway. | [optional]
|
19
|
+
**gateway_header_back_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
20
|
+
**gateway_header_border_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
21
|
+
**gateway_header_image_url** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
22
|
+
**gateway_key** | **String** | Gateway Key | [optional]
|
23
|
+
**gateway_key_label** | **String** | The label for the gateway key. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
24
|
+
**gateway_key_pem** | **String** | Cryptographic private key allowing UltraCart to communicate securely with this gateway. | [optional]
|
25
|
+
**gateway_key_pem_label** | **String** | The label for the gateway key pem. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
26
|
+
**gateway_landing_page** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
27
|
+
**gateway_merchant_id** | **String** | Gateway Merchant ID | [optional]
|
28
|
+
**gateway_merchant_id_label** | **String** | The label for the gateway merchant id. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
29
|
+
**gateway_mode** | **String** | Gateway Mode | [optional]
|
30
|
+
**gateway_mode_label** | **String** | The label for the gateway mode. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
31
|
+
**gateway_modes** | **Array<String>** | Used to populate drop down lists for gateway modes | [optional]
|
32
|
+
**gateway_page_style** | **String** | Gateway Page Style | [optional]
|
33
|
+
**gateway_page_style_label** | **String** | Gateway page style label | [optional]
|
34
|
+
**gateway_page_styles** | **Array<String>** | Used to populate drop down lists for gateway page style | [optional]
|
35
|
+
**gateway_partner** | **String** | Gateway Partner | [optional]
|
36
|
+
**gateway_partner_label** | **String** | The label for the gateway partner. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
37
|
+
**gateway_password** | **String** | Gateway Password | [optional]
|
38
|
+
**gateway_password_label** | **String** | The label for the gateway password. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
39
|
+
**gateway_payflow_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
40
|
+
**gateway_private_key_password** | **String** | Gateway private key password | [optional]
|
41
|
+
**gateway_private_key_password_label** | **String** | The label for the gateway private key password. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
42
|
+
**gateway_solution_type** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
43
|
+
**gateway_solution_type_label** | **String** | The label for the gateway solution type. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
44
|
+
**gateway_solution_types** | **Array<String>** | Used to populate drop down lists for gateway solution types | [optional]
|
45
|
+
**gateway_url** | **String** | Gateway URL | [optional]
|
46
|
+
**gateway_url_label** | **String** | The label for the gateway url. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
47
|
+
**gateway_username** | **String** | Gateway Username | [optional]
|
48
|
+
**gateway_username_label** | **String** | The label for the gateway username. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
49
|
+
**merchant_account_profile_amex** | **String** | If a merchant has multiple card processing accounts, this is the one to use for American Express cards. | [optional]
|
50
|
+
**merchant_account_profile_diners_club** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Diners Club cards. | [optional]
|
51
|
+
**merchant_account_profile_discover** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Discover cards. | [optional]
|
52
|
+
**merchant_account_profile_jcb** | **String** | If a merchant has multiple card processing accounts, this is the one to use for JCB cards. | [optional]
|
53
|
+
**merchant_account_profile_mastercard** | **String** | If a merchant has multiple card processing accounts, this is the one to use for MasterCard cards. | [optional]
|
54
|
+
**merchant_account_profile_visa** | **String** | If a merchant has multiple card processing accounts, this is the one to use for VISA cards. | [optional]
|
55
|
+
**merchant_id** | **String** | UltraCart Merchant ID | [optional]
|
56
|
+
**multi_currency_details** | **BOOLEAN** | True if this gateway provides details for multiple currency transactions | [optional]
|
57
|
+
**name** | **String** | Name of this transaction gateway | [optional]
|
58
|
+
**refund_supported** | **BOOLEAN** | True if this gateway supports refunds | [optional]
|
59
|
+
**require_echeck_tax_id_or_drivers_license** | **BOOLEAN** | If true, e-Check transaction will require either a Tax ID or a Driver License | [optional]
|
60
|
+
**support_vbv_3ds** | **BOOLEAN** | True if this gateway supported Verified-by-VISA 3D Secure | [optional]
|
61
|
+
**supports_amex** | **BOOLEAN** | If true, this gateway will attempt to process American Express transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
62
|
+
**supports_diners_club** | **BOOLEAN** | If true, this gateway will attempt to process Diners Club transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
63
|
+
**supports_discover** | **BOOLEAN** | If true, this gateway will attempt to process Discover transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
64
|
+
**supports_echeck** | **BOOLEAN** | If true, this gateway will attempt to process e-Check transactions. If false, the customer will not be allowed to use e-Checks. | [optional]
|
65
|
+
**supports_electronic_gift_card** | **BOOLEAN** | if true, this gateway will attempt to process electronic gift cards. | [optional]
|
66
|
+
**supports_jcb** | **BOOLEAN** | If true, this gateway will attempt to process JCB transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
67
|
+
**supports_mastercard** | **BOOLEAN** | If true, this gateway will attempt to process MasterCard transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
68
|
+
**supports_visa** | **BOOLEAN** | If true, this gateway will attempt to process VISA transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
69
|
+
**third_party** | **BOOLEAN** | True if this gateway supports third parties | [optional]
|
70
|
+
|
71
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::TransactionGatewaysRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**default_credit_card_transaction_type** | **String** | The default transaction type for this merchant account | [optional]
|
7
|
+
**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | | [optional]
|
8
|
+
**theme_credit_card_transaction_types** | [**Array<PaymentsThemeTransactionType>**](PaymentsThemeTransactionType.md) | A list of the storefronts and themes for this merchant account and what type of transaction should be attempted | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::TransactionGatewaysResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/lib/ultracart_api.rb
CHANGED
@@ -206,6 +206,7 @@ require 'ultracart_api/models/customer_tag'
|
|
206
206
|
require 'ultracart_api/models/customer_tax_codes'
|
207
207
|
require 'ultracart_api/models/customers_response'
|
208
208
|
require 'ultracart_api/models/data_tables_server_side_response'
|
209
|
+
require 'ultracart_api/models/delay_auto_orders_response'
|
209
210
|
require 'ultracart_api/models/distance'
|
210
211
|
require 'ultracart_api/models/distribution_center'
|
211
212
|
require 'ultracart_api/models/distribution_centers_response'
|
@@ -334,6 +335,9 @@ require 'ultracart_api/models/integration_log_query_filter_values'
|
|
334
335
|
require 'ultracart_api/models/integration_log_query_request'
|
335
336
|
require 'ultracart_api/models/integration_log_query_response'
|
336
337
|
require 'ultracart_api/models/integration_log_response'
|
338
|
+
require 'ultracart_api/models/integration_log_summary'
|
339
|
+
require 'ultracart_api/models/integration_log_summary_query_request'
|
340
|
+
require 'ultracart_api/models/integration_log_summary_query_response'
|
337
341
|
require 'ultracart_api/models/item'
|
338
342
|
require 'ultracart_api/models/item_accounting'
|
339
343
|
require 'ultracart_api/models/item_amember'
|
@@ -484,6 +488,24 @@ require 'ultracart_api/models/order_token_response'
|
|
484
488
|
require 'ultracart_api/models/order_tracking_number_detail'
|
485
489
|
require 'ultracart_api/models/order_tracking_number_details'
|
486
490
|
require 'ultracart_api/models/orders_response'
|
491
|
+
require 'ultracart_api/models/payments_configuration'
|
492
|
+
require 'ultracart_api/models/payments_configuration_affirm'
|
493
|
+
require 'ultracart_api/models/payments_configuration_amazon'
|
494
|
+
require 'ultracart_api/models/payments_configuration_cod'
|
495
|
+
require 'ultracart_api/models/payments_configuration_cash'
|
496
|
+
require 'ultracart_api/models/payments_configuration_check'
|
497
|
+
require 'ultracart_api/models/payments_configuration_credit_card'
|
498
|
+
require 'ultracart_api/models/payments_configuration_loan_hero'
|
499
|
+
require 'ultracart_api/models/payments_configuration_pay_pal'
|
500
|
+
require 'ultracart_api/models/payments_configuration_purchase_order'
|
501
|
+
require 'ultracart_api/models/payments_configuration_quote_request'
|
502
|
+
require 'ultracart_api/models/payments_configuration_response'
|
503
|
+
require 'ultracart_api/models/payments_configuration_restrictions'
|
504
|
+
require 'ultracart_api/models/payments_configuration_sezzle'
|
505
|
+
require 'ultracart_api/models/payments_configuration_we_pay'
|
506
|
+
require 'ultracart_api/models/payments_configuration_wire_transfer'
|
507
|
+
require 'ultracart_api/models/payments_theme_transaction_type'
|
508
|
+
require 'ultracart_api/models/payments_wepay_enroll'
|
487
509
|
require 'ultracart_api/models/permission'
|
488
510
|
require 'ultracart_api/models/pricing_tier'
|
489
511
|
require 'ultracart_api/models/pricing_tier_notification'
|
@@ -494,6 +516,15 @@ require 'ultracart_api/models/register_affiliate_click_request'
|
|
494
516
|
require 'ultracart_api/models/register_affiliate_click_response'
|
495
517
|
require 'ultracart_api/models/response_metadata'
|
496
518
|
require 'ultracart_api/models/result_set'
|
519
|
+
require 'ultracart_api/models/rotating_transaction_gateway'
|
520
|
+
require 'ultracart_api/models/rotating_transaction_gateway_response'
|
521
|
+
require 'ultracart_api/models/rotating_transaction_gateways_response'
|
522
|
+
require 'ultracart_api/models/rtg_currency'
|
523
|
+
require 'ultracart_api/models/rtg_day_of_month_restriction'
|
524
|
+
require 'ultracart_api/models/rtg_day_of_week_restriction'
|
525
|
+
require 'ultracart_api/models/rtg_summary_gateway'
|
526
|
+
require 'ultracart_api/models/rtg_summary_response'
|
527
|
+
require 'ultracart_api/models/rtg_theme_restriction'
|
497
528
|
require 'ultracart_api/models/screen_recording'
|
498
529
|
require 'ultracart_api/models/screen_recording_ad_platform'
|
499
530
|
require 'ultracart_api/models/screen_recording_filter'
|
@@ -546,10 +577,13 @@ require 'ultracart_api/models/screenshots_response'
|
|
546
577
|
require 'ultracart_api/models/self_config'
|
547
578
|
require 'ultracart_api/models/simple_value'
|
548
579
|
require 'ultracart_api/models/single_sign_on_authorize_request'
|
580
|
+
require 'ultracart_api/models/single_sign_on_authorize_response'
|
549
581
|
require 'ultracart_api/models/single_sign_on_token_request'
|
582
|
+
require 'ultracart_api/models/single_sign_on_token_response'
|
550
583
|
require 'ultracart_api/models/sovos_config'
|
551
584
|
require 'ultracart_api/models/state_province'
|
552
585
|
require 'ultracart_api/models/step_waiting'
|
586
|
+
require 'ultracart_api/models/stripe_connect_response'
|
553
587
|
require 'ultracart_api/models/tax_city'
|
554
588
|
require 'ultracart_api/models/tax_country'
|
555
589
|
require 'ultracart_api/models/tax_country_code'
|
@@ -579,6 +613,9 @@ require 'ultracart_api/models/transaction_email'
|
|
579
613
|
require 'ultracart_api/models/transaction_email_list_response'
|
580
614
|
require 'ultracart_api/models/transaction_email_option'
|
581
615
|
require 'ultracart_api/models/transaction_email_response'
|
616
|
+
require 'ultracart_api/models/transaction_gateway'
|
617
|
+
require 'ultracart_api/models/transaction_gateways_request'
|
618
|
+
require 'ultracart_api/models/transaction_gateways_response'
|
582
619
|
require 'ultracart_api/models/ultra_cart_config'
|
583
620
|
require 'ultracart_api/models/upload_coupon_codes_request'
|
584
621
|
require 'ultracart_api/models/upload_coupon_codes_response'
|
@@ -608,6 +645,7 @@ require 'ultracart_api/api/affiliate_api'
|
|
608
645
|
require 'ultracart_api/api/auto_order_api'
|
609
646
|
require 'ultracart_api/api/chargeback_api'
|
610
647
|
require 'ultracart_api/api/checkout_api'
|
648
|
+
require 'ultracart_api/api/configuration_api'
|
611
649
|
require 'ultracart_api/api/coupon_api'
|
612
650
|
require 'ultracart_api/api/customer_api'
|
613
651
|
require 'ultracart_api/api/fulfillment_api'
|