Order interface - Open API

The server_type value is add_special_rent_order.
Please note that if an unpaid order is not paid within 7 days, it will be closed and the merchant will need to place the order again.

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:

add_special_rent_order

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.

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

institution_code

string

Institution code

required

The institution code of the school/apartment. If there is a code, it is not necessary to pass the apartment name. If there is no code, the apartment name must be passed

institution_name

string

Institution name/ Apartment name

required

Institution name/ Apartment name，The old field 'apartment_name' is deprecated

merchant_order_id

string

Merchant order number

required

The merchant's own order number must be guaranteed to be unique.

<= 50 characters

merchant_user_key

string

Merchant User Unique Identification Key

required

For example, the user's phone number.

<= 200 characters

country_code

string

Country code

optional

For details, see the constant description country_code.

<= 5 characters

currency_code

string

Currency code

optional

Currency of the order, Please refer to the constant description and currency code description for details.

source_country_code

string

source country code

optional

Default is China. Please refer to the constant description for country code details.

price_mode

integer

Pricing Model

optional

The default pricing mode is the default mode. 1: Default mode, 2: Merchant self pricing mode. If it is mode 1, the currency in the position field is the same as the ordering currency. If it is mode 2, the pricing mode is negotiated with the merchant

tuituon

number

tuition(Currency of the order)

required

If the currency of the merchant service fee is the same as the currency of the total fee: tuition=merchant_service_fee+order_tuition, otherwise: tuition=order_tuition

pay_currency_code

string

Payment currency code

optional

Default RMB, please refer to the constant description for currency_ Code country code description. If the pricing mode is the default mode, this field is empty

merchant_service_fee

number

Merchant service fee

optional

merchant_service_fee_currency_code

string

Currency code of merchant service fee

optional

Currency is set by the total fee currency by default, with support for both Chinese yuan and the order currency code

order_tuition

number

order tuition(Currency of the order)

required

If there is no merchant service fee, the amount is equal to the total fee field, and the currency is set by the total fee currency by default

first_name_en

string

first_name

optional

Student's English name

middle_name_en

string

middle_name

optional

Middle name of student

last_name_en

string

last_name

optional

Student's English surname

name_ch

string

Chinese name

optional

If there is no Chinese name, there is no need to pass it on

student_id_number

string

Student ID number

required

Student ID card number or passport, etc

id_type

integer

ID Type

required

Student ID type, default ID card, please refer to the constant description for details

student_tel_code

string

Tel Code

required

Tel Code default +86

student_mobile

string

Mobile

required

Mobile

student_email

string

Student Email

optional

Student Email

student_address

string

Student address

optional

Student address

school_name

string

School

optional

School

wechat_number

string

Wechat Number

optional

WeChat Number (leave blank if not available)

invoice_number

string

Invoice Number

optional

Invoice Number

fee_type_list

array [object {2}]

Payment Purpose List

required

For details, see the description of the constant fee_type, which is a fixed null value. For details, see the description of the format of the fee_type_list below.

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.

status_change_notify_url

string

Order status change asynchronous notification address

optional

When the order status changes, the change status is sent to this address. (POST method)

back_jump_url

string

Jump address

optional

After entering our payment results page, click return to return to this address.

back_page_url

string

Jump to page address

optional

Click the fallback button on the page to return to the merchant page

appid

string

The appid of the merchant's WeChat mini program

optional

If the redirect URL is the mini program URL, this parameter needs to be passed.

city_name_en

string

City English name

optional

English name of the city where the student is located

city_name_ch

string

Chinese name of the city

optional

The Chinese name of the student's city, if not, do not fill in

data_of_birth

string

date of birth

optional

Date of birth, format: 2019-08-01

gender

integer

gender

optional

Please refer to the gender description in the constant description for details

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": "add_special_rent_order",
    "version": "string",
    "callback_process": 0,
    "data": {},
    "sensitive_data": {
        "institution_code": "string",
        "institution_name": "string",
        "merchant_order_id": "string",
        "merchant_user_key": "string",
        "country_code": "strin",
        "currency_code": "string",
        "source_country_code": "string",
        "price_mode": 0,
        "tuituon": 0,
        "pay_currency_code": "string",
        "merchant_service_fee": 0,
        "merchant_service_fee_currency_code": "string",
        "order_tuition": 0,
        "first_name_en": "string",
        "middle_name_en": "string",
        "last_name_en": "string",
        "name_ch": "string",
        "student_id_number": "string",
        "id_type": 0,
        "student_tel_code": "string",
        "student_mobile": "string",
        "student_email": "string",
        "student_address": "string",
        "school_name": "string",
        "wechat_number": "string",
        "invoice_number": "string",
        "fee_type_list": [
            {
                "fee_type": "string",
                "fee_type_desc": "string"
            }
        ],
        "notify_url": "string",
        "status_change_notify_url": "string",
        "back_jump_url": "string",
        "back_page_url": "string",
        "appid": "string",
        "city_name_en": "string",
        "city_name_ch": "string",
        "data_of_birth": "string",
        "gender": 0
    },
    "sign": "string",
    "aeskey": "string",
    "extend_info": "string",
    "return_info": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 {4}]

Data

required

Json format, list. The data content returned by different interfaces is different. Please refer to the description of each interface for details.

order_id

string

ET order id

required

ET order id

pay_config_list

array [object {4}]

required

tuition_rmb

number

optional

Payment of RMB amount in foreign currency (including handling fees)

counter_fee

number

required

The currency of the handling fee is RMB

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": [
        {
            "order_id": "string",
            "pay_config_list": [
                {
                    "pay_url": "string",
                    "pay_type": 0,
                    "appid": "string",
                    "original_id": "string"
                }
            ],
            "tuition_rmb": 0,
            "counter_fee": 0
        }
    ],
    "sensitive_data": [
        {}
    ],
    "return_info": "string",
    "extend_info": "string",
    "sign": "string",
    "aeskey": "string"
}