# Mexico 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/mex/bankTransfers/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": "40.20",
	"channelType": "BANK",
	"externalOrderId": "354997490558818072",
	"name": "abc",
	"email": "[email protected]",
	"phone": "13178968534",
	"notifyUrl": "http://192.168.1.135:30001/",
	"remark": "123",
	"returnUrl": "http://192.168.1.135:30001",
    "dynamicAmountNotify":1
}

Description of request parameters

Param Desc Sample Require
amount Receipt amount, the decimal point cannot exceed 2 digits and the amount cannot be less than 40 (String) 40.20 required
channelType payment type (String) oneof=BANK OXXO CASH Choose one of the three parameters based on the actual situation, BANK,OXXO or CASH required
externalOrderId Merchant order number max=64 (String) 354997490558818072 required
name name max=32 (String) bob optional
email email address (String) [email protected] optional
phone phone number (String) 13178968584 optional
dynamicAmountNotify Enable dynamic amount callback (int64) 1- enable, 2- disable. If this field is not provided, default to 1 1 optional
notifyUrl notification URL (String, URL) http://192.168.1.135:30001 optional
remark remark max=255 (String) 123 optional
returnUrl return URL (String, URL) http://192.168.1.135:30001 optional

response type

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

response data

{
"code": "200",
"success": true,
"msg": "Success",
"msgEn": "SUCCESS",
"data": {
"cashierUrl": "http://192.168.1.74:88/OCURRPAID202307140712051689318725469DOCKER020000000200000167",
"currency": "MXN",
"currencyOrderVo": {
"orderId": "OCURRPAID202307140712051689318725535DOCKER020000000400000168",
"externalOrderId": "354997490558818072",
"currency": "MXN",
"amount": "40.2",
"tradeNote": "123"
}
}
}

Response parameter description

Param Type Desc
cashierUrl String cashier link
currency String currency code
amount String Receipt amount
externalOrderId String Merchant order ID
orderId String System order ID
tradeNote String Note

# 5.3 Create a new transfer order

request method

post

Request URL

/api/v3/mex/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": "40.20",
	"channelType": "BANK",
	"externalOrderId": "687279463984441035",
	"accountName": "abc",
	"accountId": "131789685841234567",
	"bankName": "AZTECA2",
	"accountType": "CLABE",
	"notifyUrl": "http://192.168.1.135:30001",
	"remark": "123"
}

Description of request parameters

Param Desc Sample Require
currencyAmount Payment amount The decimal cannot be greater than 2 and the amount cannot be less than 40 (String) 40.20 required
channelType payment type (String) BANK required
externalOrderId Merchant order number max=64 (String) 687279463984441035 required
accountType bank account type oneof=CLABE BANK_CARD (String) CLABE BANK_CARD Choose one of the two parameters according to the actual situation required
accountName bank account name (String) bob required
accountId Recipient account (String) CLABE type account consists of 18 digits, BANK_CARD type account consists of 16 digits 131789685841234567 required
bankName bank name (String) AZTECA2 Fill in according to the actual situation required
remark remark max=255 (String) 123 optional
notifyUrl notification URL (String) http://192.168.1.135:30001 optional

response type

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

response data

{
"code": "200",
"success": true,
"msg": "Success",
"msgEn": "SUCCESS",
"data": {
"orderId": "OCURRDRAW202307140712081689318728627DOCKER020000000200000169",
"orderStatus": "Accepted",
"externalOrderId": "687279463984441035",
"currencyType": "MXN"
}
}

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/mex/bankTransfers/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": "241534072867503522",
     "orderId": "OCARDDEPO202306090256051686279365706DOCKER020000000200001399"
}

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": "OCURRPAID202307140712051689318725535DOCKER020000000400000168",
"cashierId": "OCURRPAID202307140712051689318725469DOCKER020000000200000167",
"orderType": 1,
"orderResourceType": 2,
"userId": "1663371399710216194",
"orderStatus": 1,
"orderTime": 1689318726000,
"channelOrderId": "20230714071207439140854557",
"externalOrderId": "354997490558818072",
"orderAmount": "40.2",
"orderActualAmount": null,
"orderFee": null,
"orderPayTime": null,
"orderCompleteTime": null,
"currencyType": "MXN",
"payType": 102,
"tradeNote": "123",
"notifyUrl": "http://192.168.1.135:30001/",
"markStatus": 0,
"errorMsg": "",
"errorMsgEn": "",
"accountType": "",
"accountName": "",
"accountNo": "",
"orderTypeCode": "Pay",
"orderResourceTypeCode": "Currency",
"orderStatusCode": "Accepted",
"payTypaCode": "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 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 orderStatusc Description
payTypaCode String payment type code reference payType

# 5.5 Query transfer orders

request method

post

Request URL

/api/v3/mex/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": "241534072867503522",
     "orderId": "OCARDDEPO202306090256051686279365706DOCKER020000000200001399"
}

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": "OCURRDRAW202307170821151689582075477DOCKER020000000200000233",
"cashierId": "",
"orderType": 2,
"orderResourceType": 2,
"userId": "1663371399710216194",
"orderStatus": 1,
"orderTime": 1689582076000,
"channelOrderId": "",
"externalOrderId": "979744221460536657",
"orderAmount": "40.2",
"orderActualAmount": "41",
"orderFee": "0.8",
"orderPayTime": null,
"currencyType": "MXN",
"payType": 202,
"tradeNote": "123",
"notifyUrl": "http://192.168.1.135:30001",
"markStatus": 0,
"errorMsg": "",
"errorMsgEn": "",
"accountType": "40",
"accountName": "AZTECA2",
"accountNo": "13178968534",
"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 not accepted)
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 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/mex/query/balance

