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
openapi.json
openapi.yaml
Overview
URL

https://upgate.com

E-mail

sales@upgate.com

Terms of Service

Languages
Servers
Mock server

https://docs.upgate.com/_mock/openapi/

Sandbox UpGate API

https://api.sandbox.upgate.com/v1/

Changelog

[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

[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

[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

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

Introduction

Demo payment page

Checkout Overview

Example

Operations

Examples

Operations

Google Pay™

Override theme

Variables

The theme_variables property is used to override default CSS variables of the payment form. This allows you to quickly and easily customize specific aspects of the design. The variables option functions similarly to CSS variables. You can assign CSS values to each variable and reference them using the var(--myVariable) syntax. Additionally, you can use your browser’s DOM explorer to inspect the applied styles in the resulting DOM.

Commonly used variables

VariableDescription
primaryColorDefines the primary color used across the application.
backgroundColorBackground color of the component.
formBackgroundBackground color of the form.
fontSizeBaseBase font size.
fontFamilyFont family used across the application.
loaderColorColor for loader.

Rest Variables

VariableDescription
maxWidthMaximum width of the container or component.
primaryColorHoverPrimary color when hovered.
primaryColorActivePrimary color when active.
payBtnColorColor of the payment button.
payBtnColorDisabledColor of the payment button when disabled.
payBtnFontSizeFont size for the payment button.
payBtnLineHeightLine height for the payment button.
payBtnPaddingPadding for the payment button.
textColorDefault color for text.
formBorderColorBorder color for forms.
formPaddingPadding inside forms.
formBorderRadiusBorder radius for forms.
m_formPaddingMobile-specific padding for forms.
inputBackgroundBackground color for input fields.
inputBorderColorBorder color for input fields.
inputBorderColorHoverBorder color for input fields when hovered.
inputBorderColorFocusBorder color for input fields when focused.
inputBorderColorErrorBorder color for input fields in error state.
inputBorderWidthBorder width for input fields.
inputBorderWidthHoverBorder width for input fields when hovered.
inputBorderWidthFocusBorder width for input fields when focused.
inputBorderWidthErrorBorder width for input fields in error state.
borderRadiusBorder radius applied across components.
inputPaddingPadding for input fields.
inputFontSizeFont size for input fields.
inputLineHeightLine height for input fields.
inputFontWeightFont weight for input fields.
placeHolderColorColor for placeholder text in input fields.
cardBackgroundBackground color for cards.
cardBorderColorBorder color for cards.
cardBorderRadiusBorder radius for cards.
cardPaddingPadding for cards.
cardSelectColorSelectedColor of selected card during selection.
inputIconColorColor of icons inside input fields.
descriptionColorColor for descriptive text.
dividerColorColor of dividers or separators.
fontSizeXlFont size for extra-large text.
fontSizeLgFont size for large text.
fontSizeSmFont size for small text.
fontSizeXsFont size for extra-small text.
fontSize2XsFont size for ultra-small text.
lineHeightLine height for text.
fontCssCustom CSS applied to fonts.
lineHeightXlLine height for extra-large text.
lineHeightLgLine height for large text.
fontWeightGeneral font weight for text.
buttonPaddingPadding for buttons.
buttonFontWeightFont weight for button text.
buttonBackgroundBackground color for buttons.
buttonFontSizeFont size for buttons.
buttonLineHeightLine height for button text.
buttonColorText color for buttons.
buttonBackgroundHoverBackground color for buttons when hovered.
buttonColorHoverText color for buttons when hovered.
buttonBackgroundActiveBackground color for buttons when active.
buttonColorActiveText color for buttons when active.
linkColorColor for hyperlinks.
fontWeightLightFont weight for lighter text styles.
fontWeightMediumFont weight for medium text styles.
fontWeightBoldFont weight for bold text styles.
labelFontSizeFont size for labels.
labelLineHeightLine height for labels.
labelFontWeightFont weight for labels.
labelColorColor for labels.
errorColorColor for error messages or indicators.
selectBackgroundHoverBackground color for select elements when hovered.
selectBackgroundActiveBackground color for select elements when active.
cardSelectDeleteColorColor for delete option in card selection.
transitionDurationDuration for transition effects.
transitionStyleStyle for transition effects.
buttonOutlineColorOutline color for buttons.
buttonOutlineBorderColorBorder color for button outlines.
buttonOutlineBorderWidthBorder width for button outlines.
buttonOutlineBackgroundHoverBackground color for outlined buttons when hovered.
buttonOutlineBackgroundActiveBackground color for outlined buttons when active.
tabBorderRadiusBorder radius for tabs.
tabPaddingPadding for tabs.
tabHeightHeight for tabs.
tabColorText color for tabs.
tabBackgroundBackground color for tabs.
tabBorderColorBorder color for tabs.
tabBorderColorActiveBorder color for tabs when active.
tabBackgroundActiveBackground color for tabs when active.
tabColorSelectedText color for selected tabs.
tabBackgroundSelectedBackground color for selected tabs.
tabBorderColorSelectedBorder color for selected tabs.
tabBorderColorHoverBorder color for tabs when hovered.
tabBackgroundHoverBackground color for tabs when hovered.
tabBorderWidthBorder width for tabs.
tabBorderWidthHoverBorder width for tabs when hovered.
tabBorderWidthActiveBorder width for tabs when active.
tabBorderWidthSelectedBorder width for selected tabs.
tabFontWeightFont weight for tabs.
tabFontWeightSelectedFont weight for selected tabs.
languageSelectColorColor for language selection dropdown.
subscriptionColorColor used for subscription-related text or buttons.
subscriptionFontSizeFont size for subscription-related text.
subscriptionLineHeightLine height for subscription-related text.
subscriptionFontWeightFont weight for subscription-related text.
buttonColorDisabledText color for disabled buttons.
buttonBackgroundDisabledBackground color for disabled buttons.
footerColorColor of text in the footer.
footerIconColorColor of icons in the footer.
footerFontWeightFont weight for text in the footer.
footerFontSizeFont size for text in the footer.
footerLineHeightLine height for text in the footer.
footerPaddingPadding for the footer.
m_footerPaddingMobile-specific padding for the footer.
badgeFontSizeFont size for badges.
badgeBackgroundBackground color for badges.
badgeColorText color for badges.
methodIconWidthWidth for payment method icons.
methodIconHeightHeight for payment method icons.
iconSizeGeneral size for icons.
searchInputBackgroundBackground color for search inputs.
searchInputBackgroundHoverBackground color for search inputs when hovered.
messageInfoColorText color for informational messages.
messageInfoBorderColorBorder color for informational messages.
messageInfoBackgroundBackground color for informational messages.
messageErrorColorText color for error messages.
messageErrorBorderColorBorder color for error messages.
messageErrorBackgroundBackground color for error messages.
currencySelectBackgroundBackground color for the currency select.
currencySelectBorderColorBorder color for the currency select.
currencySelectIndicatorBackgroundBackground color for the indicator in the currency select.
currencySelectIndicatorBorderRadiusBorder radius for the indicator in the currency select.

Other request examples

Operations

Embedded flow