csharp
java
javascript
php
python
ruby
typescript

configuration

/configuration

Retrieve payments configuration

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments

Retrieves payments configuration for this account.

SDK Function Name: getPaymentsConfiguration

Responses
Status Code Reason Response Model
200
Successful response PaymentsConfigurationResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates payments configuration

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
put
/configuration/checkout/payments

Updates payments configuration on the UltraCart account.

SDK Function Name: updatePaymentsConfiguration

Parameters
Parameter Description Location Data Type Required
payments_configuration Payments configuration body PaymentsConfiguration required
Responses
Status Code Reason Response Model
200
Successful response PaymentsConfigurationResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve a list of rotating transaction gateways

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments/rtg

Retrieve a list of rotating transaction gateways

SDK Function Name: getPaymentsRotatingTransactionGateways

Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewaysResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Insert a rotating transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
post
/configuration/checkout/payments/rtg/

Insert a rotating transaction gateway

SDK Function Name: insertRotatingTransactionGateway

Parameters
Parameter Description Location Data Type Required
rotating_transaction_gateway Rotating transaction gateway body RotatingTransactionGateway required
Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewayResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve a rotating transaction gateway by code

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments/rtg/byCode/{code}

Retrieve a rotating transaction gateway by code

SDK Function Name: getPaymentsRotatingGatewayByCode

Parameters
Parameter Description Location Data Type Required
code The code for the desired rotating transaction gateway. path string required
Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewayResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve a summary of rotating transaction gateways

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments/rtg/summaries

Retrieve a summary of rotating transaction gateways

SDK Function Name: getPaymentsRtgSummaries

Responses
Status Code Reason Response Model
200
Successful response RtgSummaryResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Delete a rotating transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
delete
/configuration/checkout/payments/rtg/{rtg_oid}

Delete a rotating transaction gateway

SDK Function Name: deleteRotatingTransactionGateway

Parameters
Parameter Description Location Data Type Required
rtg_oid The rtg_oid to delete. path integer (int32) required
Responses
Status Code Reason Response Model
200
Successful response BaseResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve a rotating transaction gateway

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments/rtg/{rtg_oid}

Retrieve a rotating transaction gateway

SDK Function Name: getPaymentsRotatingGateway

Parameters
Parameter Description Location Data Type Required
rtg_oid The rtg_oid for the desired record. path integer (int32) required
Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewayResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update a rotating transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
put
/configuration/checkout/payments/rtg/{rtg_oid}

Update a rotating transaction gateway

SDK Function Name: updateRotatingTransactionGateway

Parameters
Parameter Description Location Data Type Required
rtg_oid The rtg_oid to update. path integer (int32) required
rotating_transaction_gateway Rotating transaction gateway body RotatingTransactionGateway required
Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewayResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Delay auto order processing for a day for this rotating transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
post
/configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders

Delay auto order processing for a day for this rotating transaction gateway

SDK Function Name: delayAutoOrders

Parameters
Parameter Description Location Data Type Required
rtg_oid The rtg_oid to delay. path integer (int32) required
Responses
Status Code Reason Response Model
200
Successful response DelayAutoOrdersResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Begin the processing of connecting with Stripe

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
post
/configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect

Begin the processing of connecting with Stripe.

SDK Function Name: stripeConnect

Parameters
Parameter Description Location Data Type Required
rtg_oid The rtg_oid to be connected to stripe. path integer (int32) required
Responses
Status Code Reason Response Model
200
Successful response StripeConnectResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve a list of transaction gateways

Permissions:
  • configuration_read

Produces: application/json
get
/configuration/checkout/payments/tg

Retrieve a list of transaction gateways

SDK Function Name: getPaymentsTransactionGateways

Responses
Status Code Reason Response Model
200
Successful response TransactionGatewaysResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates payments transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
put
/configuration/checkout/payments/tg

Updates payments transaction gateway on the UltraCart account.

SDK Function Name: updatePaymentsTransactionGateway

Parameters
Parameter Description Location Data Type Required
update_gateway_request Transaction gateways body TransactionGatewaysRequest required
Responses
Status Code Reason Response Model
200
Successful response TransactionGatewaysResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Migrate a normal transaction gateway to a rotating transaction gateway

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
post
/configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code}

