UpGate API documentation (1.2)
UpGate is a world-class payment orchestration platform. Our mission is to simplify payments and make it easier for merchants to reach global customers. We use the latest technologies to help you achieve better conversions and global user monetization.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.upgate.com/_mock/openapi/
Sandbox UpGate API
https://api.sandbox.upgate.com/v1/
Changelog
[1.1.42] - 2025-07-09
Changed
- New payment methods added
[1.1.41] - 2025-07-03
Added
- Field card_bin_country_name has been added to data in transaction postbacks
- Field card_bin_country_code has been added to data in transaction postbacks
- Field card_bin_type has been added to data in transaction postbacks
[1.1.40] - 2025-07-02
Added
- New endpoint cit-sale
[1.1.39] - 2025-07-01
Changed
- New payment methods added
- FAQ updated
[1.1.38] - 2025-06-20
Added
- New response code '2120 Invalid amount'
[1.1.37] - 2025-05-29
Added
- Add new response code group 'PENDING'
Changed
- Response code 1200 moved to group 'PENDING'
[1.1.36] - 2025-05-26
Added
- New fields transaction_fee_amount, transaction_tax_amount, transaction_tax_type, transaction_tax_label, transaction_tax_percentage to postback payment
- New fields rebill_transaction_fee_amount, rebill_transaction_fee_currency_code, rebill_transaction_tax_amount, rebill_transaction_tax_currency_code to postback products
- New fields transaction_fee_amount, transaction_fee_currency_code, transaction_tax_amount, transaction_tax_currency_code, transaction_tax_type, transaction_tax_label, transaction_tax_percentage to postback subscription
- New fields transaction_fee_amount, transaction_tax_amount, transaction_tax_type, transaction_tax_label, transaction_tax_percentage to response payment
- New fields rebill_transaction_fee_amount, rebill_transaction_fee_currency_code, rebill_transaction_tax_amount, rebill_transaction_tax_currency_code to response products
- New fields transaction_fee_amount, transaction_fee_currency_code, transaction_tax_amount, transaction_tax_currency_code, transaction_tax_type, transaction_tax_label, transaction_tax_percentage to response subscription
[1.1.35] - 2025-05-23
Added
- New response code '2016 Crypto address is invalid'
[1.1.34] - 2025-05-19
Added
taxOverrideobject was added to Checkout request
[1.1.33] - 2025-04-25
Added
- New response code '2908 Payment token is not valid'
[1.1.32] - 2025-04-14
Added
- New payment methods added
[1.1.31] - 2025-04-03
Added
- New fields rebill_transaction_amount, rebill_transaction_currency_code to transaction product postback & response
[1.1.30] - 2025-04-07
Added
- New payment methods added
[1.1.29] - 2025-03-05
Added
- New field customer_selected_country_code to postback payment details
[1.1.28] - 2025-02-24
Added
- New transaction types: RDR and RDR_REVERSAL
[1.1.27] - 2025-02-17
Added
- New fields customer_phone_number, customer_email, customer_first_name, customer_last_name, payment_token_type to postback payment details
- New fields processor_response_text, cascade_attempt, has_been_cascaded to postback transaction details
[1.1.26] - 2025-01-28
Added
- New response code '2907 Payment type not supported for payment method'
[1.1.25] - 2025-01-27
Changed
- Updated the page structure
[1.1.24] - 2025-01-15
Added
paymentFormOverrideobject was added to Checkout request- Override theme chapter
[1.1.23] - 2024-12-15
Added
- New response code '2309 Customer blacklisted'
[1.1.22] - 2024-11-26
Added
- Field version has been added to data in transaction postbacks
- Field version has been added to data in subscription postbacks
[1.1.21] - 2024-10-16
Removed
- Payment detail card_token_id has been removed from data.transactions.payment_details in postbacks
- Payment detail card_token_id has been removed from data.transactions.payment_details in response to synchronous mit-sale and mit-authorize
[1.1.20] - 2024-10-03
Changed
- Field payment_token_id as a required for MIT Sale Request and MIT Authorize Request
- Field methods as an optional field for Checkout Request
- Field shop_name max length from 64 to 128 characters in Checkout Request
- Field merchant_product_id max length from 64 to 128 characters in Checkout Request
Updated
[1.1.19] - 2024-09-17
Changed
- Changed max length for field success_url from 2048 to 512
- Changed max length for field failure_url from 2048 o 512
[1.1.18] - 2024-07-23
Added
- Added request subscription by transaction ID
[1.1.17] - 2024-04-12
Added
- Added Subscription state request by subscription id
[1.1.16] - 2024-04-10
Added
- For callback added fields transaction_amount, transaction_currency_code and product_transaction_price
[1.1.15] - 2024-04-04
Changed
- Update response codes
[1.1.14] - 2024-02-20
Added
- Added Direct payment flow section
- Added Checkout flow section
- Added Checkout request examples
- Added description of Embedded flow for Checkout
- Added new APM payment methods
[1.1.13] - 2023-12-12
Added
- Added fields shop_name and shop_url
- For subscription added fields retry_at, retry_count and created_at
- Added new APM payment methods
Changed
- Update response codes
[1.1.12] - 2023-09-05
Added
- Create token endpoint
Changed
- Update response codes
[1.1.11] - 2023-03-05
Changed
- For subscription renamed field customer_id to merchant_customer_id
- For subscription renamed field is_enabled to is_rebill_enabled
- Changed max length for field success_url from 64 to 2048
- Changed max length for field failure_url from 64 to 2048
- Changed max length for field email from 64 to 320
- Changed that the amount for Authorize can be 0
Removed
- Required header X-Merchant-ID from all requests
| Variable | Description |
|---|---|
| primaryColor | Defines the primary color used across the application. |
| backgroundColor | Background color of the component. |
| formBackground | Background color of the form. |
| fontSizeBase | Base font size. |
| fontFamily | Font family used across the application. |
| loaderColor | Color for loader. |
| Variable | Description |
|---|---|
| maxWidth | Maximum width of the container or component. |
| primaryColorHover | Primary color when hovered. |
| primaryColorActive | Primary color when active. |
| payBtnColor | Color of the payment button. |
| payBtnColorDisabled | Color of the payment button when disabled. |
| payBtnFontSize | Font size for the payment button. |
| payBtnLineHeight | Line height for the payment button. |
| payBtnPadding | Padding for the payment button. |
| textColor | Default color for text. |
| formBorderColor | Border color for forms. |
| formPadding | Padding inside forms. |
| formBorderRadius | Border radius for forms. |
| m_formPadding | Mobile-specific padding for forms. |
| inputBackground | Background color for input fields. |
| inputBorderColor | Border color for input fields. |
| inputBorderColorHover | Border color for input fields when hovered. |
| inputBorderColorFocus | Border color for input fields when focused. |
| inputBorderColorError | Border color for input fields in error state. |
| inputBorderWidth | Border width for input fields. |
| inputBorderWidthHover | Border width for input fields when hovered. |
| inputBorderWidthFocus | Border width for input fields when focused. |
| inputBorderWidthError | Border width for input fields in error state. |
| borderRadius | Border radius applied across components. |
| inputPadding | Padding for input fields. |
| inputFontSize | Font size for input fields. |
| inputLineHeight | Line height for input fields. |
| inputFontWeight | Font weight for input fields. |
| placeHolderColor | Color for placeholder text in input fields. |
| cardBackground | Background color for cards. |
| cardBorderColor | Border color for cards. |
| cardBorderRadius | Border radius for cards. |
| cardPadding | Padding for cards. |
| cardSelectColorSelected | Color of selected card during selection. |
| inputIconColor | Color of icons inside input fields. |
| descriptionColor | Color for descriptive text. |
| dividerColor | Color of dividers or separators. |
| fontSizeXl | Font size for extra-large text. |
| fontSizeLg | Font size for large text. |
| fontSizeSm | Font size for small text. |
| fontSizeXs | Font size for extra-small text. |
| fontSize2Xs | Font size for ultra-small text. |
| lineHeight | Line height for text. |
| fontCss | Custom CSS applied to fonts. |
| lineHeightXl | Line height for extra-large text. |
| lineHeightLg | Line height for large text. |
| fontWeight | General font weight for text. |
| buttonPadding | Padding for buttons. |
| buttonFontWeight | Font weight for button text. |
| buttonBackground | Background color for buttons. |
| buttonFontSize | Font size for buttons. |
| buttonLineHeight | Line height for button text. |
| buttonColor | Text color for buttons. |
| buttonBackgroundHover | Background color for buttons when hovered. |
| buttonColorHover | Text color for buttons when hovered. |
| buttonBackgroundActive | Background color for buttons when active. |
| buttonColorActive | Text color for buttons when active. |
| linkColor | Color for hyperlinks. |
| fontWeightLight | Font weight for lighter text styles. |
| fontWeightMedium | Font weight for medium text styles. |
| fontWeightBold | Font weight for bold text styles. |
| labelFontSize | Font size for labels. |
| labelLineHeight | Line height for labels. |
| labelFontWeight | Font weight for labels. |
| labelColor | Color for labels. |
| errorColor | Color for error messages or indicators. |
| selectBackgroundHover | Background color for select elements when hovered. |
| selectBackgroundActive | Background color for select elements when active. |
| cardSelectDeleteColor | Color for delete option in card selection. |
| transitionDuration | Duration for transition effects. |
| transitionStyle | Style for transition effects. |
| buttonOutlineColor | Outline color for buttons. |
| buttonOutlineBorderColor | Border color for button outlines. |
| buttonOutlineBorderWidth | Border width for button outlines. |
| buttonOutlineBackgroundHover | Background color for outlined buttons when hovered. |
| buttonOutlineBackgroundActive | Background color for outlined buttons when active. |
| tabBorderRadius | Border radius for tabs. |
| tabPadding | Padding for tabs. |
| tabHeight | Height for tabs. |
| tabColor | Text color for tabs. |
| tabBackground | Background color for tabs. |
| tabBorderColor | Border color for tabs. |
| tabBorderColorActive | Border color for tabs when active. |
| tabBackgroundActive | Background color for tabs when active. |
| tabColorSelected | Text color for selected tabs. |
| tabBackgroundSelected | Background color for selected tabs. |
| tabBorderColorSelected | Border color for selected tabs. |
| tabBorderColorHover | Border color for tabs when hovered. |
| tabBackgroundHover | Background color for tabs when hovered. |
| tabBorderWidth | Border width for tabs. |
| tabBorderWidthHover | Border width for tabs when hovered. |
| tabBorderWidthActive | Border width for tabs when active. |
| tabBorderWidthSelected | Border width for selected tabs. |
| tabFontWeight | Font weight for tabs. |
| tabFontWeightSelected | Font weight for selected tabs. |
| languageSelectColor | Color for language selection dropdown. |
| subscriptionColor | Color used for subscription-related text or buttons. |
| subscriptionFontSize | Font size for subscription-related text. |
| subscriptionLineHeight | Line height for subscription-related text. |
| subscriptionFontWeight | Font weight for subscription-related text. |
| buttonColorDisabled | Text color for disabled buttons. |
| buttonBackgroundDisabled | Background color for disabled buttons. |
| footerColor | Color of text in the footer. |
| footerIconColor | Color of icons in the footer. |
| footerFontWeight | Font weight for text in the footer. |
| footerFontSize | Font size for text in the footer. |
| footerLineHeight | Line height for text in the footer. |
| footerPadding | Padding for the footer. |
| m_footerPadding | Mobile-specific padding for the footer. |
| badgeFontSize | Font size for badges. |
| badgeBackground | Background color for badges. |
| badgeColor | Text color for badges. |
| methodIconWidth | Width for payment method icons. |
| methodIconHeight | Height for payment method icons. |
| iconSize | General size for icons. |
| searchInputBackground | Background color for search inputs. |
| searchInputBackgroundHover | Background color for search inputs when hovered. |
| messageInfoColor | Text color for informational messages. |
| messageInfoBorderColor | Border color for informational messages. |
| messageInfoBackground | Background color for informational messages. |
| messageErrorColor | Text color for error messages. |
| messageErrorBorderColor | Border color for error messages. |
| messageErrorBackground | Background color for error messages. |
| currencySelectBackground | Background color for the currency select. |
| currencySelectBorderColor | Border color for the currency select. |
| currencySelectIndicatorBackground | Background color for the indicator in the currency select. |
| currencySelectIndicatorBorderRadius | Border radius for the indicator in the currency select. |
The theme_rules option is a mapping of CSS-like selectors to CSS properties, enabling precise customization of individual components. Once you’ve defined your theme and variables, you can use these rules to seamlessly align the payment form with your website’s design.
Selectors in a rule can target any public class names within the payment form, as well as supported states, pseudo-classes, and pseudo-elements associated with each class. For example, the following are valid selectors: .form-control > input