Skip to main content
POST
直付订单退款

概述

本页说明 POST /payment/open/institution/v1/pay/address/refund 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。 对直付地址支付单发起退款,只支持直付地址支付单。

说明

  • 认证方式使用 GatePay 标准签名请求头。
  • 本页展示同一接口的机构路径版本。
  • 除创建子账户、查询子账户详情、分页查询子账户外,机构侧请求需携带 X-GatePay-On-Behalf-Of
  • 商户退款请求号字段为 refundRequestId(不要使用已废弃的 refundGateId)。
  • 响应为标准 status / code / errorMessage / data 包装,业务字段在 data 内。
  • 通用签名规则请参见 /api-reference/version/100/cn/common/securityAndSignature

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID

示例:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
必填

签名

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8"

X-GatePay-Timestamp
string
必填

毫秒级时间戳,与服务端时间偏差不得超过30秒

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数

示例:

"9578"

X-GatePay-On-Behalf-Of
string
必填

必填代理归属请求头。请填写本次请求的发起方账户 ID;在机构代理商户 API 中通常填写目标子账户 ID,在机构代扣与划转接口中可填写机构账户 ID 或子账户 ID。

请求体

application/json
prepayId
string
必填

对应支付单订单id

refundRequestId
string
必填

商户退款请求号

refundAmount
string

退款金额

refundReason
string

退款原因

receiverId
integer<int64>

地址支付退款接收人在gate系统的user_id

响应

200 - application/json

成功响应

标准响应包装;业务字段在 data 内

status
string

状态

示例:

"SUCCESS"

code
string

业务码

示例:

"000000"

errorMessage
string

错误信息

data
object

直付地址支付退款业务数据