Kenya payment API documentation

1. How to get API Key

   The user logs in to the cash register -> Developer Center -> API Key -> Create API key. API Key has a separate configuration page and is bound to a fixed IP address ("0.0.0.0" means no IP interception filtering, any IP can be accessed), and different API Keys can be configured to meet different needs. Please do not disclose your Access Key and Secret Key to avoid asset loss. After the Secret Key is generated, it cannot be viewed again. Please save it in time. If you forget the Secret Key, please recycle the key pair in the backstage of the merchant and apply for a new key pair.

1.1 How to create API KEY

• Click Developer Center-API Key

• 1Choose whether to enable the debug mode (After debugging mode is enabled, you will have a standard prompt message and log view address for any errors )

• 2Select API Key permission

• 3Enter the whitelist address (0.0.0.0 means any IP address can be accessed)

Note: (When entering the whitelist domain name, you should pay attention to using "," to isolate multiple IPs.)

• 4 click create to generate API KEY

(After the API KEY is generated, you can copy, view, edit, and delete it in the My API KEY list below. Note that the Secret key only appears once when it is generated. Please save it properly. If you forget the Secret Key, Please recycle the key pair and apply for a new one.)

• Click Edit to close or open [Start Debugging] and modify the API Key permission and whitelist address. After the modification is complete, click Save

Note: Please wait patiently for 90 seconds for the API Key to take effect after creating or editing the API Key

2. How to use API Key

The current API Key is to add a parameter list in the header of the request

Parameter name	Parameter description	Type	Required
access_key	Api Key access key (eg: TPhoa7ZQ)	String	Yes
timestamp	Millisecond-level timestamp (13 digits, such as: 1679669488472)	String	Yes
nonce	UUID (36 bits such as: 02f7a04f-53cc-47d4-bb3f-fae69dab49ac) The five parts are 8 characters, 4 characters, 4 characters, 4 characters, and 12 characters, with "-" in the middle interval	String	yes
sign	Parameter signature (eg: GXx2wYUD6UVr+zcmeCSFFPzcBLA=)	String	Yes

3. Technology side parameter access process

4. How to sign the interface

Signature Description

   API requests are very likely to be tampered with during transmission over the internet. In order to ensure that the request has not been changed, all private interfaces except public interfaces (basic information, market data, etc.) must use your API Key is used for signature verification to verify whether parameters or parameter values have changed during transmission.

A legitimate request consists of the following parts:

• access_key: API access key;
• secret_key: The key used for signature encryption (only visible once when applying for an API Key in the background, please copy and save it in a safe place, and do not disclose it);
• timestamp: The time (UTC time) when you made the request. Such as: 1632811287325 (13 digits). Including this value in a query request helps prevent third parties from intercepting your request;
• nonce: random UUID string. Such as: 053a1b81-48a0-4bb1-96b2-60f6e509d911 (36 bits);
• sign: The value calculated by the signature, which is used to ensure that the signature is valid and has not been tampered with;
• All interfaces need to pass the above public parameters except secret_key in the http request header (header). The public parameters include (access_key, timestamp, nonce, sign) and other signature parameters are described in the API interface as allow.

Signature steps

​ 1. Define a Map dictionary type object, and put the parameters in the request into it in the form of key-value

​ 2. Put access_key, timestamp, and nonce into the Map defined in the first step

​ 3. Sort the attributes in the Map in ascending order (lexicographic order) according to the ASCII code and convert the Map to a string in the form of "key1=value1&key2=value2"

​ 4. Encrypt the character string converted in the previous step with secret_key by HMAC_SHA1 and perform Base64 transcoding to obtain the value of the sign parameter. secret_key is the information in the apikey created on the cashier platform

​ 5. Add the sign value and other required parameters to the request header, and send the request to the target interface

Signature debugging tools

• SignUtil: User login to cash register -> Developer Center -> API Documentation -> Signature Tool The Signature tool page is displayed (The access_key in the tool, please use a valid access_key and please set the IP whitelist that allows this access_key access to 0.0.0.0, we strongly recommend the used Access_key is discarded after debugging)

