UInterfaceV2 is equipped with major enhancements and features that elevate the Payment Gateway overall and payment processing experience for merchants and customers.

Click to learn more about the new features

In this guide, you will find the following:

API Upgrades
- Sandbox Testing Environment
  - Testing Your Upgrades
- Production Environment
  - Go-Live Checklist
Plugin Upgrades

API Upgrades

Sandbox Testing Environment

We highly recommend starting with the UInterfaceV2 Testing Environment to test the upgraded Payment Gateway and its features before switching to the Production Environment

Follow the following steps to upgrade your current UInterfaceV1 to the latest UInterface V2 Sandbox Testing Environment.

Update your code with reference to the sample code provided here in order to create a payment request.
Update your payment request API endpoint from
https://api.upayments.com/test-payment to
https://sandboxapi.upayments.com/api/v1/

📘
Test API Keys (Bearer Token)

Non-whitelabeled API : NWty8gdjt79cf756hdtyu6u8jht5ns6gfhgy8hdjL

(or)

Whitelabeled API: Wty6udt79cf75fba327ff718jht5ns6gfgst7hsy6T

Your API Key is either Non whitelabel or Whitelabel. Both features cannot be used simultaneously with the same API Key
HMAC Secret Key
For generating the HMAC Signature, use the HMAC Secret Key as explained here
Secret Key: sk_test_01a0a4b450b4c4738b586d7f33134d44

The old API endpoints must be replaced with the new API endpoints given below

	UInterface V1 Test/Production Environment	UInterface V2 Test Environment
Create Payment request	Test: https://api.upayments.com/test-payment Prod: https://api.upayments.com/payment-request	https://sandboxapi.upayments.com/api/v1/charge
Create Customer Unique Token (To save cards)	https://api.upayments.com/api/merchant/token	https://sandboxapi.upayments.com/api/v1/create-customer-unique-token
Add cards	Live: https://api.upayments.com/api/merchant/token	<https://sandboxapi.upayments.com/api/v1/add-card>
Retrieve Token	https://api.upayments.com/api/merchant/user/cards	https://sandboxapi.upayments.com/api/v1/retrieve-customer-cards
Check Payment Status	https://statusapi.upayments.com/api/check/payment/status	https://sandboxapi.upayments.com/api/v1/get-payment-status/{track_id}
Check payment Button Status for whitelabeled users	https://statusapi.upayments.com/api/check/button/status	https://sandboxapi.upayments.com/api/v1/check-payment-button-status
Create Refunds	Live only: https://api.upayments.com/create-refund	https://sandboxapi.upayments.com/api/v1/create-refund
Delete single vendor refund	Live onlyhttps://api.upayments.com/delete-refund	https://sandboxapi.upayments.com/api/v1/delete-refund
Create multi-vendor refunds	Live onlyhttps://api.upayments.com/create-multivendor-refund	https://sandboxapi.upayments.com/api/v1/create-multivendor-refund
Delete multi-vendor refund		https://sandboxapi.upayments.com/api/v1/delete-multivendor-refund

Testing your Upgrades

After replacing all V1 APIs with UInterfaceV2 APIs, you can start testing using the Sandbox Environment.

This Environment facilitates testing the upgrade without requiring real payments or charges. This environment has the same behavior as the Production Environment, including the creation of genuine objects.

Test API Keys can be used for this purpose, along with Test Card details.

Production Environment

The APIs below will need to be replaced with new V2 API Production Environment Links

	UInterface V1 Production Environment	UInterface V2 Production Environment
Create Payment request	https://api.upayments.com/payment-request	https://uapi.upayments.com/api/v1/charge
Create Customer Unique Token (To save cards)	https://api.upayments.com/api/merchant/token	https://uapi.upayments.com/api/v1/create-customer-unique-token
Add cards	https://api.upayments.com/api/merchant/token	https://uapi.upayments.com/api/v1/add-card
Retrieve Token	https://api.upayments.com/api/merchant/user/cards	https://uapi.upayments.com/api/v1/retrieve-customer-cards
Check Payment Status	https://statusapi.upayments.com/api/check/payment/status	https://uapi.upayments.com/api/v1/get-payment-status/{track_id}
Check payment Button Status for whitelabeled users	https://statusapi.upayments.com/api/check/button/status	https://uapi.upayments.com/api/v1/check-payment-button-status
Create Refunds	https://api.upayments.com/create-refund	https://uapi.upayments.com/api/v1/create-refund
Delete single vendor refund	https://api.upayments.com/delete-refund	https://uapi.upayments.com/api/v1/delete-refund
Create multi-vendor refunds	https://api.upayments.com/create-multivendor-refund	https://uapi.upayments.com/api/v1/create-multivendor-refund
Delete multi-vendor refund	-	https://uapi.upayments.com/api/v1/delete-multivendor-refund

Go-Live Checklist

Once you finalize your upgrade by testing the V2 Sandbox Environment and updating to V2 Production APIs, you are ready for the final Go-Live Checklist to ensure that everything is working smoothly:

Update Endpoints
Update V2 Sandbox Environment's endpoints to V2 Production Environment
- V2 Production Environment API: https://uapi.upayments.com/
- Example: Replace https://sandboxapi.upayments.com/api/v1/charge with https://uapi.upayments.com/api/v1/charge
Production API Keys (Bearer Token)
These keys will be the same as V1 API Production Keys
Check out the Go-live Checklist for more details

Plugins

If you are using a UInterfaceV1 plugin, please find the new UInterfaceV2 plugin list below:

If you have any questions or in need of any assistance, kindly contact our team at: [email protected]