Migrate a normal transaction gateway to a rotating transaction gateway

SDK Function Name: migrateToRotatingTransactionGateway

Parameters
Parameter Description Location Data Type Required
code The short code for the new rotating transaction gateway path string required
Responses
Status Code Reason Response Model
200
Successful response RotatingTransactionGatewayResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Enroll with WePay

Permissions:
  • configuration_write

Consumes: application/json
Produces: application/json
put
/configuration/checkout/wepayEnroll

Enroll with WePay on the UltraCart account.

SDK Function Name: wepayEnroll

Parameters
Parameter Description Location Data Type Required
wepay_enroll Wepay enrollment information body PaymentsWepayEnroll required
Responses
Status Code Reason Response Model
200
Successful response PaymentsConfigurationResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

BaseResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

DelayAutoOrdersResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
message string
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

Error

Attributes
Name Data Type Description
developer_message string A technical message meant to be read by a developer
error_code string HTTP status code
more_info string Additional information often a link to additional documentation
object_id string Object id that the error is associated with
user_message string An end-user friendly message suitable for display to the customer

ErrorResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

PaymentsConfiguration

Attributes
Name Data Type Description
affirm PaymentsConfigurationAffirm Affirm configuration
amazon PaymentsConfigurationAmazon Amazon configuration
cash PaymentsConfigurationCash Cash configuration
check PaymentsConfigurationCheck Paper check configuration
cod PaymentsConfigurationCOD COD configuration
credit_card PaymentsConfigurationCreditCard Credit card configuration
echeck PaymentsConfigurationEcheck eCheck configuration
insurance PaymentsConfigurationInsurance Insurance configuration
loan_hero PaymentsConfigurationLoanHero Loan hero configuration
money_order PaymentsConfigurationMoneyOrder Money order configuration
paypal PaymentsConfigurationPayPal PayPal configuration
purchase_order PaymentsConfigurationPurchaseOrder Purchase order configuration
quote_request PaymentsConfigurationQuoteRequest Quote request configuration
sezzle PaymentsConfigurationSezzle Sezzle configuration
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.
ultracart_payments_wepay PaymentsConfigurationWePay WePay configuration
wire_transfer PaymentsConfigurationWireTransfer Wire transfer configuration

PaymentsConfigurationAffirm

Attributes
Name Data Type Description
accept_affirm boolean Master flag indicating this merchant accepts Affirm payments
accounting_code string Optional Quickbooks code for this payment method
deposit_to_account string Optional Quickbooks Deposit to Account value
environment string Environment
Allowed Values
  • Live
  • Sandbox
financial_product_key string Financial product key
private_api_key string Private API key
public_api_key string Public API key
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationAmazon

Attributes
Name Data Type Description
accept_amazon boolean Master flag to determine if this merchant accepts Pay by Amazon
access_key_id string Amazon access key ID
accounting_code string Optional accounting code for use with Quickbooks integrations
amazon_merchant_id string Amazon merchant ID
deposit_to_account string Optional deposit to account field for use with Quickbooks integrations
environment string Environment
Allowed Values
  • Live
  • Sandbox
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
secret_access_key string Amazon secret access key

PaymentsConfigurationCash

Attributes
Name Data Type Description
accept_cash boolean Master flag indicating this merchant accepts cash
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationCheck

Attributes
Name Data Type Description
accept_check_orders boolean Master flag indicating this merchant accepts paper checks
accounting_code string Optional Quickbooks accounting code
checks_payable_to string This is who the customer makes the check out to
deposit_to_account string Optional Quickbooks deposit to account
mail_to_address1 string MailTo address line 1
mail_to_address2 string MailTo address line 2
mail_to_city string MailTo city
mail_to_country string MailTo country
mail_to_name string MailTo name
mail_to_postal_code string MailTo postal code
mail_to_store string MailTo store
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationCOD

Attributes
Name Data Type Description
accept_cod boolean Master flag indicating this merchant accepts COD
approved_customers_only boolean If true, only approved customers may pay with COD
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
surcharge_accounting_code string Optional field, if surcharge is set, this is the accounting code the surcharge is tagged with when sent to Quickbooks
surcharge_fee number Additional cost for using COD
surcharge_percentage number Additional percentage cost for using COD

