Webhook

接口描述

通知信息，包括卡余额变动、3ds 消息等。

接口地址

由后台设置

请求方式

POST
Content-Type: application/json

指数退避

如遇推送失败，建议使用指数退避算法进行重试，例如初次失败后 1 秒，第二次 2 秒、4 秒、8 秒等递增，最多重试五次。

请求参数

参数名	必填	类型	示例	说明
type	是	string	3ds	通知类型
data	是	string	jsonString	通知信息（JSON字符串）
appKey	是	string	edy2378eh23gf29w2	appKey
sign	是	string	a87694dbd3be64a356a42be95e123360	接口签名

请求示例

{
  "data": "{\"id\":\"e6a54b44-1a38-4d51-824c-6f7bf6e1fb3e\",\"currency\":\"USD\",\"amount\":\"9\",\"type\":\"TopUp\",\"cardNo\":\"5592922156696856\",\"status\":\"Closed\",\"transactionTime\":\"2024-11-29T07:14:18.157Z\"}",
  "sign": "dc227220340c874fec3bba43bad08b32",
  "appKey": "psqxrezci72955wqxlhar898vx2q8lts",
  "type": "CardTransaction"
}

响应示例

body 内容直接返回字符串 ok

ok

各通知类型说明

1. CardTransaction（卡交易通知）

参数名	必填	类型	示例	说明
id	是	string	fb68813f-61cd-4d17-8265-4b5dd71ec405	流水ID
cardNo	是	string	5592922156696856	卡号
currency	是	string	USD	币种
amount	是	string	9	金额
type	是	string	TopUp	类型
status	是	string	Closed	状态
detail	否	string	METAPAY*ADS fb.me/ads IE	消费详情
transactionTime	是	string	2024-11-29T07:14:18.157Z	发生时间

type 枚举值

值	说明
TopUp	充值
Consumption	消费
Fee	消费手续费
Auth	授权
Credit	退款
Reversal	冲正
FrozenCard	冻结
UnFrozenCard	解冻
CardStateChange	卡状态变更
DeleteCard	注销卡（据此回退金额和销卡处理）

status 枚举值

值	说明
Pending	处理中
Approve	成功
Fail	失败

2. DeleteCard（销卡通知）

参数名	必填	类型	示例	说明
cardNo	是	string	5592922156696856	卡号
currency	是	string	USD	币种
status	是	string	Inactive	状态
userName	是	string	as aa	用户名
createTime	是	string	2021-08-30T11:59:32.935Z	创建时间
cardNoLastFour	是	string	9990	卡后四位

status 枚举值

值	描述
Active	使用中
Frozen	冻结
Inactive	注销

3. Card3dsOtp（3ds 验证码）

参数名	必填	类型	示例	说明
cardNo	是	string	5592922156696856	卡号
currency	是	string	USD	币种
amount	是	string	9	金额
otp	是	string	1234321	OTP
detail	是	string		交易信息

4. ThreeDomainSecureForwarding（3ds 跳转）

备注：有些卡需要跳转指定页面提交验证码

参数名	必填	类型	示例	说明
cardNo	是	string	5592922156696856	卡号
currency	是	string	USD	币种
amount	是	string	9	金额
detail	是	string		交易信息
timestamp	是	long	1725350485682	时间戳
expirationTime	是	long	1725350785682	过期时间
url	是	string	1234321	跳转地址提交验证码

Keyboard shortcuts

api