• 

  

• 

5. Interface list

5.1 Test interface connectivity

request method

Get

Request URL

/ping

response data

{"version":"1.0.1","timestamp":1688116827306}

Response parameter description

Param	Type	Desc
version	String	If this parameter is returned, all interfaces in this document can be requested normally
timestamp	int64	Unix timestamp

5.2 Create a new collection order

request method

post

Request URL

/api/v3/ken/createCollectingOrder

Request type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

request header

Param	Desc	Sample
access_key	Acquisition from merchant background	pFqV75X3
timestamp	Unix timestamp 13 digits milliseconds	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

request parameters

{
    "amount":"100",
    "channelType":"BANK",
    "externalOrderId":"9873332277777777773",
    "phone":"254759888325",
    "checkingPhone":"254759888325",
    "remark":"adkasd",
    "notifyUrl":"https://platform.hambit.co/#/home/dashboard",
    "returnUrl":"https://platform.hambit.co/#/home/dashboard"
}

Description of request parameters

Param	Desc	Sample	Require
amount	Amount of payment, Can only be integers(String)	100	required
channelType	payment type oneof=BANK(String)	CHARGE	required
externalOrderId	Merchant order number max=64 (String)	9873332277777777773	required
phone	Phone Number Format (2547XXXXXXXX) (String)	254759888325	required
checkingPhone	Phone number to receive STK password prompt (String)	Choose 0 or 1 according to the actual situation	required
notifyUrl	notification URL (String, Url)	https://platform.hambit.co/#/home/dashboard	optional
remark	remark max=255 (String)	adkasd	optional
returnUrl	return address (String)	https://platform.hambit.co/#/home/dashboard	optional

response type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

response data

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": {
        "cashierUrl": "http://192.168.1.200:1084/OCURRPAID202311200206171700445977710DEV001OO0000000200017453?data=eyJjYXNoaWVyQ3VycmVuY3lBbW91bnQiOjEwMC4wMCwiY2FzaGllckV4cGlyZVRpbWUiOjE3MDA0\nNDc3Nzc3NjUsImNhc2hpZXJJZCI6Ik9DVVJSUEFJRDIwMjMxMTIwMDIwNjE3MTcwMDQ0NTk3Nzcx\nMERFVjAwMU9PMDAwMDAwMDIwMDAxNzQ1MyIsImNhc2hpZXJVcmwiOiJodHRwOi8vMTkyLjE2OC4x\nLjIwMDoxMDg0L09DVVJSUEFJRDIwMjMxMTIwMDIwNjE3MTcwMDQ0NTk3NzcxMERFVjAwMU9PMDAw\nMDAwMDIwMDAxNzQ1MyIsImN1cnJlbmN5IjoiS0VTIiwiY3VycmVuY3lPcmRlclZvIjp7ImFtb3Vu\ndCI6MTAwLjAwLCJjdXJyZW5jeSI6IktFUyIsImV4dGVybmFsT3JkZXJJZCI6Ijk4NzMzMzIyNzc3\nNzc3Nzc3NzMzIiwibWVyY2hhbnROYW1lIjoiY2xhcmtfYWdlbnRfaGFtYml0Iiwib3JkZXJJZCI6\nIk9DVVJSUEFJRDIwMjMxMTIwMDIwNjE3MTcwMDQ0NTk3Nzc4N0RFVjAwMU9PMDAwMDAwMDQwMDAx\nNzQ1NCIsIm9yZGVyU3RhdHVzIjoiQXdhaXRpbmcgUGF5bWVudCIsIm9yZGVyU3RhdHVzQ29kZSI6\nMSwib3JkZXJUaW1lIjoxNzAwNDQ1OTc3Nzg4LCJwYXlQYXJhbSI6Int9IiwicGF5VHlwZSI6MTA3\nLCJwYXlUeXBlTmFtZSI6IkNoYXJnZSIsInRyYWRlTm90ZSI6ImFka2FzZCJ9LCJpc0NyZWF0ZU9y\nZGVyIjp0cnVlLCJtZXJjaGFudElkIjoxNzA3Mjg1ODQwMzI2MTI3NjE3LCJwYXlUeXBlIjoxMDcs\nInJldHVyblVybCI6Imh0dHBzOi8vcGxhdGZvcm0uaGFtYml0LmNvLyMvaG9tZS9kYXNoYm9hcmQi\nLCJ1c2VySW5mb05hbWUiOiIyNTQ3NTk4ODgzMjUiLCJ1c2VySW5mb05vIjoiMjU0NzU5ODg4MzI1\nIiwidmVyc2lvbiI6InYxIn0=&pm=W3siY3VycmVuY3lUeXBlIjoiTVhOIiwicGF5VHlwZXMiOlt7ImNvZGUiOjEwMiwidmFsdWUiOiJC\nQU5LIn1dfSx7ImN1cnJlbmN5VHlwZSI6Ik5HTiIsInBheVR5cGVzIjpbeyJjb2RlIjoxMDIsInZh\nbHVlIjoiQkFOSyJ9XX0seyJjdXJyZW5jeVR5cGUiOiJJRFIiLCJwYXlUeXBlcyI6W3siY29kZSI6\nMTAyLCJ2YWx1ZSI6IkJBTksifV19LHsiY3VycmVuY3lUeXBlIjoiS0VTIiwicGF5VHlwZXMiOltd\nfSx7ImN1cnJlbmN5VHlwZSI6IklOUiIsInBheVR5cGVzIjpbeyJjb2RlIjoxMDIsInZhbHVlIjoi\nQkFOSyJ9XX0seyJjdXJyZW5jeVR5cGUiOiJCUkwiLCJwYXlUeXBlcyI6W3siY29kZSI6MTAxLCJ2\nYWx1ZSI6IlBJWCJ9LHsiY29kZSI6MTAzLCJ2YWx1ZSI6IlBJWF9EWU5BTUlDIn1dfV0=",
        "cashierExpireTime": 1700447777765,
        "currency": "KES",
        "cashierCurrencyAmount": "100",
        "returnUrl": "https://platform.hambit.co/#/home/dashboard",
        "currencyOrderVo": {
            "externalOrderId": "98733322777777777733",
            "tradeNote": "adkasd",
            "orderId": "OCURRPAID202311200206171700445977787DEV001OO0000000400017454"
        }
    }
}