PaymentsConfigurationCreditCard

Attributes
Name Data Type Description
accept_credit_card boolean Master flag indicating whether this merchant accepts credit card payments
billed_by string Description that appears on customer statements
charge_during_checkout boolean If false, order will be accepted and placed into Accounts Receivable without charging card first
collect_cvv2 boolean UltraCart will require customer to enter cvv if this is true
configured_gateway_details (read only) string Human readable description of the credit card gateway currently configured
failed_attempts integer (int32) The number of failed attempts before the order is placed into Accounts Receivable for manual intervention
hide_connect_single_gateway (read only) boolean This internal flag aids the UI in determining which buttons to show.
send_customer_billing_update_on_decline boolean UltraCart will send customers emails to update their credit card if the card is declined
supported_cards array of PaymentsConfigurationCreditCardType A list of credit cards the merchant wishes to accept.
test_methods array of PaymentsConfigurationTestMethod 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

PaymentsConfigurationCreditCardType

Attributes
Name Data Type Description
accounting_code string Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks
card_type_icon (read only) string Internally used icon information for this card type
credit_card string Credit card type
Allowed Values
  • AMEX
  • Diners Club
  • Discover
  • MasterCard
  • JCB
  • VISA
deposit_to_account string The name of the account to deposit funds
enabled boolean If true, this card type will be accepted during checkout
processing_fee number Optional additional fee applied to order for this card
processing_percentage number Optional additional fee applied to order for this card
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
surcharge_accounting_code string Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders
transaction_fee number An optional additional fee to charge the customer for using this card.
transaction_percentage number An optional transaction percentage to charge the customer for using this card

PaymentsConfigurationEcheck

Attributes
Name Data Type Description
accept_echeck boolean Master flag indicating this merchant accepts eChecks
accounting_code string Optional Quickbooks accounting code
deposit_to_account string Optional Quickbooks deposit to account
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
test_methods array of PaymentsConfigurationTestMethod Test methods for this payment method

PaymentsConfigurationInsurance

Attributes
Name Data Type Description
accept_insurance boolean Master flag indicating this merchant accepts insurance
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationLoanHero

Attributes
Name Data Type Description
accept_loan_hero boolean Master flag indicating this merchant accepts Loan Hero
accounting_code string Optional Quickbooks accounting code
deposit_to_account string Optional Quickbooks deposit to account
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
show_loan_hero (read only) boolean Internal field to aid UI

PaymentsConfigurationMoneyOrder

Attributes
Name Data Type Description
accept_money_orders boolean Master flag for this merchant accepting money orders
accounting_code string Optional Quickbooks accounting code
deposit_to_account string Optional Quickbooks deposit to account
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationPayPal

Attributes
Name Data Type Description
accept_paypal boolean Master flag that determine if PayPal is an active payment for this account
accounting_code string Optional accounting code that is set to Quickbooks when an order uses this payment method.
api_password string PayPal API password
api_username string PayPal API username
certificate_on_file (read only) boolean (Legacy) true if there is a PayPal certificate already on file. Used to manage the internal UI
deposit_to_account string The account to deposit funds
email string The main PayPal email address
environment string PayPal configuration, live or sandbox
Allowed Values
  • Live
  • Sandbox
header_image_url string The URL for the PayPal header
hide_bill_me_later boolean True if the Bill Me Later button should be hidden during checkout
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
hide_for_unshipped_orders boolean True if PayPal should be hidden for orders with no shippable product, such as digital orders
hold_in_ar boolean If true, PayPal orders are held in Accounts Receivable for review
landing_page string PayPal landing page
Allowed Values
  • Billing
  • Login
mode string The PayPal mode
Allowed Values
  • WPPECO
  • WPPECDP
private_key_password string PayPal API private key password
processing_fee number Optional additional fee to charge if PayPal is used. It is rare for this to be used.
processing_percentage number The processing percentage charged by PayPal
push_paypal (read only) boolean True if the internal UI should recommend opening a PayPal account
restrictions PaymentsConfigurationRestrictions Restrictions
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.
short_paypal_marketing_text boolean Short marketing text
show_card_logos_not_directly_supported (read only) boolean internal ui flag
show_signature (read only) boolean Internal flag used to manage UI
signature string PayPal signature
solution_type string PayPal solution type
Allowed Values
  • Sole
  • Mark
