查询接口query-凯发app官方网站

更新时间：2024-11-12 11:23:10

我的文档

设置

alipay.trade.pay

（统一收单交易支付接口）的 query_options 参数说明如下。

参数说明

query_options（查询选项）

描述	说明
参数说明	查询选项商户通过上送该参数来定制同步需要额外返回的信息字段，数组格式。
参数值	参数值枚举： ●trade_settle_info：返回的交易结算信息，包含分账、补差等信息。 ●fund_bill_list：交易支付使用的资金渠道。 ●voucher_detail_list：交易支付时使用的所有优惠券信息。 ●discount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息。

入参示例

biz_content={

"trade_no": "2020113022001441145749050490",

"query_options": [

"voucher_detail_list",

"fund_bill_list",

"discount_goods_detail"]

}

trade_settle_info

query_options=trade_settle_info，可查询本次交易结算信息，包括分账、补差等信息，详见

如何判断商家分账是否成功

。

响应参数中返回的 trade_settle_detail_list 说明如下：

●

operation_type=transfer 表示分账的信息。

●

operation_type=transfer_refund 表示退分账的信息。

关键出参

关键字段	是否必传	参数说明
trade_settle_info	特殊可选	返回的交易结算信息，包含分账、补差等信息。只有在 query_options 中指定时才返回该字段信息。
└ trade_settle_detail_list	否	交易结算明细信息
└└operation_type	是	结算操作类型。包含 replenish、replenish_refund、transfer、transfer_refund 等类型。
└└operation_serial_no	否	商户操作序列号。商户发起请求的外部请求号。
└└operation_dt	是	操作日期
└└trans_out	否	转出账号
└└trans_in	否	转入账号
└└amount	是	实际操作金额，单位为元，两位小数。该参数的值为分账或补差或结算时传入。

示例

fund_bill_list

query_options=fund_bill_list，可用于查询本次交易用户付款的支付渠道，如花呗、支付宝账户等，详见

如何判断用户付款的支付渠道

。

●

查询接口不设置 query_options=fund_bill_list，默认只有当面付会返回 fund_bill_list、buyer_pay_amoun t等参数，线上支付接口不返回。

●

若要查询手机网站支付、电脑网站支付、app 支付产品交易的 fund_bill_list 参数，需要在接口中设置 query_options 参数为 ["fund_bill_list"] 或使用异步通知参数返回的 fund_bill_list 信息。

因此建议接口中设置 query_options=fund_bill_list 返回相关信息进行核实确认。

●

交易成功和交易完成，该笔交易查询会返回 fund_bill_list 支付渠道；

○

等待支付和交易关闭，该笔交易查询不返回 fund_bill_list 支付渠道信息，且 buyer_pay_amount 等金额为 0。

○

全额退款后查询该笔交易支付渠道，可使用

alipay.trade.fastpay.refund.query

（

统一收单交易退款查询接口

）设置 query_options=refund_detail_item_list，详见

退款接口 query_options 参数详解

。

●

默认情况下，支付宝余额，储蓄卡，信用卡的支付渠道参数值为支付宝账户（alipayaccount）。

关键出参

关键字段	是否必传	参数说明
fund_bill_list	特殊可选	交易支付使用的资金渠道。只有在签约中指定需要返回资金明细，或者入参的 query_options 中指定时才返回该字段信息。
└fund_channel	是	交易使用的资金渠道，详见。
└amount	是	该支付工具类型所使用的金额。

示例

voucher_detail_list

query_options=voucher_detail_list，可用于本交易用户支付时使用的所有优惠券信息。

●

平台创建优惠券和接口创建的优惠券通过支付核销后都可返回优惠券信息。

●

交易成功和交易完成，该笔交易查询会返回 voucher_detail_list 优惠券信息；

等待支付和交易关闭，该笔交易查询不返回 voucher_detail_list 优惠券信息。

●

若用户未使用优惠券，接口返回响应参数中也不包含 voucher_detail_list。

关键出参

关键字段	是否必传	参数说明
voucher_detail_list	特殊可选	本交易支付时使用的所有优惠券信息。只有在 query_options 中指定时才返回该字段信息。
└voucher_id	是	券 id。
└name	是	券名称。
└type	是	券类型，如： ●alipay_fix_voucher - 全场代金券 ● alipay_discount_voucher - 折扣券 ● alipay_item_voucher - 单品优惠券 ● alipay_cash_voucher - 现金抵价券 ●alipay_biz_voucher - 商家全场券注意：不排除将来新增其他类型的可能，商家接入时注意兼容性避免硬编码。
└amount	是	优惠券面额，它应该会等于商家出资加上其他出资方出资。
└merchant_contribute	否	商家出资（特指发起交易的商家出资金额）。
└other_contribute	否	其他出资方出资金额，可能是支付宝，可能是品牌商，或者其他方，也可能是他们的一起出资。
└memo	否	优惠券备注信息。
└template_id	否	券模板 id。
└ other_contribute_detail	否	优惠券的其他出资方明细。
└└contribute_type	是	出资方类型，如品牌商出资、支付宝平台出资等。
└└contribute_amount	是	出资方金额。
└purchase_buyer_contribute	否	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时用户实际付款的金额。
└purchase_merchant_contribute	否	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时商户优惠的金额。
└purchase_ant_contribute	否	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时平台优惠的金额。

示例

discount_goods_detail

query_options=discount_goods_detail，可用于查询用户使用单品劵核销优惠的交易信息。

●

若有使用单品券，不设置 query_options 也会返回 discount_goods_detail 参数。

●

若用户未使用单品券，接口返回响应参数中也不包含 discount_goods_detail。

关键出参

关键字段	是否必传	参数说明
discount_goods_detail	特殊可选	本次交易支付所使用的单品券优惠的商品优惠信息。只有在 query_options 中指定时才返回该字段信息。
└goods_id	是	商品的编号。
└goods_name	是	商品名称。
└discount_amount	是	优惠券面额。
└voucher_id	是	券 id。
└goods_num	否	优惠券使用数量。

示例

相关问题