Download OpenAPI specification:Download
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 monetisation.
URL for callback's (postback's) should be set with the merchant account (during the registration) & can be updated in any time using admin panel
status | description |
---|---|
SUCCESS | Transaction completed success |
DECLINE | Transaction declined by some reason |
ERROR | Some error were produced during the process |
code | message |
---|---|
1000 | Success |
1200 | Pending |
1300 | DS verification successful (challenged) |
1301 | DS 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 |
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 |
2101 | Invalid CVV or expiry date |
2102 | CVV missing |
2103 | Invalid expiry date |
2130 | 3DS verification denied |
2131 | 3DS could not be performed |
2132 | 3DS rejected by issuer |
2138 | 3DS SCA required |
2139 | 3DS integration error |
2140 | Low value rejected |
2141 | Incorrect card data |
2200 | Pick up card |
2201 | Pick up card (stolen or fraud" |
2202 | Expired card |
2203 | Unsupported card type |
2204 | No such issuer |
2299 | Closed account |
2300 | Processor risk |
2301 | Velocity limit exceeded |
2302 | Suspected Fraud |
2310 | Card blacklisted |
2311 | IP blacklist |
2312 | Email blacklist |
2313 | BIN blacklist |
2314 | Country blacklist |
2900 | System malfunction |
2901 | Integration error |
2902 | Processor not supported feature |
2903 | Processor malfunction |
3000 | Unknown error |
OK
Request validation error
Authorization error
Internal server error
{- "payment_method": "CARD",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "forced_3d": true,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
{- "type": "PAYMENT",
- "data": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "SALE",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "amount": "9.99",
- "language": "en-us",
- "country_code": "US",
- "currency_code": "USD",
- "forced_3d": true,
- "session": {
- "created_at": "2022-04-15T10:54:03.633Z",
- "expires_at": "2022-04-15T11:09:03.633Z",
}, - "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
{- "type": "TRANSACTION",
- "data": {
- "transaction_id": "2E2CL7BTK23K3",
- "transaction_type": "SALE",
- "transaction_status": "SUCCESS",
- "created_at": "2022-05-13T12:24:37.094Z",
- "response_code": 1000,
- "response_text": "Success",
- "transaction_details": {
- "processor_merchant_account_id": "28148",
- "processor_transaction_id": "104335314",
- "processor": "PAYABL",
- "processor_response_code": "0"
}, - "payment_context": {
- "browser_user_agent": "PostmanRuntime/7.29.0",
- "browser_screen_height": "8",
- "browser_color_depth": "7",
- "browser_language": "6",
- "browser_timezone_offset": "10",
- "browser_screen_width": "9",
- "challenge_window_size": "04",
- "browser_has_js_enabled": "true",
- "browser_has_java_enabled": "true",
- "browser_accept_header": "*/*",
- "ip": "192.168.0.1"
}, - "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_scheme": "MASTERCARD",
- "card_token_id": "E9S+G7rAv/vTIodek4kbP65dw1uMzoWWQSxXpIAuhCY=",
- "card_bin": "523205",
- "card_last_four_digits": "0003",
- "customer_full_name": "John Doe",
- "card_expiry_month": "12",
- "card_expiry_year": "2024"
}, - "payment": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "SALE",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "amount": "9.99",
- "language": "en-us",
- "country_code": "US",
- "currency_code": "USD",
- "forced_3d": false,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
}
OK
Request validation error
Authorization error
Internal server error
{- "payment_method": "CARD",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "email": "john_doe@upgate.com",
- "country_code": "US",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
{- "type": "PAYMENT",
- "data": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "MIT_SALE",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "amount": "9.99",
- "country_code": "US",
- "currency_code": "USD",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
{- "type": "TRANSACTION",
- "data": {
- "transaction_id": "2E2CL7BTK23K3",
- "transaction_type": "SALE",
- "transaction_status": "SUCCESS",
- "created_at": "2022-05-13T12:24:37.094Z",
- "response_code": 1000,
- "response_text": "Success",
- "transaction_details": {
- "processor_merchant_account_id": "28148",
- "processor_transaction_id": "104335314",
- "processor": "PAYABL",
- "processor_response_code": "0"
}, - "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_scheme": "MASTERCARD",
- "card_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_bin": "523205",
- "card_last_four_digits": "0003",
- "customer_full_name": "John Doe",
- "card_expiry_month": "12",
- "card_expiry_year": "2024"
}, - "payment": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "MIT_SALE",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "amount": "9.99",
- "country_code": "US",
- "currency_code": "USD",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
}
OK
Request validation error
Authorization error
Internal server error
{- "payment_method": "CARD",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "forced_3d": false,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_type": "SUBSCRIPTION",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description",
- "charge_interval": "DAY",
- "charge_interval_value": 30,
- "is_trial": false
}
]
}
{- "type": "PAYMENT",
- "data": {
- "payment_id": "2JWYCAOYS67K2",
- "payment_type": "RECURRING",
- "payment_method": "CARD",
- "created_at": "2023-03-02T14:51:50.779Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "forced_3d": true,
- "session": {
- "created_at": "2023-03-02T14:51:50.779Z",
- "expires_at": "2023-03-02T15:06:50.779Z",
}, - "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SUBSCRIPTION",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description",
- "charge_interval": "DAY",
- "charge_interval_value": 30,
- "is_trial": false
}
]
}
}
{- "type": "TRANSACTION",
- "data": {
- "transaction_id": "2E2CL7BTK23K3",
- "transaction_type": "SALE",
- "transaction_status": "SUCCESS",
- "created_at": "2022-05-13T12:24:37.094Z",
- "response_code": 1000,
- "response_text": "Success",
- "transaction_details": {
- "processor_merchant_account_id": "28148",
- "processor_transaction_id": "104335314",
- "processor": "PAYABL",
- "processor_response_code": "0"
}, - "payment_context": {
- "browser_user_agent": "PostmanRuntime/7.29.0",
- "browser_screen_height": "8",
- "browser_color_depth": "7",
- "browser_language": "6",
- "browser_timezone_offset": "10",
- "browser_screen_width": "9",
- "challenge_window_size": "04",
- "browser_has_js_enabled": "true",
- "browser_has_java_enabled": "true",
- "browser_accept_header": "*/*",
- "ip": "192.168.0.1"
}, - "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_scheme": "MASTERCARD",
- "card_token_id": "E9S+G7rAv/vTIodek4kbP65dw1uMzoWWQSxXpIAuhCY=",
- "card_bin": "523205",
- "card_last_four_digits": "0003",
- "customer_full_name": "John Doe",
- "card_expiry_month": "12",
- "card_expiry_year": "2024"
}, - "payment": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "RECURRING",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "amount": "9.99",
- "language": "en-us",
- "country_code": "US",
- "currency_code": "USD",
- "forced_3d": true,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SUBSCRIPTION",
- "product_price": "9.99",
- "product_name": "Test product name",
- "product_description": "Test product description",
- "charge_interval": "DAY",
- "charge_interval_value": 30,
- "is_trial": false
}
], - "subscriptions": [
- {
- "subscription_id": "2JWZPMXYC2DK2",
- "subscription_status": "ACTIVE",
- "expires_at": "2023-03-06T16:30:59.321Z",
- "merchant_id": "UpGate",
- "payment_id": "2E2CL5R3KC7K3",
- "product_id": "2JZGULPNK27K2",
- "merchant_product_id": "R_001",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "payment_method": "CARD",
- "currency_code": "USD",
- "amount": "9.99",
- "is_trial": false,
- "is_rebill_enabled": true
}
]
}
}
}
OK
Request validation error
Authorization error
Internal server error
{- "is_rebill_enabled": true
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "subscription_status": "ACTIVE",
- "expires_at": "2023-03-13T16:11:50.694Z",
- "merchant_id": "UpGate",
- "payment_id": "2E2CL5R3KC7K3",
- "product_id": "2JZGULPNK27K2",
- "merchant_product_id": "R_001",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "777",
- "payment_method": "CARD",
- "currency_code": "USD",
- "amount": "10.01",
- "is_trial": false,
- "charge_interval": "DAY",
- "charge_interval_value": 11,
- "is_rebill_enabled": true
}
}
OK
Request validation error
Authorization error
Internal server error
{- "is_rebill_enabled": true
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "subscription_status": "ACTIVE",
- "expires_at": "2023-03-13T16:11:50.694Z",
- "merchant_id": "UpGate",
- "payment_id": "2E2CL5R3KC7K3",
- "product_id": "2JZGULPNK27K2",
- "merchant_product_id": "R_001",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "777",
- "payment_method": "CARD",
- "currency_code": "USD",
- "amount": "10.01",
- "is_trial": false,
- "charge_interval": "DAY",
- "charge_interval_value": 11,
- "is_rebill_enabled": true
}
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "subscription_status": "ACTIVE",
- "expires_at": "2023-03-13T16:11:50.694Z",
- "merchant_id": "UpGate",
- "payment_id": "2E2CL5R3KC7K3",
- "product_id": "2JZGULPNK27K2",
- "merchant_product_id": "R_001",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "777",
- "payment_method": "CARD",
- "currency_code": "USD",
- "amount": "10.01",
- "is_trial": false,
- "charge_interval": "DAY",
- "charge_interval_value": 11,
- "is_rebill_enabled": true
}
}
Request to create token
OK
Request validation error
Authorization error
Internal server error
{- "payment_method": "CARD",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "prefilled_card_holder": "John Doe",
}
{- "type": "PAYMENT",
- "data": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "TOKEN",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "prefilled_card_holder": "John Doe",
- "session": {
- "created_at": "2022-04-15T10:54:03.633Z",
- "expires_at": "2022-04-15T11:09:03.633Z",
}
}
}
{- "type": "TRANSACTION",
- "data": {
- "transaction_id": "2E2CL7BTK23K3",
- "transaction_type": "TOKEN",
- "transaction_status": "SUCCESS",
- "created_at": "2022-05-13T12:24:37.094Z",
- "response_code": 1000,
- "response_text": "Success",
- "payment_context": {
- "browser_user_agent": "PostmanRuntime/7.29.0",
- "browser_screen_height": "8",
- "browser_color_depth": "7",
- "browser_language": "6",
- "browser_timezone_offset": "10",
- "browser_screen_width": "9",
- "challenge_window_size": "04",
- "browser_has_js_enabled": "true",
- "browser_has_java_enabled": "true",
- "browser_accept_header": "*/*",
- "ip": "192.168.0.1"
}, - "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_scheme": "MASTERCARD",
- "card_token_id": "E9S+G7rAv/vTIodek4kbP65dw1uMzoWWQSxXpIAuhCY=",
- "card_bin": "523205",
- "card_last_four_digits": "0003",
- "customer_full_name": "John Doe",
- "card_expiry_month": "12",
- "card_expiry_year": "2024"
}, - "payment": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "TOKEN",
- "payment_method": "CARD",
- "created_at": "2022-05-13T12:24:30.854Z",
- "merchant_id": "UpGate",
- "merchant_customer_id": "U_001",
- "merchant_payment_id": "P_001",
- "email": "john_doe@upgate.com",
- "country_code": "CY",
- "language": "en-cy",
}
}
}