request type

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

request header

Param Desc Sample
access_key Merchant background acquisition pFqV75X3
timestamp Unix timestamp 13 digit milliseconds 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign computed signature kAXyh+eerqrefyaF8dyFB0M4FVo=

response type

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

response data

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

Response parameter description

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

# 5.7 Query Bank

request method

POST

Request URL

/api/v3/mex/query/bank

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

{"bankName": "AZTECA2"}

If you need to query all bank values, pass an empty string, as follows:

{"bankName": ""}

Description of request parameters

Param Desc Require
bankName bank name (String) required

response type

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

response data

{
    "code": "200",
    "success": true,
    "msg": "Success",
    "msgEn": "SUCCESS",
    "data": [{
    "bankName": "AZTECA2",
    "bankCode": "91927",
    "currencyType": "MXN"
	}]
}

Response parameter description

Param Type Desc
bankName String bank name
bankCode String bank code
currencyType String currency type

# 5.8 Banks List

BankName BankName
BANCOMEXT BANOBRAS
BANJERCITO NAFIN
BANSEFI HIPOTECARIA FED
BANAMEX BBVA MEXICO
SANTANDER HSBC
BAJIO INBURSA
MIFEL SCOTIABANK
BANREGIO INVEX
BANSI AFIRME
BANORTE BANK OF AMERICA
MUFG JP MORGAN
BMONEX VE POR MAS
CREDIT SUISSE AZTECA
AUTOFIN BARCLAYS
COMPARTAMOS MULTIVA
ACTINVER INTERCAM BANCO
BANCOPPEL ABC CAPITAL
CONSUBANCO VOLKSWAGEN
CIBANCO BBASE
BANKAOOL PAGATODO
INMOBILIARIO DONDE
BANCREA BANCO FINTERRA
ICBC SABADELL
SHINHAN MIZUHO BANK
BANCO S3 MONEXCB
GBM MASARI
VALUE VECTOR
MULTIVA CBOLSA FINAMEX
VALMEX PROFUTURO
CB INTERCAM CI BOLSA
FINCOMUN AKALA
REFORMA STP
EVERCORE CREDICAPITAL
KUSPIT UNAGRA
ASP INTEGRA OPC LIBERTAD
CAJA POP MEXICA CRISTOBAL COLON
CAJA TELEFONIST TRANSFER
FONDO (FIRA) INVERCAP
FOMPED INDEVAL
CoDi Valida ARCUS
BANAMEX2 ABC CAPITAL
ACTINVER AFIRME
AKALA ARCUS
ASP INTEGRA OPC AUTOFIN
AZTECA BAJIO
BANAMEX BANAMEX2
BANCO FINTERRA BANCO S3
BANCOMEXT BANCOPPEL
BANCREA BANJERCITO
BANK OF AMERICA BANOBRAS
BANREGIO BANSEFI
BANSI BARCLAYS
BBASE BBVA MEXICO
BMONEX CAJA POP MEXICA
CAJA TELEFONIST CB INTERCAM
CI BOLSA CIBANCO
CoDi Valida COMPARTAMOS
CONSUBANCO CREDICAPITAL
CREDIT SUISSE CRISTOBAL COLON
DONDE EVERCORE
FINAMEX FINCOMUN
FOMPED FONDO (FIRA)
GBM HIPOTECARIA FED
HSBC ICBC
INBURSA INDEVAL
INMOBILIARIO INTERCAM BANCO
INVERCAP INVEX
JP MORGAN KUSPIT
LIBERTAD MASARI
MIFEL MIZUHO BANK
MONEXCB MUFG
MULTIVA BANCO MULTIVA CBOLSA
NAFIN PAGATODO
PROFUTURO REFORMA
SABADELL SANTANDER
SCOTIABANK SHINHAN
STP TACTIV CB
TRANSFER UNAGRA
VALMEX VALUE
VE POR MAS VECTOR
VOLKSWAGEN AZTECA2
BANORTE2 HSBC2
SANTANDER2 BBVA BANCOMER2

# 6. Callback information

# 6.1 How to call back the interface for signature verification

# Signature Verification Instructions

API requests are likely to be tampered with during transmission over the internet. In order to ensure that the callback has not been changed, you can set the 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, but the data used for signature verification 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 signature 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": "MXN",
"errorMsg": "",
"errorMsgEn": "",
"externalOrderId": "93960348",
"markStatus": 0,
"orderActualAmount": 50.000000,
"orderAmount": 50.000000,
"orderFee": 5.000000,
"orderId": "OCURRPAID202307130850471689238247122DOCKER020000000400000103",
"orderPayTime": 1689238357000,
"orderStatus": "Payment success",
"orderStatusCode": 2,
"orderTime": 1689238247000,
"payParam": "https://business.h5.cashfastpay.com/payment/20230713085049310135132143?amount=50&currency=MXN",
"payType": 102,
"payTypeName": "BANK",
"tradeNote": "wsx12312"
}

Callback data description

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

Merchants can log in to the backstage of the merchant at any time to manually trigger callbacks (manual callbacks are not recommended for non-final orders), and the order status and other related information in the callback information is the real actual status (please pay attention to the order status for manual callbacks, 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 the redundant processing at the business level)

# 6.3 transfer callback

callback data

{
"currencyType": "MXN",
"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 Normal
300 Parameter exception
301 IP Unauthorized
307 Signature error
500 System Error