summary_email string The email where PayPal summaries should be sent
summary_mode (read only) string Description of what mode PayPal is operating
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.

PaymentsConfigurationPurchaseOrder

Attributes
Name Data Type Description
accept_purchase_orders boolean Master flag indicating this merchant accepts purchase orders
approved_customers_only boolean If true, only approved customers may pay with a purchase order
prevent_duplicate_number boolean If true, customers may not use duplicate PO numbers for any order
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationQuoteRequest

Attributes
Name Data Type Description
accept_quote_requests boolean Master flag indicating this merchant accepts quote requests
approved_customers_only boolean If true, only approved customers may use quote requests
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
payments_configuration PaymentsConfiguration
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

PaymentsConfigurationRestrictions

Attributes
Name Data Type Description
descriptions array of string
maximum_subtotal number Maximum subtotal
minimum_subtotal number Minimum subtotal
payment_method string Payment method
restriction_alaska_hawaii string Alaska and Hawaii restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_apo_fpo string APO/FPO restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_canada string Canada restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_continental_us string Continental US restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_domestic_only string Domestic only restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_international_only string International only restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_po_box string PO Box restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_puerto_rico string Puerto Rico restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
restriction_us_territories string US Territories restriction
Allowed Values
  • invalid
  • invalidOnly
  • valid
themes array of PaymentsConfigurationRestrictionsTheme

PaymentsConfigurationRestrictionsTheme

Attributes
Name Data Type Description
code string
restriction string
storeFrontHostName string

PaymentsConfigurationSezzle

Attributes
Name Data Type Description
accept_sezzle boolean Master flag for this merchant accepting Sezzle payments
accounting_code string Optional Quickbooks code for this payment method
business_id string Business ID
deposit_to_account string Optional Quickbooks Deposit to Account value
environment string Sezzle environment
Allowed Values
  • Live
  • Sandbox
private_api_key string Private API key
public_api_key string Public API key
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method

PaymentsConfigurationTestMethod

Attributes
Name Data Type Description
bank_account_number string Bank account number
bank_routing_number string Bank routing number
credit_card_number string Credit card number
credit_card_number_existing string The existing credit card number
description string Description
payment_action string Payment action
Allowed Values
  • skip payment
  • skip pmt rej
  • skip pmt co
  • hold in ar
payment_method string Payment method
payment_method_test_oid (read only) integer (int32) Payment method test oid
skip_affiliate_transaction boolean Skip affiliate transaction
skip_conversion_pixels boolean If true, skips recording any conversion pixels to avoid sending test orders to your analysis sites
skip_fraud_filter boolean Skip fraud filter

PaymentsConfigurationWePay

Attributes
Name Data Type Description
accept_wepay boolean Master flag indicating this merchant accepts UltraCart Payments WePay
account_update_uri (read only) string URI for updating the WePay account
address1 string Address line 1
address2 string Address line 2
canada_accept_debit_cards boolean For Canadian merchants, true if they wish to accept debit cards
city string City
company string Company
company_description string Company description
console_hostname string Console hostname
country string Country
credit_card_rate string WePay credit card rate
currency string Base currency for transactions
expected_revenue string Expected Revenue
hide_credit_card_non_ultracart_payments (read only) boolean Internal flag to aid UI
hide_surcharge_amount (read only) boolean Internal flag to aid UI
industry string Industry
owner_email string Owner email
owner_name string Owner name
owner_phone string Owner phone
postal_code string Postal code
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
short_paypal_marketing_text (read only) boolean Internal UI aid
show_ultracart_payments_disabled (read only) boolean Internal flag to aid UI
show_ultracart_payments_intro (read only) boolean Internal flag to aid UI
show_ultracart_payments_verification (read only) boolean Internal flag to aid UI
show_ultracart_payments_verified (read only) boolean Internal flag to aid UI
state string State
website_url string Website URL

PaymentsConfigurationWireTransfer

