Common parameters

0.1 Common parameters (parameters included in all API interfaces)

0.2 Composition rules of business parameter body

The result obtained by converting business parameters into JSON strings and encoding them with base64. For example, after converting your business parameters to JSON, it is {"chainType": 160, "callUrl": "http: \/\/xxx. com \/ubao_callback. HTML"}. Encoding this JSON string with base64 yields the result: eyJtYWluQ29pblR5cGUiOjE2MCwiY2FsbFVybCI6Imh0dHA6XC9cL3h4eC5jb21cL3ViYW9fY2FsbGJhY2suaHRtbCJ9, which is the body. Value of

0.3 Signature rules

Connect the body The four strings api_key, nonce, and timestamp are concatenated in this order and converted to md5 to obtain the signature. Merchant ID and api_key, obtained from the user center

0.4 Return value

See Error codes

0.5 Asynchronous notification

0.5.1 Asynchronous notification signature verification and fields

Asynchronous notification, also provided by the body Nonce, timestamp, and sign constitute. The body is encoded using base64. Connect the body The api_key, nonce, and timestamp are connected in this order, and then encrypted with MD5 to obtain a signature. Compare this signature with the returned sign, and if it is consistent, the signature verification is successful. After decoding the body through base64, you can obtain a JSON string containing the notification content.

0.5.2 Asynchronous notificationtype

Asynchronous notifications are divided into three categories, all using the same callback address, which is the callback address filled in when generating the address. Distinguish with the callbackType field in the body. These three types are: recharge, withdrawal or transfer, and balance change. When act in the body=recharge, it indicates that this is a recharge notification, while the other two types are pushed.

1、create address

1.1 Scenario Description

Generate the address of the specified chain. To successfully generate the address, you need to first add this chain Debug Tool 、SDK

1.2 Interface address

/mch/address/create

1.3 bodyparameter

1.4 Return after success

{"code":200,"message":"SUCCESS","address":"TQcK2oKpeVAE1mvYEudYJHgCr47F5ba8hk","chainType":160}

1.5 Return after failure

See Error codes

2、Withdraw coins

2.1 Scenario Description

The withdrawal request can only be for collection wallets or collection wallets. Please use the collection function.

2.2 Interface address

/mch/withdraw

2.3 bodyparameter

2.4 Return after success

{"code":200,"message":"SUCCESS"}

2.5 Return after failure

See Error codes

3、Verify the legitimacy of the address

3.1 Scenario Description

If you are unsure if the address you submitted meets the requirements, you can first verify its legality

3.2 Interface address

/mch/address/check

3.3 bodyparameter

3.4 Return after success

{"code":200,"message":"SUCCESS"}

3.5 Return after failure

See Error codes

4、Add observation wallet

4.1 Scenario Description

Add an observation address for an external wallet

4.2 Interface address

/mch/address/add

4.3 bodyparameter

4.4 Return after success

{"code":200,"message":"SUCCESS"}

4.5 Return after failure

See Error codes

5、Obtain currency information supported by merchants

5.1 Scenario Description

Obtain supported currencies from merchants

5.2 Interface address

/mch/coins

5.3 bodyparameter

5.4 Return after success

{"code":200,"message":"SUCCESS","coins":"[]"}

5.5 Return after failure

See Error codes

6、Collect to Collection Wallet

6.1 Scenario Description

Collect the balance from the collection wallet into the collection wallet

6.2 Interface address

/mch/address/pooling

6.3 bodyparameter

6.4 Return after success

{"code":200,"message":"SUCCESS"}

6.5 Return after failure

See Error codes

7、Verify address ownership

7.1 Scenario Description

In DAPP, after obtaining an address, it is also necessary to verify the ownership of the address to prevent logging in with an observation wallet. In similar situations, ownership verification is required.

7.2 Interface address

/mch/address/verify

7.3 bodyparameter

7.4 Return after success

{"code":200,"message":"SUCCESS","result":"true"}

7.5 Return after failure

See Error codes

8、Asynchronous notification for coin recharge

8.1 Scenario Description

After UBAO detects that the receiving address has been recharged, it will notify the callback URL left by the address. The notification content is: nonce timestamp、sign、body. body requires base64 decoding Debug Tool 、SDK

8.3 bodyparameter

8.4 Return after success

SUCCESS

8.5 Return after failure

If your business processing is successful, please return SUCCESS. If your business processing fails, you can return FAIL or other values. If SUCCESS is not returned, UBAO will make another callback in 5, 15, and 30 minutes. If it fails three times, it will give up. If necessary, you can manually call back in the user center.

9、Asynchronous notification of withdrawal and transfer

9.1 Scenario Description

When you withdraw or transfer money (only through the collection wallet), After UBAO processing, it will notify you through the callback URL left by this collection wallet. body requires base64 decoding Debug Tool 、SDK

9.3 bodyparameter

9.4 Return after success

SUCCESS

9.5 Return after failure

If your business processing is successful, please return SUCCESS. If your business processing fails, you can return FAIL or other values. If SUCCESS is not returned, UBAO will make another callback in 5, 15, and 30 minutes. If it fails three times, it will give up. If necessary, you can manually call back in the user center.

10、Balance change notification

10.1 Scenario Description

When UBAO detects a change in balance, it will notify you of the change through the callback URL left at this address. body requires base64 decoding Debug Tool 、SDK

10.3 bodyparameter

10.4 Return after success

SUCCESS

10.5 Return after failure

If your business processing is successful, please return SUCCESS. If your business processing fails, you can return FAIL or other values. If SUCCESS is not returned, UBAO will make another callback in 5, 15, and 30 minutes. If it fails three times, it will give up. If necessary, you can manually call back in the user center.

Currency number