主题
余额退款
接口描述
客户调用甬易接口进行余额退款。
请求URL
/his/account/balance/refund
请求方式
- POST
公共请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | 是 | string | 应用ID | app123 | |
| signature | 是 | string | 签名 | xxx | |
| transNonce | 是 | string | 32 | 请求流水号 | req20260415004 |
| transDate | 是 | string | 请求时间,13位时间戳 | 1731406784607 |
请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| custFlag | 是 | string | 客户输入凭证:0-身份证;1-甬易支付登陆用户名 | 0 | |
| customerId | 是 | string | 凭证信息(身份证号码或甬易支付登陆用户名),AES加密 | encrypted_xxx | |
| customerPwd | 是 | string | 医疗密码 | pwd123 | |
| mcryptKey | 是 | string | 密码随机数 | key123 | |
| outRefundNo | 是 | string | 退款订单号 | REFUND20260415001 | |
| outTradeNo | 是 | string | 原消费订单号 | ORD20260415001 | |
| refundAmt | 是 | string | 退款金额,单位分 | 5000 | |
| transIP | 是 | string | 交易IP | 192.168.1.1 |
请求报文示例
json
{
"appId": "app123",
"signature": "xxx",
"transNonce": "req20260415004",
"transDate": "1731406784607",
"custFlag": "0",
"customerId": "encrypted_xxx",
"customerPwd": "pwd123",
"mcryptKey": "key123",
"outRefundNo": "REFUND20260415001",
"outTradeNo": "ORD20260415001",
"refundAmt": "5000",
"transIP": "192.168.1.1"
}公共响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | 是 | string | 响应编码 | 00000000 | |
| message | 是 | string | 响应信息 | 成功 | |
| signature | 是 | string | 签名 | xxx | |
| transNonce | 是 | string | 32 | 请求流水号(同入参) | req20260415001 |
| transDate | 是 | string | 响应时间,13位时间戳 | 1731406784607 |
响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| balance | 是 | string | 甬易余额,单位分 | 60000 | |
| avlBalance | 是 | string | 甬易可用余额,单位分 | 60000 | |
| tradeNo | 是 | string | 甬易订单流水号 | TRAN20260415001 |
响应示例
json
{
"code": "00000000",
"message": "成功",
"signature": "xxx",
"transNonce": "req20260415001",
"transDate": "1731406784607",
"balance": "60000",
"avlBalance": "60000",
"tradeNo": "TRAN20260415001"
}备注
- 更多返回错误代码请看 通用规则说明-错误码 的错误代码描述