USEEPAY
  1. 订单通用接口
USEEPAY
  • 全球收单
    • 域名说明
    • 集成流程说明
    • 生产账户启用
    • UseePay出口IP说明
    • 签名指导
      • 签名
      • 验签
      • demo
    • 沙盒测试资源
      • 测试卡号
      • 信用卡测试案例
      • 退款测试案例
      • 本地化测试案例
      • ApplePay&& Google Pay测试用例
    • 跳转式收银台接口
      • 跳转收银台paymentMethod参数说明
      • 支付/预授权
    • 内嵌式收银台接口
      • 0.0.1-只支持信用卡
        • 内嵌收银台快捷支付
        • 内嵌收银台新版本更新说明
        • 内嵌收银台对接说明
      • 新版-支持信用卡+AP+GP
        • 内嵌收银台2.0.0版本说明
      • create token 创建JSSDK所需的token
    • 订单通用接口
      • 退款Refund
        POST
      • 查询Query
        POST
      • 预授权撤销(Void)
        POST
      • 预授权完成(Capture)
        POST
    • 本地化支付
      • 本地化汇总
      • 本地化接口
        • 便利店支付
          • konbini
            • konbini 收银台模式
            • konbini api模式
          • payeasy
            • payeasy api 模式
            • payeasy 收银台模式
        • 分期付款Pay Later
          • Klarna产品介绍
          • Klarna direct
          • Klarna Redirect
        • 电子钱包
          • Alipay
            • Alipay Direct 文档
            • alipay_cn/alipay_hk direct 文档
          • Wechat-HK
            • 扫码支付
              • 扫码支付
              • direct
                • 扫码支付 Server To Server模式
              • redirect
                • 扫码支付收银台模式(wechat_native)
            • Jsapi支付下单接口
              • 小程序支付
              • 微信公众号支付
              • Jsapi支付下单接口
            • H5支付
              • H5支付
          • Google Pay
            • GoogePay Test card
            • Google Pay 对接可能遇到的问题
            • redirect
              • 跳转式GooglePay收银台
            • api
              • Google Pay API对接
              • Googlepay API 支付
          • applepay
            • ApplePay 扩展
            • ApplePay API
              • ApplePay API接入流程
              • ApplePay API接入流程备份
              • ApplePay Merchant Identifier
              • ApplePay支付
              • ApplePay商户Session
            • applepay cashier
              • applepay 跳转收银台
          • applepay&googlepay内嵌
            • 1.0.0 内嵌方式对接 (建议使用“内嵌方式对接2.0.0”版本)
            • 内嵌方式对接2.0.0
        • 银行转账
          • pix
          • Giropay
            • Giropay_Redirect
            • Giropay_Direct
          • sofort
            • sofort_Redirect
            • sofort_Direct
          • bancontact
            • bancontact_Redirect
          • Ideal
            • Ideal_Redirect
            • Ideal_Direct
          • boleto
            • boleto_Direct
        • 本地化Card
        • Cash(Ticket)现金支付
          • oxxo
          • boleto
          • Cash Common
      • 支付方式(国家/地区)
        • 荷兰
        • 巴西
        • 墨西哥
        • 中国香港
        • 日本
        • 德国
        • 奥地利
        • 西班牙
        • 波兰
        • 意大利
        • 哥伦比亚
        • 比利时
        • 瑞士
    • 通用对象参数和规范说明
      • 参数对象说明(过期)
      • 业务结果码(ResultCode)
      • 错误码(ErrorCode)
      • 金额和货币单位
      • 国家信息参考
      • 对象模型
        • userInfo
        • shippingAddress
        • goodsInfo
        • billingAddress
        • deviceInfo
        • transactionInfo
    • 通知接口说明
      • 交易通知
        • 同步通知
        • 异步 webhook版本升级
        • webhook
      • 拒付
        • 拒付webhook
    • 物流接口
      • 物流信息上送
        • 物流信息上传2.1
        • 物流信息上传(已废弃)
      • 物流信息查询
        • 物流信息查询2.1
        • 物流信息查询(已废弃)
    • 拒付接口
      • 拒付流程说明
      • 拒付查询
    • SFTP
      • SFTP
    • 常见问题
      • 支付和预授权的区别
    • demo
    • 插件安装指导
      • magento插件支付安装
        • Wechat/Alipay/UseePay Payments
    • 订阅
      • 订阅文档
  • 产品说明
    • 收银台
    • 内嵌式收银台
    • Server To Server 直连
  • FAQ
    • 集成和认证
    • 常见问题解答
    • ueeshop配置常见错误
    • ApplePay常见问题
  1. 订单通用接口

退款Refund

全球收单-SandBox环境
全球收单-SandBox环境
POST
/api

产品说明#

退款说明#

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

退款时效是多少?#

一般支持365天内退款

时序图#

请求参数

Header 参数
Content-Type
string 
可选
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
amount
string 
必需
max=12 支付金额,单位为对应币种的最小货币单位ISO 4217
示例值:
1
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

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://pay-gateway1.uat.useepay.com/api' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'amount=1' \
--data-urlencode 'echoParam=echoParam' \
--data-urlencode 'merchantNo=500000000007362' \
--data-urlencode 'notifyUrl=https://gatewaytest.useepay.com/notifyV2u0' \
--data-urlencode 'originalTransactionId=754ae22f-4e66-4ebf-9e0e-d7216125177e' \
--data-urlencode 'sign=7d7ddf63b857946a736ce3471427ba53' \
--data-urlencode 'signType=MD5' \
--data-urlencode 'transactionId=202305280850422' \
--data-urlencode 'transactionType=refund' \
--data-urlencode 'version=1.0'

返回响应

🟢200成功
application/json
Body
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 分配
}
修改于 2025-04-10 09:21:08
上一页
create token 创建JSSDK所需的token
下一页
查询Query
Built with