Attributes
Name Data Type Description
accept_wire_transfer boolean Master flag indicating this merchant accepts wire transfers
account_number string account_number
accounting_code string Optional Quickbooks accounting code
bank_address string Bank address
deposit_to_account string Optional Quickbooks deposit to account
intermediate_routing_number string Intermediate routing number
restrictions PaymentsConfigurationRestrictions Restrictions for this payment method
routing_number string Routing number
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
surcharge_fee number surcharge_fee
surcharge_percentage number surcharge_percentage

PaymentsThemeTransactionType

Attributes
Name Data Type Description
code (read only) string External human readable identifier for a theme
credit_card_transaction_type string The credit card transaction type for this theme
Allowed Values
  • auth and capture
  • auth then capture
  • auth only
screen_branding_theme_oid (read only) integer (int32) Internal identifier for a theme

PaymentsWepayEnroll

Attributes
Name Data Type Description
address1 string
address2 string
canada_accept_debit_cards boolean
city string
company string
company_description string
country string
expected_revenue string
industry string
owner_email string
owner_name string
owner_phone string
state string
webiste_url string
zip string

ResponseMetadata

Attributes
Name Data Type Description
payload_name string Payload name
result_set ResultSet Result set

ResultSet

Attributes
Name Data Type Description
count integer (int32) Number of results in this set
limit integer (int32) Maximum number of results that can be returned in a set
more boolean True if there are more results to query
next_offset integer (int32) The next offset that you should query to retrieve more results
offset integer (int32) Offset of this result set (zero based)
total_records integer (int32) The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.

RotatingTransactionGateway

Attributes
Name Data Type Description
additional_native_currency_codes array of RtgCurrency An array of all currencies known to the UltraCart system and a boolean indicating whether this gateway supports that currency.
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
auto_order_cancel_unless_response_values array of 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.
base_currency_code string The base currency code for your gateway. For example, USD.
cascade_code string Optional field specifying a different rotating gateway to use if this gateway fails to process the transaction.
cascade_codes array of string A list of other rotating transaction gateways that can be used as a lookup to assign actions based on failures of this gateway
cascade_daily_auto_order_code string The code for the next rotating gateway that should be used when this gateway reaches a daily limit
charge_appears_on_statement_as string Optional field providing an alternate Charge Appears As value for this rotating gateway
code string A human friendly short code used to recognize and differentiate this rotating gateway with other rotating gateways
current_daily number The current daily dollar amount this gateway has processed. Providing this will allow UltraCart to track the monthly amount going forward.
current_daily_auto_order number 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.
current_monthly number The current monthly dollar amount this gateway has processed. Providing this will allow UltraCart to track the monthly amount going forward.
customer_service_email string The customer service email address for this gateway
customer_service_phone string The customer service phone number for this gateway
day_of_month_restrictions array of RtgDayOfMonthRestriction Array containing all 31 (possible) days and any optional restrictions for one or more days.
day_of_week_restrictions array of RtgDayOfWeekRestriction Array containing all seven days of the week and any optional restrictions for one or more days
deactivate_after_failures integer (int32) If non-zero, this gateway will be deactivated after reaching this amount of consecutive failures.
end_date string (dateTime) Optional field to specify an absolute date when this gateway should stop accepting transactions
gateways array of TransactionGateway 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.
maximum_daily number The maximum daily dollar amount this gateway may process
maximum_daily_auto_order number The maximum daily dollar amount of auto orders (recurring) this gateway may process
maximum_monthly number The maximum monthly dollar amount this gateway may process.
next_daily_auto_order_reset string (dateTime) The date and time when this gateway daily limit for auto orders will reset
next_daily_reset string (dateTime) The date and time when this gateway daily limit will reset
next_monthly_reset string (dateTime) The date and time when this gateway monthly limit will reset
order_total number This optional field is combined with order_total_comparison to determine if an order should be processed thorugh this gateway.
order_total_comparison string The math operator used to determine if the order total is allowed to process through this gateway.
Allowed Values
  • <
  • <=
  • =
  • >
  • >=
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.
reserve_days integer (int32) The number of days that your gateway holds any reserves. This aids in profitability reporting.
reserve_percentage number The percentage of an order which your gateway is holding in reserve. This aids in profitability reporting.
reserve_refunded boolean If true, reserves are refunded when an order is refunded. This aids in profitability reporting.
reserves_released_through string (dateTime) An optional date specifying the date up to which your gateway has released all reserve funds. This aids in profitability reporting.
rotating_transaction_gateway_oid (read only) integer (int32) Internal identifier used to store and retrieve this gateway information
selected_gateway_name string The name of the currently selected transaction gateway used by this rotating gateway
show_cascade_codes boolean A boolean used by the builtin UltraCart UI to determine if cascading rtg codes should be shown
show_merchant_account_profiles boolean A flag to help the UltraCart UI to know whether to show merchant account profiles or not.
start_date string (dateTime) Optional field to specify an absolute date when this gateway should begin accepting transactions
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.
Allowed Values
  • active
  • inactive
  • standby
