API Doc

# 5 静态VA收单校验接口

重要：目前仅支持 ALFAMART_VA

# 说明

该接口由商户实现，作用是在用户还款前调用该接口校验是否允许收单并获取收单具体信息，如金额。

# HTTP请求信息

# URL

由商户提供

# 请求方式

POST

# 请求头

参数名 必选 类型 说明
Content-Type mandatory string application/json

# 请求体参数

参数名 必选 类型 长度限制 示例 说明
param 是 string - - 参数体
sign 是 string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 签名

# param 参数

参数名 是否必填 类型 说明 备注
eventName 是 string 事件名称（ payment.verification）
mchOrderId 是 string 商户订单号
channelCode 是 string 渠道码
amount 视情况而定 long 金额 channelCode不是ALFAMART_VA时，必填
referenceNumber 是 string 还款码
mobile 是 string 手机号
createTime 是 string 查询创建时间

# 请求体示例

ALFAMART_VA

{
  "param": "{\"eventName\":\"payment.verification\", \"mchOrderId\":\"TestMchOrderIdP0057\", \"channelCode\":\"ALFAMART_VA\", \"referenceNumber\":\"00004000011000000001\", \"mobile\":\"0812345678\", \"createTime\":\"2023-12-12 10:21:23\"}",
  "sign": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892"
}

其他渠道

{
  "param": "{\"eventName\":\"payment.verification\", \"mchOrderId\":\"TestMchOrderIdP0057\", \"channelCode\":\"XXX_VA\", \"amount\": 10000, \"referenceNumber\":\"12345678\", \"mobile\":\"0812345678\", \"createTime\":\"2023-12-12 10:21:23\"}",
  "sign": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892"
}

# 返回

# 返回参数

参数名 是否必填 类型 说明
code 是 int 状态码
message 是 string 描述信息
data 是 object 数据详情

# data

参数名 是否必填 类型 说明 备注
amount 视情况而定 long 订单金额 channelCode是ALFAMART_VA时, 必填

# code说明

状态码 描述信息
2000 成功
1000 拒绝收单
1001 商户自定义错误(展示给用户)
1002 金额超出限制
1003 交易过期
1004 交易不存在

# 返回示例

ALFAMART_VA渠道 成功示例

{
  "code": 2000,
  "message": "Success",
  "data": {
    "amount": 10000
  }
}

其他渠道 成功示例

{
  "code": 2000,
  "message": "Success"
}

拒绝收单示例 1000

{
  "code": 1000,
  "message": "Decline"
}

拒绝收单示例 1001

{
  "code": 1001,
  "message": "<商户自定义错误(展示给用户)>"
}

拒绝收单示例 1002

{
  "code": 1002,
  "message": "Amount exceeds the limit error"
}

← 1 收款下单接口 →