退款通知

请求头

x-eventName

any

通知种类

示例:

"GlobalAccount"

x-timestamp

any

必填

毫秒级 Unix 时间戳，例如 1357872222592。

示例:

1357872222592

x-signature

string

必填

请求体的 HMAC 十六进制摘要。如果 webhook 配置了 secret，则会发送该头部。该 HMAC 摘要通过 SHA-256 哈希函数和 secret 作为 HMAC 密钥生成。

请求体

application/json

code

string

必填

回调通知码，00000000代表有效回调.

示例:

"00000000"

message

string

必填

回调通知码描述，Success.

示例:

"Success"

traceId

string

必填

请求消息唯一标识。traceId为本次调用产生的流水号，接口调用异常，可以提供此流水号用于排查问题。

示例:

"33fae7b7aed1233f"

merchantId

string

必填

商户Id

Maximum string length: 15

示例:

"206612664561"

notifyTime

string

必填

通知时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX

Maximum string length: 32

notifyType

string

必填

通知类型 PAYMENT

Maximum string length: 16

data

object

返回的业务数据

Hide child attributes

data.merchantOrderId

string

必填

商户退款单号

Maximum string length: 64

示例:

"20230424141154"

data.orderId

string

必填

PayLoco退款流水号

Maximum string length: 64

示例:

"TR1648561479508692992"

data.refundAmount

string

必填

退款金额，金额的单位为元。

示例:

"100.01"

data.refundCurrency

string

必填

退款币种ISO4217币种的字母码 eg. USD, CNY, EUR

Maximum string length: 3

示例:

"USD"

data.status

enum<string>

必填

状态

可用选项:

SUCCESS,

FAILED

示例:

"SUCCESS"

data.completeTime

string<date-time>

必填

订单完成的时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ssSSS+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.262+08:00表示，北京时间2015年5月20日13点29分35秒。

示例:

"2024-07-18T17:19:59.74+08:00"

data.errorCode

string

必填

订单返回码

示例:

"00000000"

data.errorMsg

string

必填

订单返回码描述

示例:

"Success"

data.oriMerchantOrderId

string

原商户订单号

示例:

"20230424141154"

data.country

string

用户支付的国家代码，大写字母

示例:

"US"

响应

200 - application/json

code

string

必填

响应状态码

示例:

"00000000"

message

string

必填

错误消息

示例:

"成功"

API 文档

收单

付款

WEBHOOKS

请求头

请求体

响应