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.
https://docs.upgate.com/_mock/openapi/
https://api.sandbox.upgate.com/v1/
taxOverride object was added to Checkout requestpaymentFormOverride object was added to Checkout requestThe system supports the query deduplication mechanism. Any system-wide merchant's request after the first one with the same X-Idempotency-Key will return an error. For example, if you have retrying mechanism for payouts and you want to avoid double sending, you can put header with value payout_{your_payout_id}
Supported Payment methods can be found here for cards and here for alternative payment methods. Please note that the payment methods can be empty, in this case payment methods would be taken from the back office configuration. In case you are using Google Pay or Apple Pay, Card method needs to be included as well, e.g. "APPLE_PAY", "CARD" or "GOOGLE_PAY", "CARD"
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.
Customizing Payment Form Appearance. All these parameters will override existing configuration in Upgate back office if any
https://docs.upgate.com/_mock/openapi/checkout
https://api.sandbox.upgate.com/v1/checkout
curl -i -X POST \
https://docs.upgate.com/_mock/openapi/checkout \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: YOUR_API_KEY_HERE' \
-H 'X-Idempotency-Key: string' \
-d '{
"payment_data": {
"merchant_payment_id": "P_001",
"methods": [
"CARD",
"MBWAY"
],
"type": "RECURRING",
"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": "SUBSCRIPTION",
"name": "Test product name",
"description": "Test product description",
"price": 9.99,
"charge": {
"value": 30,
"interval": "DAY"
}
}
]
}'OK
Supported Payment methods can be found here for cards and here for alternative payment methods. Please note that the payment methods can be empty, in this case payment methods would be taken from the back office configuration. In case you are using Google Pay or Apple Pay, Card method needs to be included as well, e.g. "APPLE_PAY", "CARD" or "GOOGLE_PAY", "CARD"
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.
Customizing Payment Form Appearance. All these parameters will override existing configuration in Upgate back office if any
{ "id": "2E2CL5R3KC7K3", "created_at": "2022-04-15T10:54:03.633Z", "merchant_id": "upgatetests", "payment_data": { "merchant_payment_id": "P_001", "methods": [ … ], "type": "RECURRING", "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": [ { … } ], "session": { "created_at": "2024-02-15T13:38:47.173Z", "expires_at": "2024-02-15T13:53:47.173Z", "redirect_url": "https://hub.sandbox.upgate.com/redirect/?sessionId=S_001" } }
The system supports the query deduplication mechanism. Any system-wide merchant's request after the first one with the same X-Idempotency-Key will return an error. For example, if you have retrying mechanism for payouts and you want to avoid double sending, you can put header with value payout_{your_payout_id}
https://docs.upgate.com/_mock/openapi/subscription
https://api.sandbox.upgate.com/v1/subscription
curl -i -X PATCH \
'https://docs.upgate.com/_mock/openapi/subscription?merchant_product_id=2JZGULPNK27K2' \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: YOUR_API_KEY_HERE' \
-H 'X-Idempotency-Key: string' \
-d '{
"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 } }
https://docs.upgate.com/_mock/openapi/subscription
https://api.sandbox.upgate.com/v1/subscription
curl -i -X GET \
'https://docs.upgate.com/_mock/openapi/subscription?page=1&size=100&transaction_id=2U5T2MIX22EK3' \
-H 'X-Api-Key: YOUR_API_KEY_HERE'{ "type": "SUBSCRIPTION", "data": [ { … }, { … } ], "meta": { "pageNumber": 1, "pageSize": 100 } }