Open API
English
  • English
  • 简体中文
API DOC
API DOC
English
  • English
  • 简体中文
  1. Open API
  • Open API
    • Document Revision History
    • Overview of Study Abroad Payment API Access
    • API Call Address
    • Request for serial number generation instructions
    • API Request Parameter Description
    • API Response Parameter Description
    • Interface encryption and signing steps
    • Interface decryption and verification process
    • Constant Description
      • pay_type description
      • order_status description
      • status_code description
      • fee_type description
      • attachment_type description
      • country_code description
      • currency_code description
      • Gender Description
      • ID type Description
    • API
      • Order interface
      • Attachment upload interface
      • Interface for obtaining payment address
      • Order batch query interface
    • Asynchronous notification description v1
      • [Successful Payment] Asynchronous notification parameter description for successful payment
      • Explanation of Asynchronous Notification Signature Generation Process
    • Asynchronous notification description v2
      • Asynchronous Notification Description
      • Asynchronous Notification Signature Generation Process
      • [Order Status Change] Asynchronous notification parameter description for order status change
  1. Open API

API Response Parameter Description

Respond to fixed JSON templates:
{
    "status_code": "000000",
    "message": "string",
    "count": 0,
    "data": "[]",
    "sensitive_data": "[]",
    "return_info": "string",
    "extend_info": "string",
    "sign": "String",
    "aeskey": "String"
}
Response parameter description#
Data and Sensitive_ Both data parameters are in JSON format, sensitive_ Data is the ciphertext of sensitive data
Parameter NameTypeDescription
status_codeStringStatus code, default to 000000: indicates successful return. Please refer to the following status code description for details.
messageStringDescribe and explain, for example: success.
countIntThe following data is a list that represents the length in the data list.
dataJsonThe list in JSON format has different data contents returned by different interfaces. Please refer to the specific interface instructions below for details.
sensitive_dataJsonList in JSON format. The interface needs to return sensitive data, and special instructions will be provided in the parameters returned in the interface
return_infoStringIf this parameter is passed during the request, it will be returned with the original value.
extend_infoStringExtended information, reserved for use
signStringIf the signature verification method provided by Yisihui is not used, both parties need to negotiate and discuss the verification method. Signature process reference interface encryption and decryption steps
aeskeyStringUsed for AES encryption, key and iv are the same value and need to be encrypted. The encryption process refers to the encryption and decryption steps of the interface. If no encryption is required, the value is empty
Modified at 2023-12-21 06:24:13
Previous
API Request Parameter Description
Next
Interface encryption and signing steps
Built with