WorldFirst DocsWorldFirst Docs

applyRefund需要签名验签

POST /amsin/api/v1/business/worldtrade/applyRefund

付款完成后,集成商可调用此API发起退款申请。WorldTrade目前仅支持单笔交易退款。

  • 在申请退款之前,调用 queryTradeOrder 接口获取退款所需的 paymentResultList.paymentOrderId 参数;
  • 退款请求成功后,您会在预计七个工作日内收到退款,具体到账时间取决于原支付方式处理时效。

报文结构

万里汇接口的报文结构包括:请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息,参见:

入参

requestId String  REQUIRED

针对本次退款请求,由集成商指定的唯一请求号。

更多信息:

  • 此为幂等字段。
  • 最大长度:64 字符

tradeId String  REQUIRED

WorldTrade系统生成的订单ID。

更多信息:

  • 最大长度:64 字符

paymentOrderId String  REQUIRED

支付单ID。

调用 queryTradeOrder 接口以获取此字段。

更多信息:

  • 最大长度:64 字符

refundAmount Amount  REQUIRED

退款金额。

WorldTrade 目前仅支持全额退款,该字段取值应为订单总额。

Show child parameters

remark String  

退款备注。

更多信息:

  • 最大长度:256 字符

出参

result Result  REQUIRED

代表 API 接口调用结果。

Show child parameters

refundOrderId String  REQUIRED

退款单ID。

此字段只有当 result.resultStatus = S 时才会按需返回。

API Explorer

请求

URL
请求体

响应

响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:

result.resultStatus

描述

S

API请求成功。

F

API请求失败。

失败原因参见结果码(即 result.resultCode 和 result.resultMessage

U

API响应结果为UNKNOWN(未知)时,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。

result.resultCode:系统结果码

结果码结果码信息行动建议
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do Not retry.

需要人工介入,联系万里汇技术支持以解决此问题

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

确认请求正确加签

INVALID_SIGNATUREFThe signature is invalid.

确认请求正确加签

REPEAT_REQ_INCONSISTENTFRepeated requests are inconsistent.

重试请求不一致,需保证所有请求参数均相同

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题

FILE_SIZE_EXCEED_LIMITFThe file size has exceeded the limit.

文件大小需在允许范围内。

CONTRACT_CHECK_FAILFThe contract check has failed.

检查合约状态后重试

result.resultCode:业务结果码

结果码结果码信息行动建议
SYSTEM_EXCEPTIONFSystem exception.

需要人工介入,联系WorldTrade客户服务经理以解决此问题

ORDER_NOT_EXISTFThe order does not exist.

修改tradeId 参数后重试

REFUND_FAILED_DUE_TO_CHARGEBACKFThe refund order failed because chargeback exists.

订单存在拒付,本次退款受理失败,请确保订单资金状态正常后重试。

REFUND_PERIOD_EXPIREDFThis payment is no longer eligible for refunds as the refund period for this transaction has ended.

订单已超过退款周期,不再支持退款。

REFUND_FAILED_TRY_AGAIN_LATERFRefund failed, please try again later

本次退款受理失败,请稍后重试。