退款Refund

POST/api

产品说明

退款说明

支持全额退款
支持多次部分退款

退款时效是多少?

一般支持365天内退款

时序图

sequenceDiagram
Merchant->>UseePay Server: 调用/refund请求
UseePay Server->>Merchant: response[resultCode=pending]
UseePay Server--)Merchant: 异步通知notifyUrl退款结果

请求参数

Header 参数

Content-Type

string

可选

示例值:

application/x-www-form-urlencoded

Body 参数application/x-www-form-urlencoded

amount

string

必需

max=12 支付金额，单位为对应币种的最小货币单位ISO 4217

示例值:

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

示例值:

echoParam

merchantNo

string

必需

max=16 商户编号，由 USEEPAY 分配

示例值:

500000000007362

notifyUrl

string

可选

max=512 USEEPAY 回调商户地址

示例值:

https://gatewaytest.useepay.com/notifyV2u0

originalTransactionId

string

必需

max=64 原始预授权完成/支付商户订单号

示例值:

754ae22f-4e66-4ebf-9e0e-d7216125177e

sign

string

必需

max=256 商户请求参数的签名串

示例值:

7d7ddf63b857946a736ce3471427ba53

signType

string

必需

max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5

示例值:

MD5

transactionId

string

必需

max=64 商户订单号，建议每次请求的 transactionId 唯一，有利于后续订单查询和对账。

示例值:

202305280850422

transactionType

string

必需

max=18 交易类型：refund

示例值:

refund

version

string

必需

max=5 调用的接口版本，固定为：1.0

示例值:

1.0

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

amount

string

必需

max=12 支付金额，单位为对应币种的最小货币单位ISO 4217

resultCode

enum<string>

可选

max=32 业务结果（详见业务结果码）

枚举值:

sign

string

参数的签名串

必需

errorCode

string

可选

错误码（详见错误码 errorCode）

transactionId

string

必需

max=64 商户订单号，需保证在商户端不重复

errorMsg

string

可选

错误码（详见错误码 errorMsg）

transactionType

string

必需

max=18 refund

reference

string

可选

max=64 USEEPAY 订单号

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

originalTransactionId

string

可选

max=64 原始预授权完成/支付商户订单号

reserved

string

可选

signType

string

必需

max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5

currency

string

必需

merchantNo

string

必需

max=16 商户编号，由 USEEPAY 分配

{
    "amount": "1", 
    "resultCode": "pending",
    "sign": "035bfd3acf5732e6ce9c9f772bf85158",
    "errorCode": "0000",
    "transactionId": "202110141059261", // 商户订单号，需保证在商户端不重复
    "errorMsg": "Approved or completed successfully",
    "transactionType": "refund", // 交易类型：refund
    "reference": "1062110141059650859", 
    "echoParam": "echoParam",
    "originalTransactionId": "202110141054086",
    "reserved": "reserved",
    "signType": "MD5",
    "currency": "USD",
    "merchantNo": "500000000007381" // 商户编号，由 USEEPAY 分配
}

最后修改时间： 1 年前