theme_restrictions array of RtgThemeRestriction Optional restrictions by theme/storefront
traffic_percentage number Required field between 0 and 1 that dictates the percentage of traffic that should flow through this gateway
trial_daily_amount integer (int32) If specified, limits the total daily count of trial orders
trial_daily_limit integer (int32) If specified, limits the total daily dollar amount of trial orders
trial_monthly_amount integer (int32) If specified, limits the total month dollar amount of trial orders
trial_monthly_limit integer (int32) If specified, limits the total month count of trial orders

RotatingTransactionGatewayResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
rotating_gateway RotatingTransactionGateway
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

RotatingTransactionGatewaysResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
rotating_gateways array of RotatingTransactionGateway
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

RtgCurrency

Attributes
Name Data Type Description
currency_code (read only) string Standard three letter currency code, for example USD
description (read only) string Human friendly description of currency
selected boolean true if this rotating gateway supports this currency

RtgDayOfMonthRestriction

Attributes
Name Data Type Description
day_of_month integer (int32) The day of the month. 1 equals the first day of the month, 31 is the last possible value.
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.

RtgDayOfWeekRestriction

Attributes
Name Data Type Description
abbreviation (read only) string Human readable day of week abbreviation
day_of_week (read only) integer (int32) 1=Sun,2=Mon,3=Tue,4=Wed,5=Thu,6=Fri,7=Sat
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.

RtgSummaryGateway

Attributes
Name Data Type Description
cascade_code string
code string
delay_auto_orders string
name string
reserve_percentage number
reserves_released_through string (dateTime) An optional date specifying the date up to which your gateway has released all reserve funds. This aids in profitability reporting.
rotating_transaction_gateway_oid integer (int32)
show_ultracart_payments_verification boolean
show_ultracart_payments_verified boolean
status string
supports_auth string
supports_refund string
third_party string
traffic_percentage number
warning string
wepay_account_update_uri string
wepay_console_hostname string

RtgSummaryResponse

Attributes
Name Data Type Description
gateways array of RtgSummaryGateway
info_message string
migration_rtg_code string
migration_single_gateway_name string
show_delay_auto_orders boolean
show_migration boolean
warning string

RtgThemeRestriction

Attributes
Name Data Type Description
restriction string Any restriction for this theme
Allowed Values
  • invalid
  • valid
  • validOnly
storefront_host_name (read only) string The server name for this theme. This will not be populated for legacy (ancient) themes
theme_code (read only) string Human friendly short code for this theme

StripeConnectResponse

Attributes
Name Data Type Description
connect_url string
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

TransactionGateway

