SnapPay Developer Documents
3.2 订单查询
描述
该接口提供所有交易订单(支付,撤销,退款)的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
调用支付接口后,返回系统错误或未知交易状态;
调用条码支付API,返回USERPAYING的状态;
调用撤销接口API之前,需确认支付状态;
请求参数
公共参数
参见【请求报文 - 公共参数】
业务参数
参数KEY | 参数名称 | 类型 | 必要性 | 描述 |
method | 请求方法 | TEXT(128) | M | 此接口固定值为:pay.orderquery |
merchant_no | 商户号 | TEXT(32) | M | 商户号,在SnapPay入驻后生成的定常数字,用于标识商户身份 |
out_order_no | 商户订单号 | TEXT(32) | C | 商户系统内部订单号,只允许数字或英文字母。同一商户下订单号不能重复 |
trans_no | 交易号 | TEXT(32) | C | 开放服务网关平台交易号,商户订单号和交易号二选一必传 |
extension_parameters | 扩展参数 | JSONObject | O | 扩展输入参数,后续定义增加的参数存储于此JSON可变结构中 |
响应参数
公共参数
参见【响应报文 - 公共参数】
业务参数
当 code=0 时,data[0] 返回如下参数:
参数KEY | 参数名称 | 类型 | 必要性 | 描述 |
trans_no | 交易号 | TEXT(32) | M | 开放服务网关平台交易号 |
out_order_no | 商户订单号 | TEXT(32) | M | |
merchant_no | 商户号 | TEXT(32) | M | 商户号,在SnapPay入驻后生成的定常数字,用于标识商户身份 |
trans_status | 交易状态 | TEXT | M | 交易状态:USERPAYING-交易创建,等待买家付款CLOSE-交易关闭,包括撤销关闭,超时未支付关闭,交易失败关闭SUCCESS-交易完成 |
当 trans_status交易状态为:SUCCESS-交易完成 时,data[0] 返回如下参数:
参数KEY | 参数名称 | 类型 | 必要性 | 描述 |
payment_method | 支付方式 | TEXT(16) | M | 目前支持的支付方式有: ALIPAY 支付宝 WECHATPAY 微信支付 UNIONPAY 中国银联刷卡 UNIONPAY_QR-银联云闪付 |
pay_user_account_id | 买家账号标识 | TEXT(32) | M | 支付宝返回支付用户的ID,例如: 2088101117955611
微信返回商户appid下用户唯一标识,例如:wx37150978513678 银行卡交易返回加*脱敏的卡号信息,例如: 6226****1982 |
pay_user_account_name | 买家账号名称 | TEXT(32) | O | 159****5620或zhangsan@sina.com注:支付宝支付返回账号登录名,微信支付时返回为空 |
trans_currency | 标价币种 | TEXT(32) | O | 符合ISO 4217标准的三位字母代码,币种列表详见货币类型 |
exchange_rate | 汇率 | TEXT(16) | O | 标价币种兑换支付币种汇率,非RMB标价时有值 |
trans_amount | 交易总金额 | AMOUNT | M | 交易总金额 |
c_trans_fee | 顾客承担手续费 | AMOUNT | O | 交易手续费由商家承担部分的金额 |
customer_paid_amount | 顾客实付金额 | AMOUNT | M | 交易过程中从顾客资金账户中实际扣减的金额 |
discount_bmopc | 支付通道商户优惠金额 | AMOUNT | O | 商户在支付通道的服务提供方(微信、支付宝等)的系统发布营销活动(优惠券、代金券、满减、单品优惠),用户支付时享受的金额减免 |
discount_bpc | 支付通道优惠金额 | AMOUNT | O | 支付通道提供方(微信、支付宝等)给用户提供的优惠,在交易过程中直接减免,如:鼓励金、立减、红包等营销活动 |
trans_end_time | 交易完成时间 | DATE | M | 支付成功或失败的时间 |
pay_operation_method | 支付操作方式 | NUMBER | M | 4:扫码支付 5:条码支付 6:H5支付 8:APP支付 9:PC网页支付 |
attach | 商户附加信息 | JSON(127) | O | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 |
Copyright reserved for SnapPay Inc 2019.