Response parameter description

Param	Desc	Sample
cashierUrl	String	收银台链接
cashierExpireTime	Int64	收银台到期时间
currency	String	币种编码
cashierCurrencyAmount	String	收款金额
externalOrderId	String	商户订单号
orderId	String	系统订单ID
tradeNote	String	备注
returnUrl	String	回调地址

5.3 Create a new transfer order

request method

post

Request URL

/api/v3/ken/createTransferOrder

Request type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

request header

Param	Desc	Sample
access_key	Acquisition from merchant background	pFqV75X3
timestamp	Unix timestamp 13 digits milliseconds	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

request parameters

{
    "currencyAmount":"10",
    "channelType":"BANK",
    "externalOrderId":"22222222222222",
    "phone":"254115555088",
    "bankName":"Impala credit",
    "remark":"123",
    "notifyUrl":"https://dev-gw.hambit.co/api/v1/hambit/channel/notify/payout/1814182600440344577"
}

Description of request parameters

Param	Desc	Sample	Require
channelType	payment type oneof=BANK (String)	BANK	required
currencyAmount	payment amount,Can only be integers (String)	10	required
externalOrderId	Merchant order ID max=64 (String)	877602573592250180	required
phone	Phone(String)	22222222222222	required
bankName	bank name (String)	Impala credit （Reserved fields according to actual situation）	optional
remark	remark max=255 (String)	123	optional
notifyUrl	notification URL (String)	https://dev-gw.hambit.co/api/v1/hambit/channel/notify/payout/1814182600440344577	optional

response type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

response data

{
    "code":"200",
    "success":true,
    "msg":"成功",
    "msgEn":"SUCCESS",
        "data":{
        "orderId":"OCURRDRAW202407300549391722318579788DEV001OO0000000200315986",
        "orderStatus":"Accepted",
        "externalOrderId":"59729709",
        "currencyType":"KES"
        }
}

