报关查询接口

更新时间:2017/06/23 访问次数:13423

请求参数说明

请求参数是商户在与支付宝进行数据交互时,提供给支付宝的请求数据,以便支付宝根据这些数据进一步处理。

参数

参数名称

类型(字节长度)

参数说明

是否可为空

样例

基本参数

service

接口名称

String

接口名称。

不可空

alipay.overseas.acquire.customs.query

partner

合作者身份ID

String(16)

签约的支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

不可空

2088101568338364

_input_charset

参数编码字符集

String

商户网站使用的编码格式,如UTF-8、GBK、GB2312等。

不可空

UTF-8

sign_type

签名方式

String

DSA、RSA、MD5三个值可选,必须大写。

不可空

MD5

sign

签名

String

请参见本文档“附录:签名与验签”。

不可空

b7baf9af3c91b37bef4261849aa76281

业务参数

out_request_nos

报关请求号

String(329)

需要查询的商户端报关请求号,支持批量查询,多个值用英文半角逗号分隔,单次最多10个报关请求号;

每个报关请求号长度6~32位,前后不能有空格且仅允许传入以下类型字符:数字、英文字母、“_”、“-”、“:”。

不可空

201506010001,201506010002,201506010003

https://mapi.alipay.com/gateway.do?out_request_nos=201506010001%2C201506010002%2C201506010003&sign_type=MD5&sign=b7baf9af3c91b37bef4261849aa76281&_input_charset=UTF-8&service=alipay.overseas.acquire.customs.query&partner=2088101568338364

说明:
本样例仅供参考,支付宝网关为https://mapi.alipay.com/gateway.do

同步返回参数说明

支付宝对商户提供的请求数据进行处理后,返回给商户结果数据,以便商户根据这些数据进一步处理。

返回结果分两种场景,一种为业务正常受理的结果,一种为系统级异常或者接入数据错误。对于业务正常受理,商户需要解析响应码以判断业务是否处理成功。

参数

参数名称

类型(长度范围)

参数说明

是否可为空

样例

基本参数

is_success

请求是否成功

String

请求是否成功。请求成功不代表业务处理成功。

  • T代表成功
  • F代表失败

不可空

T

sign_type

签名方式

String

DSA、RSA、MD5三个值可选,必须大写。

可空

MD5

sign

签名

String

请参见本文档“附录:签名与验签”。

可空

3afc92ac4708425ab74ecb2c4e58ef56

error

错误代码

String

  • 请求成功时,不存在本参数;
  • 请求失败时,本参数为错误代码。

可空

ILLEGAL_SIGN

业务参数

result_code

响应码

String(32)

处理结果响应码。

  • SUCCESS:成功
  • FAIL:失败

不可空

SUCCESS

not_found

未查询到的报关请求号

String

业务处理成功(result_code=SUCCESS)但存在未查询到的报关请求号时,才会返回该参数,多个值用英文半角逗号分隔。

可空

201506010001

detail_error_code

详细错误码

String(48)

对返回响应码进行原因说明,请参见业务错误码

当result_code响应码为SUCCESS时,不返回该参数。

可空

INVALID_PARAMETER

detail_error_des

详细错误描述

String(64)

对详细错误码进行文字说明,请参见业务错误码中的“含义”。

当result_code响应码为SUCCESS时,不返回该参数。

可空

报关单参数不合法

<customs_declare>查询到的报关单信息,xml节点,可能存在多个

out_request_no

报关请求号

String(32)

商户端报关请求号,对应入参中的某条报关请求号。

可空

4877067126133624

alipay_declare_no

支付宝报关号

String(64)

支付宝报关流水号。

可空

2015082011082370647505271

trade_no

支付单据号

String(64)

支付宝推送到海关的支付单据号。针对拆单的报关请求,这个单据号不等于支付宝原始交易号。

可空

2015082011082370647505271

customs_place

海关编号

String(20)

海关编号

可空

hangzhou

merchant_customs_code

商户备案号

String(20)

商户在海关备案的编号。

可空

code

merchant_customs_name

商户备案名

String(256)

商户海关备案的名称。

可空

1

amount

报关金额

String(20)

报关金额,单位为人民币“元”,精确到小数点后2位。

可空

1.00

is_split

是否拆单

String(1)

  • T:拆单
  • F:非拆单

可空

T

sub_out_biz_no

拆单时商户子订单号

String(32)

商户子订单号。拆单时由商户传入,且拆单时必须传入。

可空

999999999999999

status

当前状态

String(10)

该报关单当前的状态。

  • ws:等待发送海关
  • sending:已提交发送海关
  • succ:海关返回受理成功

可空

succ

memo

备注

String(256)

备注说明。

可空

海关返回参数非法

last_modified_time

最后更新时间

String(20)

状态最后更新时间。

可空

2015-10-15 14:24:56

customs_code

海关返回结果码

String

发起报关后,海关返回回执中的结果码。

  • 2:支付单新增申报成功
  • 120:海关入库
  • 小于0的数字:表示处理异常回执

注意:

支付宝原样返回海关返回的数据,参数值以海关的定义为准。

可空

2

customs_info

海关返回结果描述

String

发起报关后,海关返回回执中的结果描述信息。

