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
Languages
Servers
Mock server

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

Sandbox UpGate API

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

Changelog

[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

Domains

environmentdomain
Sandboxapi.sandbox.upgate.com
Prodapi.upgate.com

Postback IP addresses

productionsandbox
18.195.228.8835.159.56.107
3.68.255.12618.153.214.226
3.127.95.24018.194.246.210
18.198.146.23152.28.150.254

Constants

Transaction status

statusdescription
SUCCESSTransaction completed success
DECLINETransaction declined by some reason
ERRORSome error were produced during the process

Transaction type

status
SALE
AUTHORIZE
THREE_DS
TOKEN
PAYOUT
REFUND
VOID
FRAUD_ALERT
CHARGEBACK
CHARGEBACK_REVERSAL
RDR
RDR_REVERSAL

Response Codes

codemessage
1000Success
1200Pending
13003DS verification successful (challenged)
13013DS verification successful (frictionless)
13023DS verification attempted
13203DS verification denied
13213DS could not be performed
13223DS rejected by issuer
13233DS invalid cardholder account number
13243DS version not supported
13253DS timeout
13903DS integration error
14003DS is required
2000Decline
2001Refer to card issuer
2002Do not honor
2003Bank decline
2004Insufficient funds
2005Card not supported
2006Restricted card
2007Over limit
2008Merchant limit exceeded
2009Invalid transaction
2010Duplicate transaction
2011transaction has already chargeback
2012Crypto transaction decline
2013Crypto insufficient funds
2014Crypto smart contract insufficient funds
2015Crypto transaction replaced
2016Crypto address is invalid
2101Invalid CVV or expiry date
2102CVV missing
2103Invalid expiry date
21303DS verification denied
21313DS could not be performed
21323DS rejected by issuer
21333DS timeout
21383DS SCA required
21393DS integration error
2140Low value rejected
2141Incorrect card data
2142Incorrect data
2143Missing parameters
21443DS version not supported
2200Pick up card
2201Pick up card (stolen or fraud)
2202Expired card
2203Unsupported card type
2204No such issuer
2205Decline by Card Scheme Advise Code
2299Closed account
2300Processor risk
2301Velocity limit exceeded
2302Suspected Fraud
2309Customer blacklisted
2310Card blacklisted
2311IP blacklist
2312Email blacklist
2313BIN blacklist
2314Country blacklist
2315Fraud rule
2900System malfunction
2901Integration error
2902Processor not supported feature
2903Processor malfunction
2904Timeout
2905Refund is not supported for this method or transaction type
2906Missing payment token
2907Payment type not supported for payment method
2908Payment token is not valid
3000Unknown error

Demo payment page

Example

Operations

Examples

Operations

Google Pay™

Override theme

Other request examples

Operations

Embedded flow