refund.md 3.1 KB

退款

接口说明

1. 接口功能说明

该接口为接入商家提供交易退款的功能。

(1)接口补充说明

  • 该接口在消费交易成功后发起,要求指定原订单号
  • 外卡交易当日不能做退款,可以做撤销,只能隔日退款
  • 正常情况下,商户当日退款金额,不得大于当日成功交易额

(2)接口交易流程

请求路径

POST /api/v5/refund

请求参数

参数 类型 必填 描述
orderNum String 退款订单号:商户自行定义,需保证同一商户号下退款订单号不能重复
origOrderNum String 原支付订单号
returnAmount String 退款金额:如 100 元,表示为 100 或 100.00
orderCurrency String 订单币种:ISO标准 如:人民币填写“CNY”,美元填写"USD"
merID String 商户 ID,由 GoAllPay 分配
paymentBrand String 支付品牌
transTime String 交易时间,格式:"yyyyMMddHHmmss"
backURL String 退款结果异步通知到该URL。退款成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知退款结果(详见退款结果通知-回调)。商户在接收到通知后,需响应字符串“OK”。
如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 15, 30, 180, 1800, 3600, 7200, 14400],单位为秒。
signType String SHA256
signature String 签名

响应参数

参数 类型 必填 描述
transType String “REFD”
orderNum String 退款订单号
transID String GoAllPay流水号
merID String 商户 ID
paymentBrand String 支付品牌
respCode String 应答码 00-成功,01-失败。详情见本文档第5章应答码
respMsg String 应答消息
transTime String 交易时间,格式:"yyyyMMddHHmmss"
gwTime String yyyyMMddHHmmss,为 GW 时间,目前为本地交易时间
returnAmount String 退款金额
orderCurrency String 订单币种
signType String SHA256
signature String 签名