Attributes
Name Data Type Description
arbitrary_html (read only) string Additional html to display for this transaction gateway. This html will include instructions and connection links
comment (read only) string Additional comments
credit_card_capable (read only) boolean True if this gateway supports credit cards
echeck_capable (read only) boolean True if this gateway supports eChecks
echeck_supported (read only) string True if this gateway supports eChecks
enabled boolean True if this transaction gateway is the currently active gateway.
gateway_cert_pem string Cryptographic public certificate allowing UltraCart to communicate securely with this gateway.
gateway_cert_pem_label (read only) string The label for the gateway certificate pem. The actual value stored may vary by gateway, so the label will vary too.
gateway_email string Gateway Email
gateway_email_label (read only) string The label for the gateway email. The actual value stored may vary by gateway, so the label will vary too.
gateway_environment string Gateway Environment to indicate sandbox versus production environments
gateway_environment_label (read only) string The label for the gateway environment. The actual value stored may vary by gateway, so the label will vary too.
gateway_environments (read only) array of string Used to populate drop down lists for the gateway environment. Varies by gateway.
gateway_header_back_color string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_header_border_color string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_header_image_url string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_key string Gateway Key
gateway_key_label (read only) string The label for the gateway key. The actual value stored may vary by gateway, so the label will vary too.
gateway_key_pem string Cryptographic private key allowing UltraCart to communicate securely with this gateway.
gateway_key_pem_label (read only) string The label for the gateway key pem. The actual value stored may vary by gateway, so the label will vary too.
gateway_landing_page string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_merchant_id string Gateway Merchant ID
gateway_merchant_id_label (read only) string The label for the gateway merchant id. The actual value stored may vary by gateway, so the label will vary too.
gateway_mode string Gateway Mode
gateway_mode_label (read only) string The label for the gateway mode. The actual value stored may vary by gateway, so the label will vary too.
gateway_modes (read only) array of string Used to populate drop down lists for gateway modes
gateway_page_style string Gateway Page Style
gateway_page_style_label string Gateway page style label
gateway_page_styles (read only) array of string Used to populate drop down lists for gateway page style
gateway_partner string Gateway Partner
gateway_partner_label (read only) string The label for the gateway partner. The actual value stored may vary by gateway, so the label will vary too.
gateway_password string Gateway Password
gateway_password_label (read only) string The label for the gateway password. The actual value stored may vary by gateway, so the label will vary too.
gateway_payflow_color string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_private_key_password string Gateway private key password
gateway_private_key_password_label (read only) string The label for the gateway private key password. The actual value stored may vary by gateway, so the label will vary too.
gateway_solution_type string Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS
gateway_solution_type_label (read only) string The label for the gateway solution type. The actual value stored may vary by gateway, so the label will vary too.
gateway_solution_types (read only) array of string Used to populate drop down lists for gateway solution types
gateway_url string Gateway URL
gateway_url_label (read only) string The label for the gateway url. The actual value stored may vary by gateway, so the label will vary too.
gateway_username string Gateway Username
gateway_username_label (read only) string The label for the gateway username. The actual value stored may vary by gateway, so the label will vary too.
merchant_account_profile_amex string If a merchant has multiple card processing accounts, this is the one to use for American Express cards.
merchant_account_profile_diners_club string If a merchant has multiple card processing accounts, this is the one to use for Diners Club cards.
merchant_account_profile_discover string If a merchant has multiple card processing accounts, this is the one to use for Discover cards.
merchant_account_profile_jcb string If a merchant has multiple card processing accounts, this is the one to use for JCB cards.
merchant_account_profile_mastercard string If a merchant has multiple card processing accounts, this is the one to use for MasterCard cards.
merchant_account_profile_visa string If a merchant has multiple card processing accounts, this is the one to use for VISA cards.
merchant_id string UltraCart Merchant ID
multi_currency_details boolean True if this gateway provides details for multiple currency transactions
name string Name of this transaction gateway
refund_supported (read only) boolean True if this gateway supports refunds
require_echeck_tax_id_or_drivers_license boolean If true, e-Check transaction will require either a Tax ID or a Driver License
support_vbv_3ds boolean True if this gateway supported Verified-by-VISA 3D Secure
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.
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.
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.
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.
supports_electronic_gift_card boolean if true, this gateway will attempt to process electronic gift cards.
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.
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.
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.
third_party (read only) boolean True if this gateway supports third parties

TransactionGatewaysRequest

Attributes
Name Data Type Description
default_credit_card_transaction_type string The default transaction type for this merchant account
Allowed Values
  • auth and capture
  • auth then capture
  • auth only
gateways array of TransactionGateway
theme_credit_card_transaction_types array of PaymentsThemeTransactionType A list of the storefronts and themes for this merchant account and what type of transaction should be attempted

TransactionGatewaysResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
gateways array of TransactionGateway
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

Warning

Attributes
Name Data Type Description
more_info string Additional information often a link to additional documentation
warning_message string A technical message meant to be read by a developer

400
Status Code 400: bad request input such as invalid json

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

410
Status Code 410: Your authorized application has been disabled by UltraCart

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

429
Status Code 429: you have exceeded the allowed API call rate limit for your application.

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

500
Status Code 500: any server side error. the body will contain a generic server error message

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse