申请退款

沙箱环境

https://sandbox.yeepay.com/yop-center

POST

/rest/v1.0/trade/refund

trade

订单状态为“SUCCESS”时才能发起退款。 * 退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和不同的退款单号，总退款金额不能超过用户实际支付金额。 * 一笔退款失败后重新提交，请不要更换退款单号，请使用相同的商户退款请求号请求退款。 * 申请退款接口的响应参数code仅代表业务的受理情况，具体退款是否成功，需要通过申请退款或查询退款接口返回的status获取退款结果。（1）当响应参数code=OPR00000时,说明易宝已受理该笔退款,此时需要根据status来判断退款状态；（2）当响应参数code≠OPR00000时,说明易宝没有受理该笔退款，可根据返回的message进行相应处理。

请求参数

Header 参数

x-yop-sdk-version

string

可选

默认值:

4.0.0

Body 参数application/x-www-form-urlencoded

parentMerchantNo

string

发起方商编

可选

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

<= 11 字符

示例值:

10012426723

merchantNo

string

必需

原收款商户编号

<= 11 字符

示例值:

10012426723

orderId

string

必需

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

<= 64 字符

示例值:

100000000187142947011

refundRequestId

string

必需

商户退款请求号

<= 64 字符

示例值:

refundorder987654

uniqueOrderNo

string

收款交易对应的易宝收款订单号

可选

。

<= 32 字符

示例值:

1001201612070000000000000565

refundAmount

string

退款申请金额

必需

单位：元，两位小数，最低0.01，退款金额不能大于原订单金额，多次退款时，累计退款金额不能超过原订单金额

<= 12 字符

示例值:

88.88

description

string

可选

退款原因

<= 200 字符

示例值:

用户申请退货并退款

memo

string

对账备注

可选

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

<= 200 字符

示例值:

退款

refundAccountType

string

退款资金来源

可选

对退款资金来源有要求的商户传入，否则请勿传入。
FUND_ACCOUNT：资金账户余额
不传则默认使用未结算资金退款,如未结算资金不足则使用资金账户余额退款，无资金账户则会报错未找到账户

<= 24 字符

notifyUrl

string

退款结果回调url

可选

接收退款结果通知地址，不传则不通知回调参数请参考：退款结果通知

<= 200 字符

divideBackDetail

string

分账归集明细

可选

只有中台实时分账订单、延迟结算订单退款归集才使用该字段。
提示:
原订单分账标识为实时分账时，请勿传入需要收单商返回金额的明细，仅需传入需要分账接收方返还的金额，剩余退款所需金额将从收单商户账户中扣除。
原订单分账标识为延迟结算订单时，分为两种传参方式:
1、从其他分账接收方归集返还的部分，请传入易宝分账明细订单号、归集金额，请勿传入扣账账户类型
2、从收单商户账户扣除的部分，如无需指定资金扣账的账户类型，请勿传入任何明细，剩余退款所需金额将从收单商户待待结算/资金账户中扣除；如需要指定扣账的账户类型，请传入扣账账户类型字段（目前支持待分账账户），请勿传入其他字段，并且同一次退款请求最多允许传入一条收单商户明细。

可传入以下属性:
ledgerNo:归集商编
amount:归集金额
divideDetailNo:易宝分账明细订单号
divBackAccountType:扣账账户类型，目前支持传入 DIVIDE_ACCOUNT (待分账账户)

divideBackReason:分账退回原因

<= 1000 字符

示例值:

[{"ledgerNo":"10080028707","amount":1.20,"divideDetailNo":"1010202408010000013288965686"},{"ledgerNo":"10080028770","divBackAccountType":"DIVIDE_ACCOUNT"}]

terminalInfo

string

可选

terminalInfo
JSON格式： {"notifyEquipmentNos":"97002100231636,97002100231637"}业务描述: 支持终端信息传参，目前可传参数：notifyEquipmentNos，表示云喇叭播报的设备号，可以支持传多个设备号，多个设备的情况下，设备号通过英文逗号,隔开

<= 300 字符

示例值:

{"notifyEquipmentNos":"97002100231636"}

返回响应

🟢200成功

application/json

Body

result

object (trade.ResponseRefundDTO)

响应结果

可选

code

string

返回码

可选

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

示例值:

OPR00000

message

string

返回信息

可选

信息描述，对应code的中文信息

示例值:

成功

parentMerchantNo

string

发起方商编

可选

示例值:

10012426723

merchantNo

string

商户编号

可选

示例值:

10012426723

orderId

string

商户收款请求号

可选

示例值:

10012016120700000000000000565

refundRequestId

string

商户退款请求号

可选

示例值:

refundorder987654

uniqueRefundNo

string

易宝退款订单号

可选

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

示例值:

10022022030600000003302144723

status

string

退款订单状态

可选

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

示例值:

SUCCESS

refundAmount

string

退款申请金额

可选

示例值:

88.88

refundRequestDate

string

退款受理时间

可选

示例值:

2021-01-01 00:00:00

refundMerchantFee

string

退还商户手续费

可选

在退款成功时返回

refundAccountDetail

string

退款资金来源信息

可选

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

HANDLE_ACCOUNT：后收手续费账户余额

<= 128 字符

示例值:

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

refundCsFinishDate

string

扣账时间

可选

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

示例

{
    "result": {
        "code": "OPR00000",
        "message": "成功",
        "parentMerchantNo": "10012426723",
        "merchantNo": "10012426723",
        "orderId": "10012016120700000000000000565",
        "refundRequestId": "refundorder987654",
        "uniqueRefundNo": "10022022030600000003302144723",
        "status": "SUCCESS",
        "refundAmount": "88.88",
        "refundRequestDate": "2021-01-01 00:00:00",
        "refundMerchantFee": "string",
        "refundAccountDetail": "[{\"accountType\":\"FUND_ACCOUNT\",\"debitAmount\":6.00}]",
        "refundCsFinishDate": "string"
    }
}

🔴500服务器错误

修改于 2025-03-16 10:32:56

查询订单

交易回单