This document mainly describes the docking standards and technical details involved in merchant access to the platform. Developers are requested to read the docking specifications carefully for quick access. Thank you!

If you encounter any problems during the access process, you can contact the online customer service at any time for technical support.

Get merchant UID

Merchant UID refers to a 6-digit unique code assigned to a user after registering on the platform. It represents the user's unique identity on the platform. Please keep it properly.

Generate a merchant key

The secret key that merchants need to use when accessing the platform is mainly used for signature verification and secure access. The secret key can be viewed in the merchant management backend --> API access.

Request method: POST

Content-type：application/json

To ensure that the transmitted data is not modified, all interface requests and callbacks require digest authentication.

Request Parameters

The following are the outermost parameters of the request. Please convert the dedicated parameters of each interface into JSON format and put them in the data field.

Request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "1716700031",
    "data": "{\"Amount\":\"2\",\"Blockchain\":\"TRC20\",\"CustomerOrderNo\":\"TEST127\",\"EffectiveDuration\":300,\"JumpURL\":\"111\"}"
}

Signature method

sign=md5(uid + data + key + timestamp), where key is the merchant key

Signature code PHP example:

$uid = "136994";
$data = '{"Amount":"2","Blockchain":"TRC20","CustomerOrderNo":"TEST127","EffectiveDuration":300,"JumpURL":"111"}';
$time = "1716700031";
$key = "c6e86d12aa021a3a94ea45235ca5d9aa";
$sign = md5($uid . $data . $key . $time);
echo $sign;//2a81cd6c131f4c1ac88c2f9408000470
					

Return results

The following are the outermost parameters of the returned results

Return example:

{
	"code": 200,
	"data": {
		"MerchantSellOrderStatus": "T_MERCHANT_VERIFY_TODO",
		"MerchantSellOrderStatusText": "待商户审核"
	},
	"msg": "success"
}

Request address: https://open.uugate.com//Open.Customer/CreateReceiveOrder

Request parameters:

Interface request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "123456",
    "data": "{\"Amount\":\"2\",\"Blockchain\":\"TRC20\",\"CustomerOrderNo\":\"TEST127\",\"EffectiveDuration\":300,\"JumpURL\":\"111\"}"
}

The interface returns:

Interface return example:

{
    "CheckOutUrl": "https://open.uugate.com/Open.Customer/CheckOut?data=Ergz52xOPB9SJKW0CqbajDRPJIihDDCO8IYwIdR8MZgRAiOthgnK%2BsBjPQ7SBVqvYNuudqrYQlRDvlD4epD1QMeRp5wQlHRhugTbYCvJF3M%3D",
    "ReceiveAddress": "TLvT5GG3aWiTknCvGbux2CW6wgwznogBF2",
    "code": 0,
    "msg": "success"
}

Request address: https://open.uugate.com/Open.Customer/GetReceiveOrderStatus

Request parameters:

Interface request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "1716700031",
    "data": "{\"CustomerOrderNo\":\"126\"}"
}

The interface returns:

Interface return example:

{
    "ReceiveOrder": {
        "UID": "136994",
        "OrderNo": "SK2405252026240048",
        "CustomerOrderNo": "126",
        "Status": "待付款",
        "FinishTime": null,
        "Amount": "1.0000",
        "AmountInFact": null
    },
    "code": 0,
    "msg": "success"
}

A callback will be made when the order is completed or the order is supplemented. The callback will be made up to 3 times, and the callback must return 'success' if it is successfully received. The request method is POST, Content-Type: application/json

Request address: set in merchant backend->API access

Request parameters:

Interface request example:

{
    "uid":136994,
    "timestamp":1716720904,
    "data":"{\"OrderType\":\"ReceiveOrder\",\"ReceiveOrder\":{\"UID\":\"136994\",\"OrderNo\":\"SK2405251145300005\",\"CustomerOrderNo\":\"122\",\"Status\":\"已完成\",\"FinishTime\":\"2024-05-25 17:27:28\",\"Amount\":\"1.0000\",\"AmountInFact\":\"1.0000\"}}",
    "sign":"90de05574c1630b4d11a94a32cd0bad6"
}

Request URL: https://open.uugate.com/Open.Customer/CreatePaymentOrder

Request parameters:

Interface request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "1716700031",
    "data": "{\"Amount\":\"1\",\"Blockchain\":\"TRC20\",\"CustomerOrderNo\":\"127\",\"FromAddress\":\"TMQvgsJLGRh48sth9wgFN4Xptgs6TFkAbd\",\"ToAddress\":\"TSVAFSHBBsEHB6UbCn7ogUmZhjSpvHdPQN\"}"
}

Interface return example:

{
    "PaymentOrder": {
        "OrderNo": "FK2405261145180046",
        "CustomerOrderNo": "127",
        "FromAddress": "TMQvgsJLGRh48sth9wgFN4Xptgs6TFkAbd"
    },
    "code": 0,
    "msg": "success"
}

Request URL: https://open.uugate.com/Open.Customer/GetPaymentOrderStatus

Request parameters:

Interface request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "1716700031",
    "data": "{\"CustomerOrderNo\":\"FK2405211522064632\"}"
}

Interface return example:

{
    "PaymentOrder": {
        "UID": "136994",
        "OrderNo": "FK2405211522064632",
        "CustomerOrderNo": "FK2405211522064632",
        "Status": "付款中",
        "Amount": "123.0000",
        "FinishTime": null
    },
    "code": 0,
    "msg": "success"
}

A callback will be made when the order is completed. The callback will be made up to 3 times, and the callback must return 'success' if it is successfully received. The request method is POST, Content-Type: application/json

Request address: set in merchant backend->API access

Request parameters:

Interface request example:

{
    "uid": "136994",
    "timestamp": 1716721664,
    "data": "{\"OrderType\":\"PaymentOrder\",\"PaymentOrder\":{\"UID\":\"136994\",\"OrderNo\":\"FK2405261145180046\",\"CustomerOrderNo\":\"127\",\"Status\":\"付款中\",\"FinishTime\":null,\"Amount\":\"1.0000\"}}",
    "sign": "153902d63b413837012d65a6a18e3461"
}

Request URL: https://open.uugate.com/Open.Customer/GetAdvanceAccountBalance

Request parameters:

Interface request example:

{
    "uid": "136994",
    "sign": "00bd24ca1fa29a333191235aad10621a",
    "timestamp": "1716700031",
    "data": "{}"
}

The interface returns:

Interface return example:

{
    "AdvanceAccount": {
        "Balance": "2.8222"
    },
    "code": 0,
    "msg": "success"
}