订单批量查询接口

server_type值 batch_special_query_order_info
接口返回的订单数据为敏感数据，会对全部数据进行加密

Request

Body Params application/json

serial_number

string

请求流水号

required

每个请求必须上送唯一的流水号。流水号生成规程参考下文说明。

merchant_number

string

商户号

required

由易思汇提供。

sub_merchant_number

string

二级商户号

required

由易思汇提供

server_type

enum<string>

服务类型

required

不同的接口传递服务类型值不一样。

Allowed value:

batch_special_query_order_info

version

string

版本号

required

默认2.0.0。

callback_process

integer

optional

是否需要特殊处理，具体请联系易思汇

data

object

required

Json字符串，不同接口的data内容不一样，详细参考每个接口文档说明。

merchant_user_key

string

商户用户唯一标识key

optional

如果有值就查询该用户的订单信息

<= 200 characters

order_id_list

array[string]

订单列表

required

批量查询订单数据，最大100笔

sensitive_data

object

required

敏感数据，Json格式。接口需要返回敏感数据，会在接口中请求参数中特殊说明，没有值的时候传递空字符串。加密流程参考接口加解密步骤

sign

string

签名

optional

如果不使用易思汇提供的验签方式，需要双方协商讨论验签方式。签名流程参考接口加解密步骤。

return_info

string

optional

比如调用时候传递这个值为1，返回时候会也有一个这个字段返回1。

extend_info

string

扩展信息

optional

默认为空。

aeskey

string

aes的Key

optional

用于aes加密，key和iv是同一个值，需加密。加密流程参考接口加解密步骤。如果没有不需要加密则值为空

Example

{
    "serial_number": "string",
    "merchant_number": "string",
    "sub_merchant_number": "string",
    "server_type": "batch_special_query_order_info",
    "version": "string",
    "callback_process": 0,
    "data": {
        "merchant_user_key": "string",
        "order_id_list": [
            "string"
        ]
    },
    "sensitive_data": {},
    "sign": "string",
    "return_info": "string",
    "extend_info": "string",
    "aeskey": "string"
}

Request samples

Python

Shell

JavaScript

Java

Swift

PHP

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Body

status_code

string

状态码

required

000000：表示返回成功具体参考状态码说明。

>= 6 characters<= 6 characters

Example:

000000

message

string

描述说明

required

例如：请求成功。

>= 0 characters<= 100 characters

count

integer

数量

optional

下文data为一个列表，表示data列表里的长度。

data

array [object]

具体数据

required

Json格式, 列表。不同接口返回的data内容不一样，详细参考每个接口说明。

sensitive_data

array [object {29}]

敏感数据加密后的数据解密请参考易思汇加解密文档

required

Json格式, 列表。接口需要返回敏感数据，会在接口中返回参数中特殊说明，如果没有敏感数据字段为空，不需要处理

order_id

string

易思汇订单号

required

易思汇唯一订单号。

order_status

integer

订单状态

required

具体查看常量说明的订单状态说明。

institution_code

string

机构code/公寓

optional

机构code/公寓

<= 20 characters

institution_name

string

机构名/公寓名

required

机构名/公寓名

<= 200 characters

merchant_order_id

string

商户订单号

required

商户自己的订单号，这个订单号必须保证唯一。

<= 50 characters

country_code

string

国家code

optional

具体查看常量说明country_code国家代码说明。

<= 5 characters

currency_code

string

下单货币code

optional

具体查看常量说明currency_code货币代码说明。

<= 5 characters

tuition

number

总费用（外币）

required

如果商户服务费的币种跟总费用的币种一致时： tuition=merchant_service_fee+order_tuition,不一致时：tuition=order_tuition。

merchant_service_fee

number

商户服务费

optional

merchant_service_fee_currency_code

string

商户服务费的货币code

optional

币种默认总费用币种，支持人民币和下单货币code。

<= 5 characters

order_tuition

number

订单金额（外币）

optional

如果没有商户服务费，那这个金额等于总费用字段，币种默认总费用币种。

first_name_en

string

学生的英文名

optional

学生的英文名。

<= 50 characters

last_name_en

string

学生的英文姓

optional

学生的英文姓。

<= 50 characters

name_ch

string

用户中文名

optional

如果没有可以不用传。

<= 20 characters

student_id_number

string

学生证件号码

required

学生身份证号码或者护照等。

<= 20 characters

student_tel_code

string

区号

optional

区号,默认+86。

<= 10 characters

student_mobile

string

手机号

required

手机号

<= 15 characters

student_email

string

学生邮件

optional

学生邮件

<= 50 characters

student_address

string

付款人地址

required

学生的国内地址

<= 300 characters

school_name

string

学校名

optional

学生所在学校

<= 200 characters

wechat_number

string

微信号

optional

微信号，没有则不填。

<= 100 characters

fee_type_list

array [object {2}]

付款用途列表

required

具体查看常量说明fee_type缴费类型说明，fee_type_desc固定传空，具体查看下面fee_type_list格式说明。

status_change_notify_url

string

订单状态异步通知地址

optional

与notify_url 作用类似，目前订单关闭汇款确认中会通知这个URL

is_upload_attachment

boolean

是否上传附件

required

布尔类型。true是已上传，false是未上传

remittance_voucher_url

string

汇款凭证URL

optional

汇款凭证URL

attachment_list

array [object {3}]

optional

tuition_rmb_list

array [object {5}]

required

city_name_en

string

城市英文名

optional

公寓所在城市英文名

<= 200 characters

city_name_cn

string

城市中文名

optional

公寓所在城市中文名

<= 200 characters

return_info

string

预留返回信息

required

如果请求的时候传递这个参数的话，返回时候会原值返回。

extend_info

string

扩展信息，预留使用

required

sign

string

签名

required

如果不使用易思汇提供的验签方式，需要双方协商讨论验签方式。

aeskey

string

aes加密的key

required

用于aes加密，key和iv是同一个值，需加密。加密流程参考接口加解密步骤。如果没有不需要加密则值为空

Example

{
    "status_code": "000000",
    "message": "string",
    "count": 0,
    "data": [
        {}
    ],
    "sensitive_data": [
        {
            "order_id": "string",
            "order_status": 0,
            "institution_code": "string",
            "institution_name": "string",
            "merchant_order_id": "string",
            "country_code": "strin",
            "currency_code": "strin",
            "tuition": 0,
            "merchant_service_fee": 0,
            "merchant_service_fee_currency_code": "strin",
            "order_tuition": 0,
            "first_name_en": "string",
            "last_name_en": "string",
            "name_ch": "string",
            "student_id_number": "string",
            "student_tel_code": "string",
            "student_mobile": "string",
            "student_email": "string",
            "student_address": "string",
            "school_name": "string",
            "wechat_number": "string",
            "fee_type_list": [
                {
                    "fee_type": 0,
                    "fee_type_desc": "string"
                }
            ],
            "status_change_notify_url": "string",
            "is_upload_attachment": true,
            "remittance_voucher_url": "string",
            "attachment_list": [
                {
                    "id": 0,
                    "attachment_type": 0,
                    "attachment_url": "string"
                }
            ],
            "tuition_rmb_list": [
                {
                    "pay_type": 1,
                    "tuition_rmb": 0,
                    "counter_fee": 0,
                    "payment_id": 0,
                    "expire_datetime": "string"
                }
            ],
            "city_name_en": "string",
            "city_name_cn": "string"
        }
    ],
    "return_info": "string",
    "extend_info": "string",
    "sign": "string",
    "aeskey": "string"
}