统一退款申请 - 易企通2.0

统一退款接口为商户提供多样化退款服务，
覆盖多业务产品易企通、收款啦、云易收等正向交易，
支持多种退款类型实时退款、结算户退款、极速退款、脱机退款、延迟退款等，
支持多退款模式自动模式，手动模式，
都可以通过一套接口，统一退款申请，统一退款结果查询，统一退款通知。满足商户在不同退款场景下的，进行退款服务追踪管理等需求。

主要功能适用场景
实时退款
实时从商户的待结算资金，原路退回给付款方，支持全额退或部分退。
需要待结算资金充足，如果不足会提示退款失败。
适用于商户要求从待结算资金，原路退回的退款场景。

结算户退款
实时从商户的结算户资金，原路退回给付款方，支持全额退或部分退。
需要结算户资金充足，如果不足会提示退款失败。
适用于商户要求从结算户资金，原路退回的退款场景。

极速退款
实时从商户的现金户，原路退回给付款方，支持全额退或部分退。
适用于商户要求结算与退款收支两条线，不从待结算资金中轧差退款场景。

脱机退款
当日从商户的待结算资金，原路退回给付款方，支持全额退或部分退。
需要待结算资金充足，如果不足当天会持续退，日终如果待结算资金不足，会提示退款失败。
适用于商户当日日初的时候没有待结算资金，日中有待结算资金，要求从待结算资金，原路退回的退款场景。

延迟退款
多天从商户的待结算资金，原路退回给付款方，支持全额退或部分退。
需要待结算资金充足，如果不足会持续退，日终如果待结算资金不足，会先扣除当天全额的待结算资金，后续天继续扣除。扣除到退款金额后会原路退回付款方
适用于商户当日没有待结算资金，后续日有待结算资金，要求从待结算资金，原路退回的退款场景。

其他注意事项
自动模式：脱机退款或者延迟退款和实时退款自动切换，开通了脱机退款或者延迟退款，优先走脱机退款或延迟退款，没有开通的走实时退款。
手动模式：需要且只能指定一种退款类型。

注意事项
1、功能规则
（1）退款规则：原交易存在、且原交易可退金额大于等于本次退款金额、且商户当日正向交易头寸大于等于本次退款金额。
（2）支持部分退款、全额退款。
（3）退款类型（bizType）RealRefund 实时退款；StlmAcctRefund 结算户退款；FastRefund 极速退款；OfflineRefund 脱机退款；DelayRefund 延迟退款；

2、支持对以下交易发起退款
（1）原交易分账标识为0
（2）原交易延时结算标识为0
（3）原交易分账标识为1或2，且尚未发起分账，对主单发起退款
（4）原交易为合单支付，对子单发起退款
（5）原交易分账标识为1或2，针对已成功分账回退的金额，可以通过本接口发起实时退款。

请求参数

Body 参数application/json必填

示例

