查询订单 - 易宝开放平台

查询订单

请求参数

Query 参数

parentMerchantNo

string

发起方商编

可选

发起方商户编号。与交易下单传入的保持一致

<= 11 字符

merchantNo

string

必需

收款商户编号

<= 11 字符

orderId

string

交易下单传入的商户收款请求号

必需

。
(合单收款场景请传入子单的商户收款请求号)

<= 64 字符

Header 参数

x-yop-sdk-version

string

可选

默认值:

4.0.0

返回响应

🟢200成功

application/json

Body

result

object (trade.YopQueryOrderResDTO)

响应结果

可选

code

string

返回码

可选

OPR00000 成功

示例值:

OPR00000

message

string

返回信息

可选

parentMerchantNo

string

交易发起方商编

可选

merchantNo

string

商户编号

可选

收款商户编号

<= 11 字符

orderId

string

商户收款请求号

可选

商户收款请求号

<= 64 字符

uniqueOrderNo

string

易宝收款订单号

可选

易宝收款订单号

<= 64 字符

status

string

订单状态

可选

PROCESSING：订单待支付
SUCCESS：订单支付成功
TIME_OUT：订单已过期
FAIL:订单支付失败
CLOSE:订单关闭

orderAmount

number

订单金额.单位

可选

元

payAmount

number

用户支付金额

可选

用户支付金额,单位:元

示例值:

12.34

merchantFee

number

商户手续费

可选

商户承担的手续费金额.单位:元

示例值:

0.54

customerFee

number

可选

用户手续费,用户付费场景下返回.单位:元

示例值:

0.54

paySuccessDate

string

支付成功时间

可选

示例值:

2021-01-01 00:00:00

memo

string

对账备注

可选

商户自定义参数，会展示在交易对账单中

payWay

string

支付方式

可选

USER_SCAN：用户扫码 MERCHANT_SCAN：商家扫码 JS_PAY：JS支付 MINI_PROGRAM：小程序支付 WECHAT_OFFIACCOUNT：微信公众号支付 ALIPAY_LIFE：生活号支付 FACE_SCAN_PAY：刷脸支付 SDK_PAY：SDK支付 H5_PAY：H5支付 ONEKEYPAY：一键支付 BINDCARDPAY：绑卡支付 E_BANK：网银支付 ENTERPRISE_ACCOUNT_PAY：企业账户支付 ACCOUNT_BOOK_PAY: 记帐簿支付 BANKACCOUNT_PAY：银行账户支付 EASYPAY：易缴费 H5_PAY_M：H5支付 CREDIT_PAY：信用分 EASYSHARE：易分账 DIRECT_PAY：云微直接支付 UNCONSCIOUS_PAY：云微无感支付 STATICQR：静态台牌 INSTALLMENT：信用卡分期 WALLET_PAY：易宝钱包支付 OVERSEASCARDPAY：境外卡支付 COMPREHENSIVE_SDK：网银B2C移动端 BATCHPAY：批量支付 SBKPAY：社保卡支付 BANKTRANSFERPAY：银行转账支付 POS：刷卡支付 FACEPAY：刷脸付 AGREEMENTPAY：协议支付

示例值:

USER_SCAN

token

string

可选

支付授权token，用于调用支付

fundProcessType

string

分账都订单标识

可选

分账订单标识:
DELAY_SETTLE:分账
REAL_TIME:不分账

REAL_TIME_DIVIDE： 实时分账

<= 32 字符

bankOrderId

string

银行订单号

可选

支付机构在渠道侧的外部商户订单号，微信商户单号/支付宝商家订单号

<= 64 字符

channelOrderId

string

渠道订单号

可选

该笔订单银网联生成的唯一订单号

<= 64 字符

channel

string

渠道类型

可选

WECHAT：微信
ALIPAY：支付宝
UNIONPAY：银联
APPLEPAY：苹果支付

ACCOUNTPAY：账户支付

MEMBERPAY：会员支付

NCPAY：无卡支付

NET：网银

DCEP:数字人民币

<= 16 字符

示例值:

DCEP

realPayAmount

number

用户实际支付金额

可选

unSplitAmount

number

可选

剩余可分账金额;(用于分账的场景)

totalRefundAmount

number

可选

累计已退款金额(包含退款处理中-已受理的退款)

payerInfo

object (trade.PayerInfo)

付款信息

可选

channelPromotionInfo

array[object (trade.ChannelPromotionInfoDTO) {11}]

渠道侧优惠列表

可选

ypPromotionInfo

array[object (trade.YpPromotionInfoDTO) {7}]

易宝优惠列表

可选

terminalInfo

string

终端信息

可选

installmentInfo

object (trade.InstallmentInfo)

信用卡分期信息

可选

enterprisePayInfo

object (trade.EnterprisePayInfo)

企业信息

可选

failReason

string

支付失败的失败原因

可选

failCode

string

可选

支付失败的code码

clearStatus

string

清算状态

可选

订单状态为成功时有值
可选项如下:
SUCCESS:成功
PROCESSING:处理中

feeContributeInfo

array[object (trade.FeeContributeInfoDTO) {4}]

可选

手续费出资详情列表

tradeType

string

资金到账类型

可选

tradeType枚举值
可选项如下:
REALTIME:实时
PREAUTH:预授权

preAuthStatus

string

预授权状态

可选

