查询退款 - 易宝开放平台

提交退款申请后，调用该接口可查询退款状态

请求参数

Query 参数

parentMerchantNo

string

发起方商编

可选

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

<= 11 字符

示例值:

10012426723

merchantNo

string

必需

原收款商户编号

<= 11 字符

示例值:

10012426723

orderId

string

必需

原收款交易对应的商户收款请求号

<= 64 字符

示例值:

10012426723

refundRequestId

string

商户退款请求号

必需

。可包含字母、数字、下划线；需要保证在商户端不重复。

<= 64 字符

示例值:

10012426723

uniqueRefundNo

string

易宝退款订单号

可选

商户退款请求对应在易宝的退款单号

<= 32 字符

示例值:

10012426723

Header 参数

x-yop-sdk-version

string

可选

默认值:

4.0.0

返回响应

🟢200成功

application/json

Body

result

object (trade.QueryRefundResponseDTO)

响应结果

可选

code

string

返回码

可选

结果码，OPR00000表示易宝受理成功，退款状态请以"status"为准

示例值:

OPR00000

message

string

返回信息

可选

对应code的中文信息

示例值:

成功

parentMerchantNo

string

发起方商编

可选

merchantNo

string

商户编号

可选

orderId

string

商户收款请求号

可选

refundRequestId

string

商户退款请求号

可选

uniqueOrderNo

string

易宝收款订单号

可选

uniqueRefundNo

string

易宝退款订单号

可选

refundAmount

number

可选

退款申请金额,单位:元

示例值:

12.92

returnMerchantFee

number

可选

退回商户手续费金额,单位:元

示例值:

1.12

status

string

退款状态

可选

PROCESSING：退款处理中
SUCCESS：退款成功
FAILED：退款失败
CANCEL:退款关闭,商户通知易宝结束该笔退款后返回该状态
SUSPEND:退款中断,如需继续退款,请调用上送卡信息退款进行打款退款;如想结束退款,请调用结束退款来关闭退款订单
说明:调用申请极速退款、上送卡信息退款、结束退款前,请联系易宝提前开通相应的退款服务。

示例值:

SUCCESS

description

string

退款原因的简要描述

可选

refundRequestDate

string

退款受理时间

可选

示例值:

2021-01-01 00:00:00

refundSuccessDate

string

退款成功日期

可选

退款成功时间

示例值:

2021-01-01 00:00:00

failReason

string

退款失败原因

可选

realRefundAmount

number

实际退款金额

可选

用户付手续费场景下,实际退款金额即退款金额和退费金额之和

cashRefundFee

number

用户实退金额

可选

示例值:

1.23

bankPromotionInfoDTOList

array[object (trade.BankPromotionInfoDTO) {10}]

渠道侧优惠退回列表

可选

ypPromotionInfoDTOList

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

易宝侧优惠退回列表

可选

refundAccountDetail

string

退款资金来源信息

可选

debitAmount：扣账金额
accountType：扣账资金来源
扣账资金来源枚举值：
FUND_ACCOUNT：资金账户余额
DIVIDE_ACCOUNT：分账账户余额
SETTLE_ACCOUNT：待结算账户余额

示例值:

[{"accountType":"FUND_ACCOUNT","debitAmount":6.00}]

channelReceiverInfo

string

退款入账信息

可选

refundCsFinishDate

string

扣账时间

可选

格式：yyyy-MM-dd HH:mm:ss

bankRefundOrderNo

string

退款银行订单号

可选

支付机构在渠道侧的外部商户订单号

<= 64 字符

bankRefundOrderId

string

退款银行流水号

可选

该笔订单在渠道侧的唯一订单号

<= 64 字符

paymentMethod

string

可选

支付方式:

ACCOUNTBOOKPAY:记账簿支付

ALIPAY:支付宝

WECHAT:微信

UNIONPAY:云闪付

BANKACCOUNTPAY:银行账户支付

BANKTRANSFERPAY:银行转账支付

DCEP:数字人民币支付

E_BANK:网银支付

ENTERPRISEACCOUNTPAY:企业账户支付

INSTALLMENT:信用卡分期支付

MEMBERACCOUNTPAY:个人账户支付

NCPAY:快捷支付

OVERSEASCARDPAY:境外卡支付

POS:刷卡支付

YZS:一站式还款

disAccountAmount

number

可选

商户账户扣账金额

orgFundControlCsStatus

string

原单订单管控状态

可选

FROZEN:已冻结

UN_FROZEN:已解冻

<= 16 字符

orgCsUnFrozenCompleteDate

string

可选

原单解冻完成时间

<= 19 字符

orgBasicsProductFirst

string

原交易订单收方一级基础产品码

可选

原交易订单收方一级基础产品码

<= 32 字符

orgBasicsProductSecond

string

原交易订单收方二级基础产品码

可选

原交易订单收方二级基础产品码

<= 32 字符

orgBasicsProductThird

string

原交易订单收方三级基础产品码

可选

原交易订单收方三级基础产品码

<= 32 字符

示例

{
  "result": {
    "code": "OPR00000",
    "message": "成功",
    "parentMerchantNo": "string",
    "merchantNo": "string",
    "orderId": "string",
    "refundRequestId": "string",
    "uniqueOrderNo": "string",
    "uniqueRefundNo": "string",
    "refundAmount": 12.92,
    "returnMerchantFee": 1.12,
    "status": "SUCCESS",
    "description": "string",
    "refundRequestDate": "2021-01-01 00:00:00",
    "refundSuccessDate": "2021-01-01 00:00:00",
    "failReason": "string",
    "realRefundAmount": 0,
    "cashRefundFee": 1.23,
    "bankPromotionInfoDTOList": [
      {
        "promotionId": "string",
        "promotionName": "string",
        "amountRefund": 0,
        "activityId": "string",
        "channelContribute": "string",
        "merchantContribute": "string",
        "otherContribute": "string",
        "memo": "string",
        "promotionType": "string",
        "promotionScope": "string"
      }
    ],
    "ypPromotionInfoDTOList": [
      {
        "marketNo": "string",
        "ypRefundAmount": "0.01",
        "type": "CUSTOM_REDUCTION",
        "couponNo": "string"
      }
    ],
    "refundAccountDetail": "[{\"accountType\":\"FUND_ACCOUNT\",\"debitAmount\":6.00}]",
    "channelReceiverInfo": "string",
    "refundCsFinishDate": "string",
    "bankRefundOrderNo": "string",
    "bankRefundOrderId": "string",
    "paymentMethod": "string",
    "disAccountAmount": 0,
    "orgFundControlCsStatus": "string",
    "orgCsUnFrozenCompleteDate": "string",
    "orgBasicsProductFirst": "string",
    "orgBasicsProductSecond": "string",
    "orgBasicsProductThird": "string"
  }
}

🔴500服务器错误