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
taxOverride
object 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
paymentFormOverride
object 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
production | sandbox |
---|---|
18.195.228.88 | 35.159.56.107 |
3.68.255.126 | 18.153.214.226 |
3.127.95.240 | 18.194.246.210 |
18.198.146.231 | 52.28.150.254 |
status | description |
---|---|
SUCCESS | Transaction completed success |
PENDING | Transaction is awaiting final status from the processor |
DECLINE | Transaction declined by some reason |
ERROR | Some error were produced during the process |
status |
---|
SALE |
AUTHORIZE |
THREE_DS |
TOKEN |
PAYOUT |
REFUND |
VOID |
FRAUD_ALERT |
CHARGEBACK |
CHARGEBACK_REVERSAL |
RDR |
RDR_REVERSAL |
code | message |
---|---|
1000 | Success |
1200 | Pending |
1300 | 3DS verification successful (challenged) |
1301 | 3DS verification successful (frictionless) |
1302 | 3DS verification attempted |
1320 | 3DS verification denied |
1321 | 3DS could not be performed |
1322 | 3DS rejected by issuer |
1323 | 3DS invalid cardholder account number |
1324 | 3DS version not supported |
1325 | 3DS timeout |
1390 | 3DS integration error |
1400 | 3DS is required |
2000 | Decline |
2001 | Refer to card issuer |
2002 | Do not honor |
2003 | Bank decline |
2004 | Insufficient funds |
2005 | Card not supported |
2006 | Restricted card |
2007 | Over limit |
2008 | Merchant limit exceeded |
2009 | Invalid transaction |
2010 | Duplicate transaction |
2011 | transaction has already chargeback |
2012 | Crypto transaction decline |
2013 | Crypto insufficient funds |
2014 | Crypto smart contract insufficient funds |
2015 | Crypto transaction replaced |
2016 | Crypto address is invalid |
2101 | Invalid CVV or expiry date |
2102 | CVV missing |
2103 | Invalid expiry date |
2120 | Invalid amount |
2130 | 3DS denied for risk reasons |
2131 | 3DS could not be performed |
2132 | 3DS authentication failed |
2133 | 3DS timeout |
2134 | 3DS stolen card |
2135 | 3DS expired card |
2136 | 3DS invalid cardholder account number |
2137 | Invalid or unsupported 3DS transaction |
2138 | 3DS SCA required |
2139 | 3DS integration error |
2140 | Low value rejected |
2141 | Incorrect card data |
2142 | Incorrect data |
2143 | Missing parameters |
2144 | 3DS version not supported |
2145 | Card or BIN not enrolled in 3DS |
2146 | 3DS ACS has reached max challenge limit |
2200 | Pick up card |
2201 | Pick up card (stolen or fraud) |
2202 | Expired card |
2203 | Unsupported card type |
2204 | No such issuer |
2205 | Decline by Card Scheme Advise Code |
2299 | Closed account |
2300 | Processor risk |
2301 | Velocity limit exceeded |
2302 | Suspected Fraud |
2309 | Customer blacklisted |
2310 | Card blacklisted |
2311 | IP blacklist |
2312 | Email blacklist |
2313 | BIN blacklist |
2314 | Country blacklist |
2315 | Fraud rule |
2900 | System malfunction |
2901 | Integration error |
2902 | Processor not supported feature |
2903 | Processor malfunction |
2904 | Timeout |
2905 | Refund is not supported for this method or transaction type |
2906 | Missing payment token |
2907 | Payment type not supported for payment method |
2908 | Payment token is not valid |
3000 | Unknown error |