通用场景
该接口提供所有支付宝支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
调用支付接口后,返回系统错误或未知交易状态情况;
调用alipay.trade.pay,返回inprocess的状态;
调用alipay.trade.cancel之前,需确认支付状态;
需要调用查询接口的情况:
当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
调用支付接口后,返回系统错误或未知交易状态情况;
调用alipay.trade.pay,返回inprocess的状态;
调用alipay.trade.cancel之前,需确认支付状态;
公共请求参数
业务请求参数
以下参数 二选一 传入
out_trade_nostring(64)
【描述】订单支付时传入的商户订单号,和支付宝交易号不能同时为空。
trade_no,out_trade_no如果同时存在优先取trade_no
【示例值】20150320010101001
trade_nostring(64)
【描述】支付宝交易号,和商户订单号不能同时为空
【示例值】2014112611001004680 073956707
org_pid可选string(16)
【描述】银行间联模式下有用,其它场景请不要使用;
双联通过该参数指定需要查询的交易所属收单机构的pid;
【示例值】2088101117952222
query_options可选string[](128)
【描述】查询选项,商户传入该参数可定制本接口同步响应额外返回的信息字段,数组格式。
【枚举值】
交易结算信息: trade_settle_info
交易支付使用的资金渠道: fund_bill_list
交易支付时使用的所有优惠券信息: voucher_detail_list
【示例值】["trade_settle_info"]
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.trade.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"out_trade_no":"20150320010101001",
"trade_no":"2014112611001004680 073956707",
"org_pid":"2088101117952222",
"query_options":[
"trade_settle_info"
]
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
trade_no必选string(64)
【描述】支付宝交易号
【示例值】2013112011001004330000121536
out_trade_no必选string(64)
【描述】商家订单号
【示例值】6823789339978248
buyer_logon_id必选string(100)
【描述】买家支付宝账号
【示例值】159****5620
trade_status必选string(32)
【描述】交易状态:wait_buyer_pay(交易创建,等待买家付款)、trade_closed(未付款交易超时关闭,或支付完成后全额退款)、trade_success(交易支付成功)、trade_finished(交易结束,不可退款)
【示例值】trade_closed
total_amount必选price(11)
【描述】交易的订单金额,单位为元,两位小数。该参数的值为支付时传入的total_amount
【示例值】88.88
req_goods_detail|支付请求的商品明细列表必选goodsdetail[]
【描述】支付请求的商品明细列表
goods_id必选string(64)
【描述】商品的编号,该参数传入支付券上绑定商品goods_id,
倘若无支付券需要消费,该字段传入商品最小粒度的商品id(如:若商品有sku粒度,则传商户sku粒度的id)
【示例值】apple-01
goods_name必选string(256)
【描述】商品名称
【示例值】ipad
quantity必选number(32)
【描述】商品数量
【示例值】1
price必选price(9)
【描述】商品单价,单位为元
【示例值】2000
alipay_goods_id可选string(32)
【描述】支付宝定义的统一商品编号
【示例值】20010001
goods_category可选string(24)
【描述】商品类目
【示例值】34543238
categories_tree可选string(128)
【描述】商品类目树,从商品类目根节点到叶子节点的类目id组成,类目id值使用|分割
【示例值】124868003|126232002|126252004
body可选string(1000)
【描述】商品描述信息
【示例值】特价手机
show_url可选string(400)
【描述】商品的展示地址
【示例值】http://www.alipay.com/xxx.jpg
out_item_id可选string(100)
【描述】商家侧小程序商品id,指商家提报给小程序商品库的商品。当前接口的extend_params.trade_component_order_id字段不为空时该字段必填,且与交易组件订单参数保持一致。了解小程序商品请参考:https://opendocs.alipay.com/mini/06uila?pathhash=63b6fba7
【示例值】outitem_01
out_sku_id可选string(64)
【描述】商家侧小程序商品id,指商家提报给小程序商品库的商品。当前接口的extend_params.trade_component_order_id字段不为空时该字段必填,且与交易组件订单参数保持一致。了解小程序商品请参考:https://opendocs.alipay.com/mini/06uila?pathhash=63b6fba7
【示例值】outsku_01
period_scene必选string(64)
【描述】该字段用于描述当前账期交易的场景。
【示例值】账期交易的场景。
trans_currency特殊可选string(8)
【描述】标价币种,该参数的值为支付时传入的trans_currency,支持英镑:gbp、港币:hkd、美元:usd、新加坡元:sgd、日元:jpy、加拿大元:cad、澳元:aud、欧元:eur、新西兰元:nzd、韩元:krw、泰铢:thb、瑞士法郎:chf、瑞典克朗:sek、丹麦克朗:dkk、挪威克朗:nok、马来西亚林吉特:myr、印尼卢比:idr、菲律宾比索:php、毛里求斯卢比:mur、以色列新谢克尔:ils、斯里兰卡卢比:lkr、俄罗斯卢布:rub、阿联酋迪拉姆:aed、捷克克朗:czk、南非兰特:zar、人民币:cny、新台币:twd。当trans_currency 和 settle_currency 不一致时,trans_currency支持人民币:cny、新台币:twd
【示例值】twd
settle_currency特殊可选string(8)
【描述】订单结算币种,对应支付接口传入的settle_currency,支持英镑:gbp、港币:hkd、美元:usd、新加坡元:sgd、日元:jpy、加拿大元:cad、澳元:aud、欧元:eur、新西兰元:nzd、韩元:krw、泰铢:thb、瑞士法郎:chf、瑞典克朗:sek、丹麦克朗:dkk、挪威克朗:nok、马来西亚林吉特:myr、印尼卢比:idr、菲律宾比索:php、毛里求斯卢比:mur、以色列新谢克尔:ils、斯里兰卡卢比:lkr、俄罗斯卢布:rub、阿联酋迪拉姆:aed、捷克克朗:czk、南非兰特:zar
【示例值】usd
settle_amount特殊可选price(11)
【描述】结算币种订单金额
【示例值】2.96
pay_currency特殊可选string(8)
【描述】订单支付币种
【示例值】cny
pay_amount特殊可选string(11)
【描述】支付币种订单金额
【示例值】8.88
settle_trans_rate特殊可选string(11)
【描述】结算币种兑换标价币种汇率
【示例值】30.025
trans_pay_rate特殊可选string(11)
【描述】标价币种兑换支付币种汇率
【示例值】0.264
buyer_pay_amount特殊可选price(11)
【描述】买家实付金额,单位为元,两位小数。该金额代表该笔交易买家实际支付的金额,不包含商户折扣等金额
【示例值】8.88
point_amount特殊可选price(11)
【描述】积分支付的金额,单位为元,两位小数。该金额代表该笔交易中用户使用积分支付的金额,比如集分宝或者支付宝实时优惠等
【示例值】10
invoice_amount特殊可选price(11)
【描述】交易中用户支付的可开具发票的金额,单位为元,两位小数。该金额代表该笔交易中可以给用户开具发票的金额
【示例值】12.11
send_pay_date特殊可选date(32)
【描述】本次交易打款给卖家的时间
【示例值】2014-11-27 15:45:57
receipt_amount特殊可选string(11)
【描述】实收金额,单位为元,两位小数。该金额为本笔交易,商户账户能够实际收到的金额
【示例值】15.25
store_id特殊可选string(32)
【描述】商户门店编号
【示例值】nj_s_001
terminal_id特殊可选string(32)
【描述】商户机具终端编号
【示例值】nj_t_001
store_name特殊可选string(512)
【描述】请求交易支付中的商户店铺的名称
【示例值】证大五道口店
buyer_user_id特殊可选string(16)
【描述】买家在支付宝的用户id
新商户建议使用buyer_open_id替代该字段。对于新商户,buyer_user_id字段未来计划逐步回收,存量商户可继续使用。如使用buyer_open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请。
【示例值】2088101117955611
buyer_open_id特殊可选string(128)
【描述】买家支付宝用户唯一标识 详情可查看 openid简介
【示例值】01501o8f93i3njagb1jg4onxtxv25dcn3gec3uggnc4cju0
industry_sepc_detail_gov特殊可选string(4096)
【描述】行业特殊信息-统筹相关
【示例值】{"registration_order_pay":{"brlx":"1","cblx":"1"}}
industry_sepc_detail_acc特殊可选string(4096)
【描述】行业特殊信息-个账相关
【示例值】{"registration_order_pay":{"brlx":"1","cblx":"1"}}
charge_amount特殊可选string(11)
【描述】该笔交易针对收款方的收费金额;单位:元。
只在银行间联交易场景下返回该信息;
【示例值】8.88
charge_flags特殊可选string(64)
【描述】费率活动标识。
当交易享受特殊行业或活动费率时,返回该场景的标识。具体场景如下:
trade_special_00:订单优惠费率;
industry_special_on_00:线上行业特殊费率0;
industry_special_on_01:线上行业特殊费率1;
industry_special_00:线下行业特殊费率0;
industry_special_01:线下行业特殊费率1;
bluesea_1:蓝海活动优惠费率标签;
注:只在机构间联模式下返回,其它场景下不返回该字段;
【示例值】bluesea_1
settlement_id特殊可选string(64)
【描述】支付清算编号,用于清算对账使用;
只在银行间联交易场景下返回该信息;
【示例值】2018101610032004620239146945
trade_settle_info特殊可选tradesettleinfo
【描述】返回的交易结算信息,包含分账、补差等信息。
只有在query_options中指定时才返回该字段信息。
trade_unsettled_amount|剩余待结算金额特殊可选price(9)
【描述】直付通账期、直连账期下返回,其他场景为空,表示一笔订单剩余待结算金额
【示例值】1.1
trade_settle_detail_list可选tradesettledetail[](10)
【描述】交易结算明细信息
operation_type必选string(32)
【描述】结算操作类型。有以下几种类型:
replenish(补差)、replenish_refund(退补差)、transfer(分账)、transfer_refund(退分账)、settle(结算)、settle_refund(退结算)、on_settle(待结算)。
【枚举值】
分账: transfer
退分账: transfer_refund
补差: replenish
【示例值】replenish
operation_dt必选date(32)
【描述】操作日期
【示例值】2019-05-16 09:59:17
amount必选price(11)
【描述】实际操作金额,单位为元,两位小数。该参数的值为分账或补差或结算时传入
【示例值】10.00
operation_serial_no可选string(64)
【描述】商户操作序列号。商户发起请求的外部请求号。
【示例值】2321232323232
trans_out可选string(64)
【描述】转出账号
【示例值】2088111111111111
trans_in可选string(64)
【描述】转入账号
【示例值】2088111111111111
ori_trans_out可选string(64)
【描述】商户请求的转出账号
【示例值】2088111111111111
ori_trans_in可选string(64)
【描述】商户请求的转入账号
【示例值】2088111111111111
auth_trade_pay_mode特殊可选string(64)
【描述】预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:credit_preauth_pay
【枚举值】
信用预授权支付: credit_preauth_pay
【示例值】credit_preauth_pay
buyer_user_type特殊可选string(18)
【描述】买家用户类型。corporate:企业用户;private:个人用户。
【枚举值】
企业用户: corporate
个人用户: private
【示例值】private
mdiscount_amount特殊可选string(11)
【描述】商家优惠金额。单位:元。
【示例值】88.88
discount_amount特殊可选string(11)
【描述】平台优惠金额。单位:元。
【示例值】88.88
subject特殊可选string(256)
【描述】订单标题;
只在银行间联交易场景下返回该信息;
【示例值】iphone6 16g
body特殊可选string(1000)
【描述】订单描述;
只在银行间联交易场景下返回该信息;
【示例值】iphone6 16g
alipay_sub_merchant_id特殊可选string(32)
【描述】间连商户在支付宝端的商户编号;
只在银行间联交易场景下返回该信息;
【示例值】2088301372182171
ext_infos特殊可选string(1024)
【描述】交易额外信息,特殊场景下与支付宝约定返回。
json格式。
【示例值】{"action":"cancel"}
hb_fq_pay_info特殊可选hbfqpayinfo
【描述】若用户使用花呗分期支付,且商家开通返回此通知参数,则会返回花呗分期信息。json格式其它说明详见花呗分期信息说明。
注意:商家需与支付宝约定后才返回本参数。
user_install_num可选string(5)
【描述】用户使用花呗分期支付的分期数
【示例值】3
fulfillment_detail_list|履约详情列表特殊可选fulfillmentdetail[]
【描述】履约详情列表。 只有入参的query_options中指定fulfillment_detail_list并且所查询的交易存在履约明细时才返回该字段信息。
【必选条件】履约详情列表。 只有入参的query_options中指定fulfillment_detail_list并且所查询的交易存在履约明细时才返回该字段信息。
fulfillment_amount|履约金额必选price(12)
【描述】履约金额
【示例值】80.00
out_request_no|履约商户请求号必选string(64)
【描述】商户发起履约请求时,传入的out_request_no,标识一次请求的唯一id
【示例值】20200320010101001
gmt_payment|履约支付时间必选date(32)
【描述】履约支付时间
【示例值】2021-03-17 09:45:57
additional_status|交易附加状态可选string(64)
【描述】交易附加状态:
seller_not_received(买家已付款,卖家未收款);
【示例值】seller_not_received
fund_bill_list可选tradefundbill[]
【描述】交易支付使用的资金渠道。
只有在签约中指定需要返回资金明细,或者入参的query_options中指定时才返回该字段信息。
fund_channel必选string(32)
【描述】交易使用的资金渠道,详见 支付渠道列表
【示例值】alipayaccount
amount必选price(32)
【描述】该支付工具类型所使用的金额。单位:元。
【示例值】10
real_amount可选price(11)
【描述】渠道实际付款金额。单位:元。
【示例值】11.21
passback_params可选string(512)
【描述】公用回传参数。
返回支付时传入的passback_params参数信息
【示例值】merchantbiztype=3c&merchantbizno=2016010101111
credit_pay_mode可选string(64)
【描述】信用支付模式。表示订单是采用信用凯发k8官方网娱乐官方的支付方式(支付时买家没有出资,需要后续履约)。"creditadvancev2"表示芝麻先用后付模式,用户后续需要履约扣款。 此字段只有信用支付场景才有值,商户需要根据字段值单独处理。此字段以后可能扩展其他值,建议商户使用白名单方式识别,对于未识别的值做失败处理,并联系支付宝凯发app官方网站的技术支持人员。
【枚举值】
芝麻先用后付模式: creditadvancev2
【示例值】creditadvancev2
credit_biz_order_id可选string(64)
【描述】信用业务单号。信用支付场景才有值,先用后付产品里是芝麻订单号。
【示例值】zmcb99202103310000450000041833
hyb_amount可选string(11)
【描述】惠营宝回票金额。单位:元。
【示例值】10.24
bkagent_resp_info可选bkagentrespinfo
【描述】间联交易下,返回给机构的信
息
bindtrx_id可选string(64)
【描述】原快捷交易流水号
【示例值】123412341234
bindclrissr_id可选string(14)
【描述】枚举值,01 银联;02 网联;03 连通等
【示例值】01
bindpyeracctbk_id可选string(14)
【描述】付款机构在清算组织登记或分配的机构代码
【示例值】123123123123
bkpyeruser_code可选string(128)
【描述】用户在银行付款账号的标记化处理编号
【示例值】123451234512345
estter_location可选string(32)
【描述】设备推测位置
【示例值】 37.28/-121.268
charge_info_list可选chargeinfo[]
【描述】计费信息列表
charge_fee|实收费用可选price(11)
【描述】实收费用。单位:元。
【示例值】0.01
original_charge_fee|原始费用可选price(11)
【描述】原始费用。单位:元。
【示例值】0.01
switch_fee_rate|签约费率可选string(64)
【描述】签约费率
【示例值】0.03
is_rating_on_trade_receiver|是否收款账号出资可选string(2)
【描述】是否收款账号出资,值为"y"或"n"
【示例值】y
is_rating_on_switch|是否合约指定收费账号出资可选string(2)
【描述】是否合约指定收费账号出资,值为"y"或"n"
【示例值】y
charge_type|手续费类型可选string(64)
【描述】收单手续费trade,花呗分期手续hbfq,其他手续费charge
【示例值】trade
sub_fee_detail_list|组合支付收费明细可选subfee[]
【描述】组合支付收费明细
charge_fee|实收费用可选price(11)
【描述】实收费用。单位:元。
【示例值】0.10
original_charge_fee|原始费用可选price(11)
【描述】原始费用。单位:元。
【示例值】0.20
switch_fee_rate|签约费率可选string(64)
【描述】签约费率
【示例值】0.03
biz_settle_mode可选string(64)
【描述】账期结算标识,指已完成支付的订单会进行账期管控,不会实时结算。该参数目前会在使用小程序交易组件场景下返回
【枚举值】
账期模式: period
【示例值】period
async_pay_apply_status可选string(8)
【描述】异步支付受理状态,仅异步支付模式且query_options指定async_pay_info时返回。s:受理成功,支付宝内部会在一定期限内捞起任务推进支付,直到支付成功或超出可重试期限;其它:受理结果未知,可重试查询。
【枚举值】
异步支付受理成功: s
【示例值】s
cashier_type|收银台类型可选string(64)
【描述】收银台类型。
用户支付的收银台类型,取值如下:
app:支付宝app收银台支付;
wap:支付h5收银台支付;
注:只有在无线产品支付接口请求中query_options指定cashier_type才返回该字段。
【示例值】app
tap_pay_info|碰一下支付信息可选tappayinfo
【描述】碰一下支付信息
payment_medium_type|支付介质类型必选string(16)
【描述】碰一下支付的支付介质类型,标识当前支付为碰一下支付
【示例值】tap_pay
响应示例
正常示例
异常示例
{
"alipay_trade_query_response": {
"code": "10000",
"msg": "success",
"trade_no": "2013112011001004330000121536",
"out_trade_no": "6823789339978248",
"buyer_logon_id": "159****5620",
"trade_status": "trade_closed",
"additional_status": "seller_not_received",
"total_amount": "88.88",
"trans_currency": "twd",
"settle_currency": "usd",
"settle_amount": "2.96",
"pay_currency": "cny",
"pay_amount": "8.88",
"settle_trans_rate": "30.025",
"trans_pay_rate": "0.264",
"buyer_pay_amount": "8.88",
"point_amount": "10",
"invoice_amount": "12.11",
"send_pay_date": "2014-11-27 15:45:57",
"receipt_amount": "15.25",
"store_id": "nj_s_001",
"terminal_id": "nj_t_001",
"fund_bill_list": [
{
"fund_channel": "alipayaccount",
"amount": "10",
"real_amount": "11.21"
}
],
"store_name": "证大五道口店",
"buyer_user_id": "2088101117955611",
"buyer_open_id": "01501o8f93i3njagb1jg4onxtxv25dcn3gec3uggnc4cju0",
"industry_sepc_detail_gov": "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}",
"industry_sepc_detail_acc": "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}",
"charge_amount": "8.88",
"charge_flags": "bluesea_1",
"settlement_id": "2018101610032004620239146945",
"trade_settle_info": {
"trade_settle_detail_list": [
{
"operation_type": "replenish",
"operation_serial_no": "2321232323232",
"operation_dt": "2019-05-16 09:59:17",
"trans_out": "208811****111111",
"trans_in": "208811****111111",
"amount": "10.00",
"ori_trans_out": "2088111111111111",
"ori_trans_in": "2088111111111111"
}
],
"trade_unsettled_amount": "1.1"
},
"auth_trade_pay_mode": "credit_preauth_pay",
"buyer_user_type": "private",
"mdiscount_amount": "88.88",
"discount_amount": "88.88",
"subject": "iphone6 16g",
"body": "iphone6 16g",
"alipay_sub_merchant_id": "2088301372182171",
"ext_infos": "{\"action\":\"cancel\"}",
"passback_params": "merchantbiztype=3c&merchantbizno=2016010101111",
"hb_fq_pay_info": {
"user_install_num": "3"
},
"credit_pay_mode": "creditadvancev2",
"credit_biz_order_id": "zmcb99202103310000450000041833",
"hyb_amount": "10.24",
"bkagent_resp_info": {
"bindtrx_id": "123412341234",
"bindclrissr_id": "01",
"bindpyeracctbk_id": "123123123123",
"bkpyeruser_code": "123451234512345",
"estter_location": " 37.28/-121.268"
},
"charge_info_list": [
{
"charge_fee": "0.01",
"original_charge_fee": "0.01",
"switch_fee_rate": "0.03",
"is_rating_on_trade_receiver": "y",
"is_rating_on_switch": "y",
"charge_type": "trade",
"sub_fee_detail_list": [
{
"charge_fee": "0.10",
"original_charge_fee": "0.20",
"switch_fee_rate": "0.03"
}
]
}
],
"biz_settle_mode": "period",
"req_goods_detail": [
{
"goods_id": "apple-01",
"alipay_goods_id": "20010001",
"goods_name": "ipad",
"quantity": 1,
"price": "2000",
"goods_category": "34543238",
"categories_tree": "124868003|126232002|126252004",
"body": "特价手机",
"show_url": "http://www.alipay.com/xxx.jpg",
"out_item_id": "outitem_01",
"out_sku_id": "outsku_01"
}
],
"fulfillment_detail_list": [
{
"fulfillment_amount": "80.00",
"out_request_no": "20200320010101001",
"gmt_payment": "2021-03-17 09:45:57"
}
],
"period_scene": "账期交易的场景。",
"async_pay_apply_status": "s",
"cashier_type": "app",
"tap_pay_info": {
"payment_medium_type": "tap_pay"
}
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
acq.enterprise_pay_biz_error | 因公付业务异常 | 重新发起查询请求,如果多次重试后仍返回同样的错误,请联系支付宝小二处理 |
acq.invalid_parameter | 参数无效 | 检查请求参数,修改后重新发起请求 |
acq.system_error | 系统错误 | 重新发起请求 |
acq.trade_not_exist | 查询的交易不存在 | 检查传入的交易号是否正确,修改后重新发起请求 |