preAuthStatus枚举值
可选项如下:
WAITPREAUTH:等待预授权
PREAUTH:预授权
PREAUTHREPEAL:预授权撤销
PREAUTHCOMPLETE:预授权完成

preAuthAmount

number

预授权金额

可选

channelMerchantInfo

object (trade.ChannelMerchantInfoDTO)

聚合商户号信息

可选

csSuccessDate

string

清算成功时间

可选

ypSettleAmount

number

入账金额

可选

feeMerchantNo

string

手续费承担商编

可选

feeType

string

手续费类型

可选

outClearChannel

string

可选

清算核验渠道:

NUCC：网联

UP : 银联

OTHER : 三方

示例值:

channelTrxId

string

微信交易单号/支付宝订单号

可选

该笔订单在微信支付宝侧的唯一订单号，微信交易单号/支付宝订单号

<= 64 字符

fundControlCsStatus

string

订单管控状态

可选

INIT:处理中

FROZEN:已冻结

UN_FROZEN:已解冻

<= 16 字符

csUnFrozenCompleteDate

string

可选

管控订单解冻时间

<= 19 字符

basicsProductFirst

string

收方一级基础产品码

可选

收方一级基础产品码

<= 32 字符

basicsProductSecond

string

收方二级基础产品码

可选

收方二级基础产品码

<= 32 字符

basicsProductThird

string

收方三级基础产品码

可选

收方三级基础产品码

<= 32 字符

originalDivideAmount

number

原始可分账金额

可选

入帐金额+补贴商户金额 - 补贴商户撤回金额

totalDivideAmount

number

累计已分账金额

可选

累计已分账金额

currencyCode

string

外卡币种

可选

<= 32 字符

deductionAmount

number

外币金额

可选

外币金额

preAuthWay

enum<string> <enum>

预授权方式

可选

预授权方式

可选项如下:
PREAUTH:刷卡预授权
PRECONSUME:聚合预授权

<= 32 字符

枚举值:

PREAUTHPRECONSUME

appID

string

微信appid

可选

微信appid

<= 64 字符

示例值:

true

feeRateInfo

string

手续费费率信息

可选

手续费费率信息

<= 1024 字符

示例值:

true

creditOrderId

string

信用分请求号

可选

信用分请求号

<= 64 字符

示例值:

true

示例

{
  "result": {
    "code": "OPR00000",
    "message": "string",
    "parentMerchantNo": "string",
    "merchantNo": "string",
    "orderId": "string",
    "uniqueOrderNo": "string",
    "status": "string",
    "orderAmount": 0,
    "payAmount": 12.34,
    "merchantFee": 0.54,
    "customerFee": 0.54,
    "paySuccessDate": "2021-01-01 00:00:00",
    "memo": "string",
    "payWay": "USER_SCAN",
    "token": "string",
    "fundProcessType": "string",
    "bankOrderId": "string",
    "channelOrderId": "string",
    "channel": "DCEP",
    "realPayAmount": 0,
    "unSplitAmount": 0,
    "totalRefundAmount": 0,
    "payerInfo": {
      "bankId": "ABC",
      "accountName": "易宝支付有限公司",
      "bankCardNo": "622848****0000",
      "mobilePhoneNo": "181****5651",
      "cardType": "CREDIT",
      "userID": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
      "buyerLogonId": "string",
      "ypAccountBookNo": "string",
      "appID": "string",
      "channelTrxId": "string"
    },
    "channelPromotionInfo": [
      {
        "promotionId": "string",
        "promotionName": "string",
        "promotionScope": "string",
        "amount": 0,
        "amountRefund": 0,
        "activityId": "string",
        "channelContribute": "string",
        "merchantContribute": "string",
        "otherContribute": "string",
        "memo": "string",
        "promotionType": "string"
      }
    ],
    "ypPromotionInfo": [
      {
        "marketNo": "string",
        "couponNo": "string",
        "subsidyOrderNo": "string",
        "type": "CUSTOM_ALLOWANCE",
        "amount": "string",
        "contributeMerchant": "string",
        "status": "string"
      }
    ],
    "terminalInfo": "string",
    "installmentInfo": {
      "instNumber": "string"
    },
    "enterprisePayInfo": {
      "enterpriseInfoList": [
        {
          "enterpriseId": "string",
          "enterprisePayAmount": 0
        }
      ],
      "invoiceAmount": 0
    },
    "failReason": "string",
    "failCode": "string",
    "clearStatus": "string",
    "feeContributeInfo": [
      {
        "merchantNo": "string",
        "amount": "string",
        "type": "string",
        "marketSource": "string"
      }
    ],
    "tradeType": "string",
    "preAuthStatus": "string",
    "preAuthAmount": 0,
    "channelMerchantInfo": {
      "channelMerchantNo": "string"
    },
    "csSuccessDate": "string",
    "ypSettleAmount": 0,
    "feeMerchantNo": "string",
    "feeType": "string",
    "outClearChannel": "UP",
    "channelTrxId": "string",
    "fundControlCsStatus": "string",
    "csUnFrozenCompleteDate": "string",
    "basicsProductFirst": "string",
    "basicsProductSecond": "string",
    "basicsProductThird": "string",
    "originalDivideAmount": 0,
    "totalDivideAmount": 0,
    "currencyCode": "string",
    "deductionAmount": 0,
    "preAuthWay": "PREAUTH",
    "appID": "true",
    "feeRateInfo": "true",
    "creditOrderId": "true"
  }
}

🔴500服务器错误