Open API
首页
首页
  1. 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
      POST
    • Attachment upload interface
      POST
    • Interface for obtaining payment address
      POST
    • Order batch query interface
      POST
  • 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. API

Interface for obtaining payment address

POST
https://api.easytransfer.cn/server
英文
server_type value get_special_pay_url
The payment address will only be returned when the order status is waiting for payment, and an error code of 200003 will be returned for other statuses.

Request

Body Params application/json
serial_number
string 
Request serial number
required
Each request must pass a unique serial number. The rules for generating serial numbers refer to the instructions for generating serial numbers.
merchant_number
string 
Merchant ID
required
Provided by ET
sub_merchant_number
string 
Second level merchant account
required
Provided by ET
server_type
enum<string> 
Service Type
required
Different interfaces pass different values for service types.
Allowed value:
get_special_pay_url
version
string 
Version
required
Default 2.0.0
callback_process
integer 
required
Do you need special treatment? Please contact ET for details
data
object 
required
Json string, the data content varies for different interfaces, please refer to the documentation for each interface for details.
order_id
string 
order id
required
ET Order Id
merchant_user_key
string 
Merchant User Unique Identification Key
required
For example, the user's phone number.
notify_url
string 
Asynchronous notification address
required
After processing, asynchronous notification (POST method) will be sent to this address to determine the result of payment processing.
back_jump_url
string 
Jump address
required
After entering our payment results page, click return to return to this address.
back_page_url
string 
Jump to page address
required
Click the fallback button on the page to return to the merchant page
appid
string 
The appid of the merchant's WeChat mini program
required
If the redirect URL is the mini program URL, this parameter needs to be passed.
sensitive_data
object 
required
Sensitive data in Json format. The interface needs to return sensitive data, and special instructions will be requested in the interface parameters. When there is no value, an empty string will be passed. Encryption process reference interface encryption and decryption steps
sign
string 
required
If the signature verification method provided by Yisihui is not used, both parties need to negotiate and discuss the signature verification method. The signature process refers to the encryption and signature steps of the interface.
aeskey
string 
required
Used 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
extend_info
string 
required
The default is empty.
return_info
string 
required
For example, when calling, if this value is passed as 1, there will also be a field that returns 1.
Example
{
  "serial_number": "string",
  "merchant_number": "string",
  "sub_merchant_number": "string",
  "server_type": "get_special_pay_url",
  "version": "string",
  "callback_process": 0,
  "data": {
    "order_id": "string",
    "merchant_user_key": "string",
    "notify_url": "string",
    "back_jump_url": "string",
    "back_page_url": "string",
    "appid": "string"
  },
  "sensitive_data": {},
  "sign": "string",
  "aeskey": "string",
  "extend_info": "string",
  "return_info": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.easytransfer.cn/server' \
--header 'Content-Type: application/json' \
--data-raw '{
    "serial_number": "string",
    "merchant_number": "string",
    "sub_merchant_number": "string",
    "server_type": "get_special_pay_url",
    "version": "string",
    "callback_process": 0,
    "data": {
        "order_id": "string",
        "merchant_user_key": "string",
        "notify_url": "string",
        "back_jump_url": "string",
        "back_page_url": "string",
        "appid": "string"
    },
    "sensitive_data": {},
    "sign": "string",
    "aeskey": "string",
    "extend_info": "string",
    "return_info": "string"
}'

Responses

🟢200成功
application/json
Body
status_code
string 
Status Code
required
"000000: Indicates a successful return. Please refer to the status code explanation for further details."
>= 6 characters<= 6 characters
Example:
000000
message
string 
Message
required
For example, the request was Request successful
>= 0 characters<= 100 characters
count
integer 
Count
optional
The following data is a list representing the length of the data list.
data
array [object {1}] 
Data
required
Json format, list. The data content returned by different interfaces is different. Please refer to the description of each interface for details.
pay_config_list
array [object {4}] 
required
sensitive_data
array [object] 
Sensitive Data
required
Json format, list. The interface needs to return sensitive data, and will return special instructions in the parameters. If there are no sensitive data fields, there is no need to process.
return_info
string 
return_info
required
If this parameter is passed when requesting, the original value will be returned when returning.
extend_info
string 
Extend Info
required
Expand information and reserve for use
sign
string 
Sign
required
If you do not use the verification method provided by Easihub, you need to discuss the verification method with both parties.
aeskey
string 
aes encryption key
required
For aes encryption, the key and iv are the same value and need to be encrypted. Refer to the interface encryption and decryption steps for the encryption process. If there is no need for encryption, the value is empty
Example
{
  "status_code": "000000",
  "message": "string",
  "count": 0,
  "data": [
    {
      "pay_config_list": [
        {
          "pay_url": "string",
          "pay_type": 0,
          "appid": "string",
          "original_id": "string"
        }
      ]
    }
  ],
  "sensitive_data": [
    {}
  ],
  "return_info": "string",
  "extend_info": "string",
  "sign": "string",
  "aeskey": "string"
}
Previous
Attachment upload interface
Next
Order batch query interface
Built with