{
    "reqBody": {
        "reqInfo": {
            "mchtCode": "string",
            "termCode": "string"
        },
        "reqOrderInfo": {
            "orgTrace": "string",
            "oriOrgTrace": "string",
            "oriOutTrace": "string",
            "oriTransDate": "string",
            "refundSource": "string",
            "refundAmount": 0,
            "promoRfAmount": 0,
            "backUrl": "string",
            "customInfo": "string",
            "handlingFee": 0
        },
        "payInfo": {
            "bizScen": "string",
            "bizType": "RealRefund",
            "payType": "WeChatPreRF",
            "refundMode": "Auto",
            "transDate": "string"
        },
        "qrCodeRefundExt": {
            "currency": "str",
            "operatorId": "string",
            "queryOption": [
                "string"
            ],
            "refundReason": "string",
            "storeCode": "string"
        },
        "dfPayOrderExtInfo": {
            "areaCode": "string",
            "bankNo": "string",
            "bizType": "string",
            "currency": "string",
            "deviceInfo": {
                "customerIp": "string",
                "deviceId": "string",
                "deviceImsi": "string",
                "iccId": "string",
                "location": "string",
                "mac": "string",
                "wifiMac": "string"
            },
            "oriMchtCode": "string",
            "oriPayAbilityCode": "string",
            "oriSubMchtCode": "string",
            "payeeAcctName": "string",
            "payeeAcctNameMask": "string",
            "payeeAcctNo": "string",
            "payeeAcctNoMask": "string",
            "payeeAcctType": "string",
            "payeeSignNo": "string",
            "payerAcctName": "string",
            "payerAcctNo": "string",
            "payerAcctType": "string",
            "remark": "string",
            "reqReserved": "string",
            "reserved": "string",
            "stlmMethod": "string",
            "summary": "string",
            "termType": "string",
            "usage": "string",
            "dgtlEnvlp": "string"
        },
        "offlinePayExtInfo": {
            "acctNo": "string",
            "authCode": "string",
            "authMsg": "string",
            "billAmount": 1,
            "billCurrency": "string",
            "billRate": "string",
            "cardIssuerCode": "string",
            "cardSeqNo": "string",
            "cardType": "string",
            "cardValidity": "string",
            "currency": "string",
            "cvc2": "string",
            "dccRateCepOrderNo": "string",
            "entryMode": "string",
            "flightNumber": "string",
            "iccData": "string",
            "oldSysOriOrder": {
                "property1": {},
                "property2": {}
            },
            "pinData": "string",
            "pinLength": "string",
            "posDataExtendCode": "string",
            "posReserveData": {
                "acctType": "string",
                "ebusiness": "string",
                "exemptPswd": "string",
                "icCode": "string",
                "icVerify": "string",
                "msgReasonCode": "string",
                "mutualType": "string",
                "reserved": "string",
                "specialBillLevel": "string",
                "specialBillType": "string",
                "supportPartAndBal": "string",
                "termReadAbility": "string",
                "termType": "string",
                "transType": "string"
            },
            "posServiceData": {
                "address": "string",
                "buckleCard": "string",
                "cardHolderLevel": "string",
                "cardHolderScene": "string",
                "cardScene": "string",
                "countryCode": "string",
                "dataInput": "string",
                "dutyStatus": "string",
                "postalCode": "string",
                "preAuthValidDay": "string",
                "securityStatus": "string",
                "status": "string"
            },
            "processingCode": "string",
            "refNumber": "string",
            "sendOrgCode": "string",
            "serviceCode": "string",
            "serviceFeeData": {
                "feeAmount": 0,
                "feeCode": "string"
            },
            "simulateData": {
                "acqOrgCode": "string",
                "appendData": "string",
                "appendRespData": "string",
                "authMsg": "string",
                "channelCode": "string",
                "localTransDate": "string",
                "localTransTime": "string",
                "mchtMccCode": "string",
                "mchtName": "string",
                "platStlmAmount": 1,
                "platStlmDatetime": "string",
                "sendOrgCode": "string",
                "subMchtCode": "string",
                "subTermCode": "string",
                "tradeCode": "string",
                "transDatetime": "string"
            },
            "subMchtCode": "string",
            "subTermCode": "string",
            "sysTraceNo": "string",
            "tcc": "string",
            "terminalInfo": {
                "appVersion": "string",
                "areaNo": "string",
                "ctryNo": "string",
                "encryptRandNum": "string",
                "iccId": "string",
                "lbsNum1": "string",
                "lbsNum2": "string",
                "lbsNum3": "string",
                "lbsSignal1": "string",
                "lbsSignal2": "string",
                "lbsSignal3": "string",
                "location": "string",
                "locationCd1": "string",
                "locationCd2": "string",
                "locationCd3": "string",
                "mobileCountryCd": "string",
                "mobileNetNum": "string",
                "networkLicense": "string",
                "secretText": "string",
                "serialNum": "string",
                "telecomLbs": "string",
                "telecomNetId": "string",
                "telecomSysId": "string",
                "terminalId": "string",
                "terminalIp": "string",
                "terminalType": "string"
            },
            "track1Data": "string",
            "track2Data": "string",
            "track3Data": "string"
        },
        "onlinePayRefundReqExtInfo": {
            "mchtMccCode": "string",
            "mchtName": "string",
            "payerAcctNo": "string",
            "payerAcctType": "string",
            "payerBankId": "string",
            "platBatchNo": "string",
            "reqReserved": "string",
            "riskInfo": {
                "accountIDHash": "string",
                "customerIp": "string",
                "deviceId": "string",
                "deviceLanguage": "string",
                "deviceMode": "string",
                "goodsClass": "string",
                "iccId": "string",
                "iccIdCount": "string",
                "location": "string",
                "mac": "string",
                "mchntUsrRgstrEmail": "string",
                "mchntUsrRgstrTm": "string",
                "rcvCity": "string",
                "rcvProvince": "string",
                "riskReasonCode": "string",
                "riskScore": "string"
            },
            "subMchtAbbrName": "string",
            "subMchtCode": "string",
            "subMchtMccCode": "string",
            "subMchtName": "string"
        },
        "sapPayExtInfo": {
            "lowRateTransAmt": 0,
            "reqRealFeeAmt": 0
        }
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://d-phoenix-gap.easypay.com.cn:24443/yqt/unifiedRefund/apply' \
--header 'Content-Type: application/json' \
--data '{
    "reqBody": {
        "reqInfo": {
            "mchtCode": "string",
            "termCode": "string"
        },
        "reqOrderInfo": {
            "orgTrace": "string",
            "oriOrgTrace": "string",
            "oriOutTrace": "string",
            "oriTransDate": "string",
            "refundSource": "string",
            "refundAmount": 0,
            "promoRfAmount": 0,
            "backUrl": "string",
            "customInfo": "string",
            "handlingFee": 0
        },
        "payInfo": {
            "bizScen": "string",
            "bizType": "RealRefund",
            "payType": "WeChatPreRF",
            "refundMode": "Auto",
            "transDate": "string"
        },
        "qrCodeRefundExt": {
            "currency": "str",
            "operatorId": "string",
            "queryOption": [
                "string"
            ],
            "refundReason": "string",
            "storeCode": "string"
        },
        "dfPayOrderExtInfo": {
            "areaCode": "string",
            "bankNo": "string",
            "bizType": "string",
            "currency": "string",
            "deviceInfo": {
                "customerIp": "string",
                "deviceId": "string",
                "deviceImsi": "string",
                "iccId": "string",
                "location": "string",
                "mac": "string",
                "wifiMac": "string"
            },
            "oriMchtCode": "string",
            "oriPayAbilityCode": "string",
            "oriSubMchtCode": "string",
            "payeeAcctName": "string",
            "payeeAcctNameMask": "string",
            "payeeAcctNo": "string",
            "payeeAcctNoMask": "string",
            "payeeAcctType": "string",
            "payeeSignNo": "string",
            "payerAcctName": "string",
            "payerAcctNo": "string",
            "payerAcctType": "string",
            "remark": "string",
            "reqReserved": "string",
            "reserved": "string",
            "stlmMethod": "string",
            "summary": "string",
            "termType": "string",
            "usage": "string",
            "dgtlEnvlp": "string"
        },
        "offlinePayExtInfo": {
            "acctNo": "string",
            "authCode": "string",
            "authMsg": "string",
            "billAmount": 1,
            "billCurrency": "string",
            "billRate": "string",
            "cardIssuerCode": "string",
            "cardSeqNo": "string",
            "cardType": "string",
            "cardValidity": "string",
            "currency": "string",
            "cvc2": "string",
            "dccRateCepOrderNo": "string",
            "entryMode": "string",
            "flightNumber": "string",
            "iccData": "string",
            "oldSysOriOrder": {
                "property1": {},
                "property2": {}
            },
            "pinData": "string",
            "pinLength": "string",
            "posDataExtendCode": "string",
            "posReserveData": {
                "acctType": "string",
                "ebusiness": "string",
                "exemptPswd": "string",
                "icCode": "string",
                "icVerify": "string",
                "msgReasonCode": "string",
                "mutualType": "string",
                "reserved": "string",
                "specialBillLevel": "string",
                "specialBillType": "string",
                "supportPartAndBal": "string",
                "termReadAbility": "string",
                "termType": "string",
                "transType": "string"
            },
            "posServiceData": {
                "address": "string",
                "buckleCard": "string",
                "cardHolderLevel": "string",
                "cardHolderScene": "string",
                "cardScene": "string",
                "countryCode": "string",
                "dataInput": "string",
                "dutyStatus": "string",
                "postalCode": "string",
                "preAuthValidDay": "string",
                "securityStatus": "string",
                "status": "string"
            },
            "processingCode": "string",
            "refNumber": "string",
            "sendOrgCode": "string",
            "serviceCode": "string",
            "serviceFeeData": {
                "feeAmount": 0,
                "feeCode": "string"
            },
            "simulateData": {
                "acqOrgCode": "string",
                "appendData": "string",
                "appendRespData": "string",
                "authMsg": "string",
                "channelCode": "string",
                "localTransDate": "string",
                "localTransTime": "string",
                "mchtMccCode": "string",
                "mchtName": "string",
                "platStlmAmount": 1,
                "platStlmDatetime": "string",
                "sendOrgCode": "string",
                "subMchtCode": "string",
                "subTermCode": "string",
                "tradeCode": "string",
                "transDatetime": "string"
            },
            "subMchtCode": "string",
            "subTermCode": "string",
            "sysTraceNo": "string",
            "tcc": "string",
            "terminalInfo": {
                "appVersion": "string",
                "areaNo": "string",
                "ctryNo": "string",
                "encryptRandNum": "string",
                "iccId": "string",
                "lbsNum1": "string",
                "lbsNum2": "string",
                "lbsNum3": "string",
                "lbsSignal1": "string",
                "lbsSignal2": "string",
                "lbsSignal3": "string",
                "location": "string",
                "locationCd1": "string",
                "locationCd2": "string",
                "locationCd3": "string",
                "mobileCountryCd": "string",
                "mobileNetNum": "string",
                "networkLicense": "string",
                "secretText": "string",
                "serialNum": "string",
                "telecomLbs": "string",
                "telecomNetId": "string",
                "telecomSysId": "string",
                "terminalId": "string",
                "terminalIp": "string",
                "terminalType": "string"
            },
            "track1Data": "string",
            "track2Data": "string",
            "track3Data": "string"
        },
        "onlinePayRefundReqExtInfo": {
            "mchtMccCode": "string",
            "mchtName": "string",
            "payerAcctNo": "string",
            "payerAcctType": "string",
            "payerBankId": "string",
            "platBatchNo": "string",
            "reqReserved": "string",
            "riskInfo": {
                "accountIDHash": "string",
                "customerIp": "string",
                "deviceId": "string",
                "deviceLanguage": "string",
                "deviceMode": "string",
                "goodsClass": "string",
                "iccId": "string",
                "iccIdCount": "string",
                "location": "string",
                "mac": "string",
                "mchntUsrRgstrEmail": "string",
                "mchntUsrRgstrTm": "string",
                "rcvCity": "string",
                "rcvProvince": "string",
                "riskReasonCode": "string",
                "riskScore": "string"
            },
            "subMchtAbbrName": "string",
            "subMchtCode": "string",
            "subMchtMccCode": "string",
            "subMchtName": "string"
        },
        "sapPayExtInfo": {
            "lowRateTransAmt": 0,
            "reqRealFeeAmt": 0
        }
    }
}'

返回响应

🟢200

*/*

Body*/*

示例

{
    "rspBody": {
        "respStateInfo": {
            "appendRetCode": "string",
            "appendRetMsg": "string",
            "respCode": "string",
            "respDesc": "string",
            "transState": "string",
            "transStatusDesc": "string"
        },
        "respOrderInfo": {
            "bizType": "string",
            "orgInfo": "string",
            "orgTrace": "string",
            "oriOrgTrace": "string",
            "oriOutTrace": "string",
            "outTrace": "string",
            "pcTrace": "string",
            "productTrace": "string",
            "refundAmount": 0,
            "refundMode": "string"
        },
        "settleRespParamInfo": {
            "delaySettleFlag": "string",
            "fee": 0,
            "finalAmt": 0,
            "patnerSettleFlag": "string",
            "settleAmt": 0,
            "settleDate": "string",
            "settleTime": "string",
            "splitSettleFlag": "string"
        }
    },
    "rspHeader": {
        "easyPayCertificateId": "string",
        "rspCode": "string",
        "rspInfo": "string",
        "transCode": "string",
        "transSequence": "string"
    }
}

🟢201

🟠401

🟠403

🟠404