Response parameter description

Param	Type	Desc
currencyType	String	Fiat currency type
externalOrderId	String	merchant order id
orderId	String	System order ID
orderStatus	String	order status

5.4 Query Collection Orders

request method

post

Request URL

/api/v3/ken/query/collectingOrder

Request type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

request header

Param	Desc	Sample
access_key	Acquisition from merchant background	pFqV75X3
timestamp	Unix timestamp 13 digits milliseconds	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

request parameters

{
   "externalOrderId": "9873332277777777773",
   "orderId":"OCURRPAID202311170925441700213144225DEV001OO0000000400003736"

}

Description of request parameters

Param	Desc	Require
externalOrderId	Merchant order number max=64 (String)	required
orderId	system order number (String)	required

response type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

response data

{
    "code":"200",
    "success":true,
    "msg":"成功",
    "msgEn":"SUCCESS",
    "data":[
		{
            "orderId":"OCURRDRAW202407300132471722303167620DEV001OO0000000200315768",
            "cashierId":"",
            "orderType":2,
            "orderResourceType":2,
            "userId":"1707285840326127617",
            "orderStatus":8,
            "orderTime":1722303168000,
            "channelOrderId":"1722303168799iqloms9cy4uaiel883y",
            "externalOrderId":"79060576",
            "orderAmount":"10",
            "orderActualAmount":"13.4",
            "orderFee":"3.4",
            "orderPayTime":1722303248000,
            "currencyType":"KES",
            "payType":202,
			"tradeNote":"123",
			"notifyUrl":"https://dev-gw.hambit.co/api/v1/hambit/channel/notify/payout/1814182600440344577",
			"markStatus":0,
			"errorMsg":"Success",
			"errorMsgEn":"Success",
			"accountType":"",
			"accountName":"",
			"accountNo":"",
			"orderTypeCode":"Transfer",
			"orderResourceTypeCode":"Currency",
			"orderStatusCode":"Success",
			"payTypeCode":"BANK"
		}
	]
}

Response parameter description

Param	Type	Desc
orderId	String	order ID
cashierId	String	Cashier ID
orderType	int64	order type
orderResourceType	int64	The business type of the order
userId	String	user ID
orderStatus	int64	order status 1- pending payment 2- payment successful
orderTime	int64	order initiation time
channelOrderId	String	The order ID of the channel associated with the order
externalOrderId	String	Merchant order ID
orderAmount	String	order amount
orderActualAmount	String	actual order amount
orderFee	int64	order fee
orderPayTime	int64	order payment time
currencyType	String	currency type
payType	int64	payment type 107:CHARGE
tradeNote	String	Note
notifyUrl	String	callback URL
markStatus	int64	mark status
errorMsg	String	error message
errorMsgEn	String	error message en
accountType	String	account type
accountName	String	account name
accountNo	String	account number
orderTypeCode	String	order type code
orderResourceTypeCode	String	The business type code of the order
orderStatusCode	String	orderStatusc Description
payTypaCode	String	payment type code reference payType

5.5 Query transfer orders

request method

post

Request URL

/api/v3/ken/query/transferOrder

Request type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

request header

Param	Desc	Sample
access_key	Acquisition from merchant background	pFqV75X3
timestamp	Unix timestamp 13 digits milliseconds	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

request parameters

{
	"externalOrderId": "877602573592250180",
     "orderId": "OCURRDRAW202307180246581689648418963DOCKER020000000200000244"
}

Description of request parameters

Param	Desc	Require
externalOrderId	Merchant order number max=64 (String)	required
orderId	system order number (String)	required

response type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

response data