可空

支付单新增申报成功[201508201108237064750527108112833]

customs_return_time

海关回执时间

String

发起报关后,海关返回回执的时间,格式为:yyyyMMddHHmmss。

可空

20160414142358

说明:
同步返回的参数随支付宝服务端的演化,可能会返回更多的节点,需要程序使用方对文档说明以外的节点予以忽略。

  • 查询成功返回样例
<?xml version="1.0" encoding="utf-8"?>
<alipay>
    <is_success>T</is_success>
    <request>
        <param name="sign">eb9ece9d658e7a9671411d1b43b5750c</param>
        <param name="_input_charset">UTF-8</param>
        <param name="sign_type">MD5</param>
        <param name="service">alipay.overseas.acquire.customs.query</param>
        <param name="out_request_nos">4877067126133624,7665166179649532</param>
        <param name="partner">2088101143686350</param>
    </request>
    <response>
        <alipay>
            <records>
                <customs_declare>
                    <alipay_declare_no>2015082011082370647505271</alipay_declare_no>
                    <amount>1.00</amount>
                    <is_split>T</is_split>
                    <sub_out_biz_no>999999999999999</sub_out_biz_no>
                    <customs_place>hangzhou</customs_place>
                    <last_modified_time>2015-10-15 14:24:56</last_modified_time>
                    <memo/>
                    <merchant_customs_code>code</merchant_customs_code>
                    <merchant_customs_name>1</merchant_customs_name>
                    <out_request_no>4877067126133624</out_request_no>
                    <status>succ</status>
                    <trade_no>2015082011082370647505271</trade_no>
                    <customs_code>2</customs_code>
                    <customs_info>新增申报成功[B0B2F23E-2CF6-434D-9F24-8931B835A056]</customs_info>
                    <customs_return_time>20160414142358</customs_return_time>
                </customs_declare>
                <customs_declare>
                    <alipay_declare_no>2015081811082379147506255</alipay_declare_no>
                    <amount>1.00</amount>
                    <customs_place>henan</customs_place>
                    <last_modified_time>2015-10-15 14:24:56</last_modified_time>
                    <memo/>
                    <merchant_customs_code>code</merchant_customs_code>
                    <merchant_customs_name>name</merchant_customs_name>
                    <out_request_no>7665166179649532</out_request_no>
                    <status>succ</status>
                    <trade_no>2015081710650237</trade_no>
                    <customs_code>2</customs_code>
                    <customs_info>新增申报成功[B0B2F23E-2CF6-434D-9F24-8931B835A056]</customs_info>
                    <customs_return_time>20160414142358</customs_return_time>
                </customs_declare>
            </records>
            <result_code>SUCCESS</result_code>
        </alipay>
    </response>
    <sign>15669c65f3d19d0691425bba349a8b55</sign>
    <sign_type>MD5</sign_type>
</alipay>
  • 请求成功,业务处理失败返回样例
<?xml version="1.0" encoding="utf-8"?>
<alipay>
    <is_success>T</is_success>
    <request>
        <param name="sign">48201072f0d0991c3bab798d963c6cd8</param>
        <param name="_input_charset">UTF-8</param>
        <param name="sign_type">MD5</param>
        <param name="service">alipay.overseas.acquire.customs.query</param>
        <param name="out_request_nos">4877067126133624,7665166179649532,,</param>
        <param name="partner">2088101143686350</param>
    </request>
    <response>
        <alipay>
            <detail_error_code>INVALID_PARAMETER</detail_error_code>
            <detail_error_des>报关单参数不合法</detail_error_des>
            <result_code>FAIL</result_code>
        </alipay>
    </response>
    <sign>48fd2067e7fa2a7e779465d9e80dced5</sign>
    <sign_type>MD5</sign_type>
</alipay>
  • 请求失败或者接入数据错误时返回样例
<?xml version="1.0" encoding="utf-8"?>
<alipay>
    <is_success>F</is_success>
    <error>ILLEGAL_SIGN</error>
</alipay>

同步返回特性

  1. 支付宝处理完商户的请求数据后,当前的支付宝网关页面(https://mapi.alipay.com)会自动刷新,并立刻输出处理结果;
  2. 处理一次请求,当前界面只跳转回来一次,即只返回一次处理结果;
  3. 该步骤可在本机电脑调试,无需到服务器上;
  4. 处理结果显示的格式是XML格式;
  5. 可对这个XML格式的处理结果进行XML远程解析,使之能在支付宝处理结果时获取到相关处理结果数据,并对这个结果界面进行商户的业务逻辑处理;
  6. 本地电脑或商户服务器的配置上需支持XML远程解析,如:需要支持SSL;
  7. 页面跳转后,浏览器地址栏中的链接仅在一分钟内有效,超过一分钟该链接地址会失效,导致该页面中商户编写的业务逻辑程序无法完成处理。

业务错误码

详细错误代码(detail_error_code)

含义(detail_error_des)

INVALID_PARAMETER

参数格式不合法:超过350个字符、空、某个单号为空或某个单号超过32个字符

MAX_OUT_REQUEST_NO_EXCEEDED

单次请求的报关单号超过10个

FAQ

关于此文档暂时还没有FAQ
返回
顶部