实时退款 - 易企通1.0

场景说明
退货接口，用于合单支付、带有分账标签、无分账标签的原支付订单退货退款，支持部分退款、全额退款。
退款金额规则说明：
1、原订单有分账标签：退款申请金额须小于等于原支付订单剩余可退金额，即原订单未分账的金额均可退款。
2、原订单无分账标签：退款申请金额须小于等于原支付订单剩余可退金额（部分退款情况下存在已退金额，订单剩余可退金额=原订单金额-已退款金额），且小于等于商户当日正向交易余额（正向交易金额-已退款金额）。
（1）举例1：昨日仅发生一笔正向交易金额400元（待今日结算），今日正向交易500元，第一笔退款300元可成功，第二笔退款为昨日订单的全额退款400元（大于此时“当日正向交易余额”200元），因此退款失败。
（2）举例2：昨日仅发生一笔正向交易金额400元（待今日结算），今日仅发生一笔正向交易500元，第一笔退款为昨日订单的全额退款400元可成功，第二笔退款为今日正向交易的全额退款500元（大于此时“当日正向交易余额”100元），因此退款失败。

接口流程描述
1、无需分账的原订单退款、分账前发起退款可调用该接口
2、分账当日的退款可先发起“分账撤销”后再调用本接口，退款金额需小于等于待分账金额（=清算总额-已分账金额-已退款金额），若大于则会退款失败，或可选择极速退款
3、原支付订单带分账标签的退款，同一笔订单部分退款次数不多于20次
4、合单支付后的总单退款或子单退款，也调用该接口，上送总订单号或子订单号即可
5、满足要求的退款将实时原路退回

请求参数

Body 参数application/json

orgId

string

机构号

必需

易生分配的编号

>= 15 字符<= 15 字符

示例值:

ORG000000001215

orgMerCode

string

商户号

必需

易生入网下发示例值:531000013027106

>= 15 字符<= 15 字符

示例值:

531000013027106

orgTermNo

string

终端号

必需

终端号示例值:W1486540,易生入网下发

orgTrace

string

交易流水

必需

orgId 前四位+后四位+yyyyMMddhhmmss+6位自定义合计28位长度

>= 28 字符<= 28 字符

示例值:

ORG073031190202304251234200048

prodCode

string

产品代码

必需

业务产品码，云易收为ISYH

sign

string

签名

必需

签名根据指定的签名方法计算出来的签名

signType

string

签名方式

必需

见签名方式,仅支持RSA。

orgSmercode

string

下游机构商户唯一标识

可选

orgInfo

string

请求方自定义信息

可选

JSON格式，原样返回

sysRetCode

enum<string>

系统应答

可选

枚举值:

00XX060799982511202122232427515253545556575A60616270818286878A8B8C8D8E919293949596979A9B9C9D9E9FC0C1000086

orgGpstype

string

GPS坐标系

可选

GPS坐标系（WGS84、GCJ02、BD09）

orgLongitude

string

经度

可选

经度

orgLatitude

string

维度

可选

维度

orgBasestation

string

基站信息

可选

基站信息

orgDeviceIp

string

交易设备IP

可选

交易设备IP

bizData

object

业务请求数据

必需

业务请求数据把具体的业务请求列表中的数据转换成json格式

oriOrgTrace

string

原机构交易流水号

必需

原机构交易流水号

OriOutTrace

string

原交易商户流水号

可选

原支付成功时返回或者用户账单凭证条码下面的那串数字

oriBizDate

string

原交易日期

必需

原交易日期

transAmt

string

退货金额

必需

单位：分，字符串

示例

{
  "orgId": "ORG000000001215",
  "orgMerCode": "531000013027106",
  "orgTermNo": "string",
  "orgTrace": "ORG073031190202304251234200048",
  "prodCode": "string",
  "sign": "string",
  "signType": "string",
  "orgSmercode": "string",
  "orgInfo": "string",
  "sysRetCode": "00",
  "orgGpstype": "string",
  "orgLongitude": "string",
  "orgLatitude": "string",
  "orgBasestation": "string",
  "orgDeviceIp": "string",
  "bizData": {
    "oriOrgTrace": "string",
    "OriOutTrace": "string",
    "oriBizDate": "string",
    "transAmt": "string"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

orgId

string

机构号

必需

易生分配的编号

>= 15 字符<= 15 字符

示例值:

ORG000000001215

orgMerCode

string

商户号

必需

易生入网下发示例值:531000013027106

>= 15 字符<= 15 字符

示例值:

531000013027106

orgTermNo

string

终端号

必需

终端号示例值:W1486540,易生入网下发

orgTrace

string

交易流水

必需

orgId 前四位+后四位+yyyyMMddhhmmss+6位自定义合计28位长度

>= 28 字符<= 28 字符

示例值:

ORG073031190202304251234200048

prodCode

string

产品代码

必需

业务产品码，云易收为ISYH

sign

string

签名

必需

签名根据指定的签名方法计算出来的签名

signType

string

签名方式

必需

见签名方式,仅支持RSA。

orgSmercode

string

下游机构商户唯一标识

可选

orgInfo

string

请求方自定义信息

可选

JSON格式，原样返回

sysRetCode

enum<string>

系统应答

必需

枚举值:

00XX060799982511202122232427515253545556575A60616270818286878A8B8C8D8E919293949596979A9B9C9D9E9FC0C1000086

orgGpstype

string

GPS坐标系

可选

GPS坐标系（WGS84、GCJ02、BD09）

orgLongitude

string

经度

可选

经度

orgLatitude

string

维度

可选

维度

orgBasestation

string

基站信息

可选

基站信息

orgDeviceIp

string

交易设备IP

可选

交易设备IP

bizData

object

业务请求数据

必需

业务请求数据把具体的业务请求列表中的数据转换成json格式

tradeRetCode

string

交易状态码

必需

交易状态码

tradeRetMsg

string

交易状态描述

必需

交易状态描述

transAmt

string

退货金额

必需

单位：分，字符串

pcTrace

string

渠道流水号

必需

成功时返回

outTrace

string

商户流水号

必需

成功时返回

stlmDate

string

清算日期

必需

成功时返回

示例

{
  "sysRetCode": "000007",
  "sysRetMsg": "原订单获取失败,稍后重试",
  "orgId": "ORG000000001136",
  "orgMerCode": "531000013010845",
  "orgTermNo": "32812114",
  "prodTrace": "",
  "orgTrace": "ORG0478520230221150236ub2yf7",
  "prodCode": "",
  "sign": "Xht9/B6/k28gZY+JDY5dYF84qHPkk7MM8wcJsvwavoQD9Dk4G78Z40vhQj3CLLDtJvVM8eLDWzPQgcMUBlL7lsuDEu+2cGNUxR7H9/oqjcjEbRWVgyXjHzCvNv1vpF5WSiLSJ1+qd4JTbNiCQ+AZAq7jwMmJRQKeHlXZKTFUiAw=",
  "signType": "SHA256withRSA",
  "bizData": {
    "tradeRetCode": "07",
    "tradeRetMsg": "原订单获取失败,稍后重试",
    "oriOrgTrace": "ORG0651620230415110635201598",
    "transAmt": "10"
  }
}