{
    "code": "200",
    "success": true,
    "msg": "Success",
    "msgEn": "SUCCESS",
    "data": [{
    "orderId": "OCURRDRAW202307180246581689648418963DOCKER020000000200000244",
    "cashierId": "",
    "orderType": 2,
    "orderResourceType": 2,
    "userId": "1663371399710216194",
    "orderStatus": 1,
    "orderTime": 1689648419000,
    "channelOrderId": "",
    "externalOrderId": "877602573592250180",
    "orderAmount": "40.1",
    "orderActualAmount": "40.9",
    "orderFee": "0.8",
    "orderPayTime": null,
    "currencyType": "PEN",
    "payType": 202,
    "tradeNote": "",
    "notifyUrl": "",
    "markStatus": 0,
    "errorMsg": "",
    "errorMsgEn": "",
    "accountType": "0",
    "accountName": "AZTECA2",
    "accountNo": "13214346",
    "orderTypeCode": "Transfer",
    "orderResourceTypeCode": "Currency",
    "orderStatusCode": "Accepted",
    "payTypeCode": "BANK"
	}]
}

Response parameter description

Param	Type	Desc
orderId	String	order ID
cashierId	String	Cashier ID
orderType	int64	order type
orderResourceType	int64	The business type of the order
userId	String	user ID
orderStatus	int64	order status 1-accepted 2-bank processing 4-Failed(Bank rejection) 8-success 16-Failed
orderTime	int64	order initiation time
channelOrderId	String	The order ID of the channel associated with the order
externalOrderId	String	Merchant order ID
orderAmount	String	order amount
orderActualAmount	String	actual order amount
orderFee	int64	order handling fee
orderPayTime	int64	order payment time
currencyType	String	currency type
payType	int64	payment type 102:BANK 202:BANK
tradeNote	String	Note
notifyUrl	String	callback URL
markStatus	int64	mark status
errorMsg	String	error message
errorMsgEn	String	error message en
accountType	String	account type
accountName	String	account name
accountNo	String	account number
orderTypeCode	String	order type code
orderResourceTypeCode	String	The business type code of the order
orderStatusCode	String	orderStatus description
payTypeCode	String	payment type code reference payType

5.6 Query balance

request method

GET

Request URL

/api/v3/ken/query/balance

request header

Param	Desc	Sample
access_key	Acquisition from merchant background	pFqV75X3
timestamp	Unix timestamp 13 digits milliseconds	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

response data

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": [
        {
            "accountBalance": "0",
            "accountFreezeAmount": "0",
            "accountStatusId": 4,
            "accountWaitSettledAmount": "0",
            "currencyType": "KES",
            "accountStatus": "InAndOut"
        }
    ]
}

Response parameter description

Param	Type	Desc
accountBalance	String	Available account balance
accountFreezeAmount	String	Account Freeze Amount
accountStatusId	int64	Account Status id
accountWaitSettledAmount	String	Amount to be transferred from the account
currencyType	String	Fiat currency type
accountStatus	String	account status

6. Callback information

6.1 How to call back interface check

Signature verification instructions

​ API requests are likely to be tampered with during transmission over the internet. To ensure that callbacks have not been changed, you can set callback parameter signature authentication. The setting method is: log in to the cashier -> developer center -> callback address -> add.

Signature verification steps

The overall process is roughly the same as the signature, except that the data used to verify the signature is different. The signature is to construct the data by itself, and the signature is to obtain the data (header, json)

1. Take out the sign value in the header;

2. Define a Map dictionary type object, put the json parameters in the request in the form of key-value

3. Take out the access_key, timestamp, and nonce in the header and put them into the Map defined in the previous step

4. Sort the keys in the Map according to the ASCII code from small to large (lexicographic order) and convert the Map into a string in the form of "key1=value1&key2=value2";

5. Use the secret_key to encrypt the character string converted in the previous step with HMAC_SHA1 and perform Base64 transcoding to obtain the signed value and the sign extracted from the header in the first step for string verification. If they match, the signature verification will pass, otherwise, the signature verification will fail. The secret_key here needs to match the access_key when placing an order.

6.2 Payment callback

callback data

{
    "currencyType":"KES",
    "orderActualAmount":"50",
    "orderId":"OCURRPAID202311210833451700555625547DEV001OO0000000400025188",
    "orderFee":"13",
    "orderStatus":"Payment Successful",
    "payParam":"{}",
    "externalOrderId":"63966670",
    "payTypeName":"Charge",
    "orderAmount":"50",
    "orderTime":1700555626000,
    "payType":107,
    "orderStatusCode":2,
    "markStatus":0,
    "orderPayTime":1700555636000
}

