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
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 |
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 |
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 |
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 |
2133 | 3DS timeout |
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 |
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 |
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 |
3000 | Unknown error |
name |
---|
VISA |
Mastercard |
Maestro |
Discover |
Diners |
UnionPay |
RuPay |
American Express |
JCB |
name |
---|
AIRCASH |
ALIPAY |
ALIPAY_PLUS |
BANK_APP |
BINANCE_PAY |
BLIK |
CARDEXTERNAL |
CODI |
CRYPTO |
EPS |
GIROPAY |
IDEAL |
INSTANT_BANK_TRANSFER |
KAKAO_PAY |
MBWAY |
MPESA |
MULTIBANCO |
MYBANK |
NUPAY |
PAGOEFECTIVO |
PAYCONIQ |
PAYPAL |
PIX |
PSE |
SATISPAY |
SOFORT |
SPEI |
UPI |
OK
Request validation error
Authorization error
Too many requests 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,
- "shop_name": "my shop",
- "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",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "forced_3d": true,
- "shop_name": "my shop",
- "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",
- "arn": "331700997347"
}, - "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_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",
- "language": "en-us",
- "country_code": "US",
- "amount": "9.99",
- "currency_code": "USD",
- "transaction_amount": "7.87",
- "transaction_currency_code": "GBP",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "forced_3d": false,
- "shop_name": "my shop",
- "initial_subscription_id": null,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_transaction_price": "7.87",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
}
OK
Request validation error
Authorization error
Too many requests 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=",
- "shop_name": "my shop",
- "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",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "currency_code": "USD",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "shop_name": "my shop",
- "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",
- "arn": "331700997347"
}, - "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "card_scheme": "MASTERCARD",
- "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",
- "country_code": "US",
- "amount": "9.99",
- "currency_code": "USD",
- "transaction_amount": "7.87",
- "transaction_currency_code": "GBP",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "shop_name": "my shop",
- "initial_subscription_id": null,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_transaction_price": "7.87",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
}
OK
Request validation error
Authorization error
Too many requests 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,
- "shop_name": "my shop",
- "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",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "email": "john_doe@upgate.com",
- "language": "en-us",
- "country_code": "US",
- "forced_3d": true,
- "shop_name": "my shop",
- "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",
- "arn": "331700997347"
}, - "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_bin": "523205",
- "card_last_four_digits": "0003",
- "customer_full_name": "John Doe",
- "card_expiry_month": "12",
- "card_expiry_year": "2024"
}, - "payment": {
- "initial_subscription_id": "2E2CL5M3KC7K3",
- "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",
- "language": "en-us",
- "amount": "9.99",
- "country_code": "US",
- "transaction_amount": "7.87",
- "transaction_currency_code": "GBP",
- "currency_code": "USD",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "forced_3d": true,
- "shop_name": "my shop",
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SUBSCRIPTION",
- "product_price": "9.99",
- "product_transaction_price": "7.98",
- "product_name": "Test product name",
- "product_description": "Test product description",
- "charge_interval": "DAY",
- "charge_interval_value": 30,
- "is_trial": false
}
]
}
}
}
OK
Request validation error
Authorization error
Internal server error
{- "is_rebill_enabled": true
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "created_at": "2023-02-15T16:11:50.694Z",
- "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,
- "retry_at": "2023-03-13T16:11:50.694Z",
- "retry_count": 0,
- "retry_total_count": 2
}
}
OK
Authorization error
Internal server error
{- "type": "SUBSCRIPTION",
- "data": [
- {
- "subscription_id": "2JWZGUKDK2DK2",
- "created_at": "2023-02-15T16:11:50.694Z",
- "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,
- "retry_at": "2023-03-13T16:11:50.694Z",
- "retry_count": 0,
- "retry_total_count": 2
}, - {
- "subscription_id": "2JWZGUKDK2DK9",
- "created_at": "2024-03-10T11:09:44.832Z",
- "subscription_status": "ACTIVE",
- "expires_at": "2024-09-10T11:09:44.832Z",
- "merchant_id": "UpGate",
- "payment_id": "2E2CL5R9KC7K0",
- "product_id": "2JZGULPRK27K1",
- "merchant_product_id": "R_002",
- "merchant_payment_id": "P_002",
- "merchant_customer_id": "777",
- "payment_method": "CARD",
- "currency_code": "USD",
- "amount": "111.50",
- "is_trial": false,
- "charge_interval": "DAY",
- "charge_interval_value": 11,
- "is_rebill_enabled": true,
- "retry_at": "2024-06-10T11:09:44.832Z",
- "retry_count": 0,
- "retry_total_count": 2
}
], - "meta": {
- "pageNumber": 1,
- "pageSize": 100
}
}
OK
Authorization error
Not found
Internal server error
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "created_at": "2023-02-15T16:11:50.694Z",
- "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,
- "retry_at": "2023-03-13T16:11:50.694Z",
- "retry_count": 0,
- "retry_total_count": 2
}
}
OK
Request validation error
Authorization error
Internal server error
{- "is_rebill_enabled": true
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "created_at": "2023-02-15T16:11:50.694Z",
- "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,
- "retry_at": "2023-03-13T16:11:50.694Z",
- "retry_count": 0,
- "retry_total_count": 2
}
}
{- "type": "SUBSCRIPTION",
- "data": {
- "subscription_id": "2JWZGUKDK2DK2",
- "created_at": "2023-02-15T16:11:50.694Z",
- "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",
- "transaction_amount": "7.87",
- "is_trial": false,
- "charge_interval": "DAY",
- "charge_interval_value": 11,
- "is_rebill_enabled": true,
- "retry_at": "2023-03-13T16:11:50.694Z",
- "retry_count": 0,
- "retry_total_count": 2
}
}
Request to create token
OK
Request validation error
Authorization error
Too many requests 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",
- "shop_name": "my shop",
- "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_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",
- "shop_name": "my shop",
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE=",
- "initial_subscription_id": null
}
}
}
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",
- "payment_details": {
- "payment_token_id": "+wjPh608B8r2B2b3bG8IxARp6c1LqojODr/d19/ZPUE="
}
}
{- "type": "PAYMENT",
- "data": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "PAYOUT",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "base_currency_code": "EUR",
- "base_amount": "9.46"
}
}
{- "type": "TRANSACTION",
- "data": {
- "transaction_id": "2E2CL7BTK23K3",
- "transaction_type": "PAYOUT",
- "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": "TRUSTPAY",
- "processor_response_code": "0",
- "arn": "331700997347"
}, - "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="
}, - "payment": {
- "payment_id": "2E2CL5R3KC7K3",
- "payment_type": "PAYOUT",
- "payment_method": "CARD",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "UpGate",
- "merchant_payment_id": "P_001",
- "merchant_customer_id": "U_001",
- "amount": "9.99",
- "currency_code": "USD",
- "transaction_amount": "9.99",
- "transaction_currency_code": "USD",
- "base_amount": "9.46",
- "base_currency_code": "EUR"
}
}
}
required | Payment data (object) or Payment data embedded (object) |
required | object |
required | object Specifies the URLs to which the customer will be redirected after completing a payment transaction. The success_url is used for redirection upon successful payment, and the failure_url is used in case of payment failure. |
required | Array of objects (checkoutProduct) |
object |
OK
Request validation error
Authorization error
Too many requests error
Internal server error
{- "payment_data": {
- "merchant_payment_id": "P_001",
- "methods": [
- "CARD",
- "MBWAY"
], - "type": "SALE",
- "amount": 9.99,
- "currency_code": "EUR"
}, - "customer": {
- "merchant_customer_id": "U_001"
}, - "callback": {
}, - "products": [
- {
- "type": "SALE",
- "name": "Test product name",
- "description": "Test product description",
- "price": 9.99
}
]
}
{- "id": "2E2CL5R3KC7K3",
- "created_at": "2022-04-15T10:54:03.633Z",
- "merchant_id": "upgatetests",
- "payment_data": {
- "merchant_payment_id": "P_001",
- "methods": [
- "CARD",
- "MBWAY"
], - "type": "SALE",
- "amount": 9.99,
- "currency_code": "EUR"
}, - "customer": {
- "merchant_customer_id": "U_001"
}, - "callback": {
}, - "products": [
- {
- "type": "SALE",
- "name": "Test product name",
- "description": "Test product description",
- "price": 9.99
}
], - "session": {
- "created_at": "2024-02-15T13:38:47.173Z",
- "expires_at": "2024-02-15T13:53:47.173Z",
}
}
{- "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",
- "arn": "331700997347"
}, - "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_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",
- "language": "en-us",
- "country_code": "US",
- "amount": "9.99",
- "currency_code": "USD",
- "transaction_amount": "7.87",
- "transaction_currency_code": "GBP",
- "base_amount": "9.46",
- "base_currency_code": "EUR",
- "forced_3d": false,
- "shop_name": "my shop",
- "initial_subscription_id": null,
- "products": [
- {
- "merchant_product_id": "R_001",
- "product_id": "2JZGULPNK27K2",
- "product_type": "SALE",
- "product_price": "9.99",
- "product_transaction_price": "7.87",
- "product_name": "Test product name",
- "product_description": "Test product description"
}
]
}
}
}
Embedded components for checkout refer to a collection of ready-made user interface elements designed to facilitate the construction of your checkout process..
npm install axios express
success_url
and failure_url
for redirect customer.
Create index.js
file with code bellow:const express = require("express");
const axios = require("axios");
const PORT = 5000;
const YOUR_DOMAIN = `http://localhost:${PORT}`;
const API_KEY = "X-api-key";
const app = express();
app.use(express.static("public"));
app.post("/checkout", async (req, res) => {
const result = await axios.post(
"https://api.sandbox.upgate.com/v1/checkout",
{
payment_data: {
ui_mode: "EMBEDDED",
type: "SALE",
methods: ["CARD", "GIROPAY", "MBWAY"],
amount: "20.03",
currency_code: "EUR",
},
customer: {
merchant_customer_id: "test",
},
callback: {
success_url: `${YOUR_DOMAIN}/index.html?success=true`,
failure_url: `${YOUR_DOMAIN}/index.html`,
},
products: [
{
type: "SALE",
price: 55,
name: "Test product name for SALE",
description: "Test product description for SALE",
},
],
},
{
headers: {
"X-Api-Key": API_KEY,
"Content-Type": "application/json",
},
}
);
res.json({ url: result.data.session.redirect_url });
});
app.listen(PORT, () => console.log(`Running on port ${YOUR_DOMAIN}`));
./public
folder and create index.html
with code below:<html lang="en">
<head>
<script type="module" src="https://js.upgate.com/upgate.js"></script>
<script type="module" src="/main.js"></script>
<style>
body {
min-height: 100vh;
justify-content: center;
width: 350px;
margin: 0 auto;
display: flex;
flex-direction: column;
gap: 32px;
}
</style>
</head>
<body>
<div id="payment"></div>
<button id="buy" onclick="submit()">Buy</button>
</body>
</html>
<div id="payment">
in your payment form.
This incorporates an iframe containing a dynamic form that showcases configured payment method types available from the Checkout, enabling your customer to choose a payment method.
The form autonomously gathers the relevant payment details for the chosen payment method type.
Create main.js
file with code below in ./public
folder:let upgate;
const elementId = "payment";
async function mount() {
const { url } = await fetch("/checkout", { method: "POST" }).then((res) =>
res.json()
);
upgate.mountPaymentElement(elementId, url);
upgate.onResult(elementId, console.log); // use this method for handle result
}
function submit() {
upgate.submit(elementId);
}
window.onload = async () => {
upgate = new Upgate();
mount();
};
Invoke submit('%elementId%')
, providing the CheckoutElement and a success_url
to specify the destination where Upgate should redirect the user upon completing the payment.
For payments necessitating authentication, Upgate presents a modal for 3D Secure authentication or directs the customer to an authentication page, contingent on the payment method utilized.
Following the completion of the authentication process, the customer is redirected to the specified success_url
.
upgate.onResult
function for handle TResult
type object.export type TResult = {
success: boolean;
url?: string;
error_message?: string;
error_code?: number;
retry?: boolean;
};
All types of Upgate.js you can find in index.d.ts.
success: true
- payment processed successful.success: false; retry: false
- payment was not processed, and form must be unmounted with unmountPaymentElement('payment')
.retry: true; success: false
you can submit same form again (form not valid for example).failure_url
with query parameters ?error_code=&error_message=
In mountPaymentElement function you can pass third config parameter.
declare type TConfig = Partial<{
theme?: "LIGHT" | "DARK" | "BROWSER";
onTimeout?: () => void;
}>;
Property theme
overrides theme type defined in backoffice, and you can call embedded form with dynamically changed theme.
Callback onTimeout
will call when form time limit exceed. After timeout you need to remount component.
Theme type BROWSER
renders theme depending on system theme.
upgate.mountPaymentElement("%elementId%", "%checkoutUrl%", { theme: "LIGHT" });
After 15 minutes, a timeout will occur in the checkout process. The handling differs based on whether the form is embedded or non-embedded:
upgate.mountPaymentElement("%elementId%", "%checkoutUrl%", {
theme: "LIGHT",
onTimeout: handleTimeOutFn,
});
Or call onTimeout
method after mount with timeout handler function as a parameter:
upgate.onTimeout("%elementId%", handleTimeOutFn);
When timeout handler was called you need to remount payment element.
When using the embedded form, the display of errors for customers is managed by the merchant. The table below provides examples of the text we, as the UpGate provider, recommend using for each code to enhance customers experience.
code | message |
---|---|
2000 | Your transaction was declined. Please try again or use another card. |
2001, 2002, 2003 | Your transaction was declined by your bank. Please try again or use another card. |
2004 | Your card has insufficient funds. Please try again or use another card. |
2005, 2006, 2203 | Your card is not supported. Please try again or use another card. |
2007 | Your card has exceeded its limit. Please check your card and try again or use another card. |
2008, 2009, 2010, 2900, 2901 | An error occurred while processing your card. Try again in a little bit. |
2101, 2102 | Your card's security code is incorrect. Please try again or use another card. |
2130, 2131, 2132, 2138, 2139, 2140, 1320, 1321, 1322, 1390 | Your 3-D Secure authentication failed. Please try again or use another card. |
2202 | Your card has expired. Please try again or use another card. |
2204, 2299 | Your card number is invalid. Please check the card number and try again or use another card. |
other codes | Your card has been declined. Please try again or use another card. |
Google Pay™ is a convenient and secure payment method that allows your customers to quickly and easily make purchases on your website.
To integrate Google Pay™ into Checkout form, we follow the guidelines specified in Google Pay Android brand guidelines or Google Pay Web brand guidelines.
To setup Google Pay™ into your website, follow these steps:
{
"payment_data": {
"merchant_payment_id": "P_001",
"methods": ["CARD", "GOOGLE_PAY"],
"type": "SALE",
"amount": 9.99,
"currency_code": "EUR"
},
"customer": {
"merchant_customer_id": "U_001"
},
"callback": {
"success_url": "https://example.com/success",
"failure_url": "https://example.com/failure"
},
"products": [
{
"type": "SALE",
"name": "Test product name",
"description": "Test product description",
"price": 9.99
}
]
}
Configure Transaction Routing for Google Pay™ method, specify card schemes, currency and processor
Add information to your site that you support the Google Pay™ payment method and that you accept the terms defined in the Google Pay API Terms of Service.
"upgate"
value for the gateway
property and enter your unique gatewayMerchantId
. To obtain your gatewayMerchantId
, contact our team at info@upgate.com. If you would like to use your own Google merchant id, you need to register for a merchant id at Google, refer to setup Google Account guide and send it to you team at info@upgate.com."PAN_ONLY"
and contact our team at info@upgate.com.