Callback data description

Param	Type	Desc
currencyType	String	Fiat currency type
orderActualAmount	String	The actual payment amount of the order
orderId	String	order ID
order fee	String	Order handling fee
orderStatus	String	orderStatusCode description
payParam	String	payment parameters
externalOrderId	String	Merchant order ID
tradeNote	String	Remark
payTypeName	String	payment type name
orderAmount	String	order amount
orderTime	int64	Order creation time
payType	int64	Payment Type 101-PIX
orderStatusCode	int64	Order status code 1-pending payment 2- payment successful
markStatus	int64	mark status
orderPayTime	int64	order payment time
errorMsg	String	Error message
errorMsgEn	String	Error message en

At any time, the merchant can log in to the backstage of the merchant to manually trigger the callback (it is not recommended to initiate a manual callback if the order is not final), and the relevant information such as the order status in the callback information is the actual status (manualPlease pay attention to the order status when calling back. If the status of the manual callback order is not final, the platform will still initiate a notification when the order becomes final. Please pay attention to redundant processing at the business level)

6.3 transfer callback

callback data

{
    "currencyType": "KES",
    "accountCode": "40012",
    "accountName": "BBVA MEXICO",
    "orderId": "OCURRDRAW202307171006541689588414537BMS001OO0000000200000694",
    "accountType": "3",
    "orderFee": "3",
    "orderStatus": "In bank processing",
    "externalOrderId": "79159948",
    "payTypeName": "BANK",
    "orderAmount": "40",
    "orderTime": 1689588415000,
    "payType": 202,
    "userInfoName": "Abraham Meza Aragon",
    "accountNo": "4152314092856502",
    "orderStatusCode": 2,
    "markStatus": 0
}

Callback data description

Param	Type	Desc
currencyType	String	currency type
accountCode	String	account code
accountName	String	account name
orderId	String	order ID
accountType	String	account type
orderFee	String	Order Fee
orderStatus	String	orderStatusCode description
externalOrderId	int64	Merchant order ID
payTypeName	float64	payment type name
orderAmount	float64	order creation amount
orderPayTime	int64	Order payment time
orderTime	int64	order creation time
payType	int64	Payment type
userInfoName	String	username
accountNo	String	account number
orderStatusCode	String	Order Status Code 1-accepted 2-bank processing 4-Failed(bank not accepted) 8-success 16-Failed
markStatus	String	User credential type

Merchants can log in to the backend of the merchant at any time to manually trigger a callback (it is not recommended to initiate a manual callback if the order is not in the final state). The status of the callback order is not final, and the platform will still initiate a notification when the order becomes final, please pay attention to the redundant processing at the business level)

6.4 Callback response

Remarks: All callbacks include signature information. It is recommended that merchants do a callback signature verification. After receiving the callback information, the merchant will confirm the final status of the order. Please respond to the website

Regarding the following information (content-type: application/json), if there is no normal response from the server, it will be within 30 minutes, with a total of 2 every three minutes

Notice

{"code":200,"success":true}

6.5 Callback notification URL

*** Log in to the backstage of the merchant to configure the unified callback address (manually specify the callback UR address in the order, which has a higher priority than the uniformly configured callback address. For example, if the notifyUrl parameter is specified in the order, it will be used regardless of whether there is a unified configuration of the callback notification address. notifyUrl address in the order)***

Note that the http response status_code has the highest priority, as long as the response status_code=200 is received, the response data will be ignored

7. Public response code

filed	Type	Default value and comment
code	String	Success "200" For others, please refer to failure code
success	Bool	success true, failure false, and code to keep the meaning of synchronization
msg	String	The textual description returned by the first-level code
data	Object	Reference interface list chapter

8. Failure code

Code	Desc
200	Success
300	Parameter exception
301	IP Unauthorized
307	Signature error
500	System Error