Open API Reference for Bluepay

# 4. 扣款接口

# 简要描述

  • 商户代付-代扣扣款接口

# 请求URL

  • {domain}/open-api/jt/direct/debit/pay

# 请求方式

  • POST

# 请求头

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

# 请求体参数

参数名 必选 类型 说明
appId 是 string 应用APPID
param 是 string 参数体
sign 是 string 签名

# param参数

参数名 必填 类型 长度限制 示例 说明
timestamp 是 long - 1677495496979 当前时间戳
mchOrderId 是 string 1-32 CCP20220428011068111 商户订单id, 格式：字母+数字，1-32位
amount 是 long - - 收款金额，单位分
channelCode 是 string - 参考列表 Platform收单渠道Code
payToken 是 string - - 代扣token
businessType 否 integer - - 业务类型， 1、直营店（不传默认为-直营店） 2、加盟店
projectType 否 string - - 项目类型， 'PPCASH','VIP'（不传默认为'PPCASH'）
items 否 List - - 子订单详情
notifyUrl 是 string 1-256 - 扣款通知 URL
remark 否 string 1-256 - 收单备注

# item 参数说明

参数名 必选 类型 description
subOrderId 是 string 子订单编号 格式：字母+数字，1-32位
customerName 否 string 用户姓名，格式：字母+空格，1-100位, "firstName middleName lastName" (middleName 非必填)
customerMobile 否 string 用户手机号(手机格式：06,08,09+8位数字（共10位）座机格式：02,03,04,05,07+7位数字（共9位）)
amount 是 long 金额必传例如500.10, 需要设置50010分
email 否 string 用户邮箱
regionNo 是 string 大区编码(1-50 位);支持大小写字母和数字
branchNo 是 string 网点编码(1-100 位);支持大小写字母和数字
courierNo 是 string 快递员编码(1-100 位);支持大小写字母和数字
courierName 否 string 快递员姓名(1-50 位)
courierMobile 否 string 快递员手机号(手机格式：06,08,09+8位数字（共10位）座机格式：02,03,04,05,07+7位数字（共9位）)

# 请求示例

# 请求体

{
   "appId": "733b887a4a784708bb369524db5b6ded",
   "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "param": "{\"timestamp\":1715595802,\"mchOrderId\":\"10e5595801938341100\",\"channelCode\":\"BLUEPAY_DIRECT_DEBIT\",\"amount\":10000,\"remark\":\"remark\",\"notifyUrl\":\"https://www.test.com\",\"payToken\":\"TK1U2ODY9EPKRSOSU9\"}"
}

如何构造请求体

# 响应参数

参数名 类型 说明
code integer 响应码
message string 响应信息
data Object 数据

# data参数

参数名 类型 说明
mchOrderId string 商户订单号
transactionId string 交易编号
transactionStatus string 交易状态（PENDING ， COMPLETED ， FAILED）
channelCode string 收单渠道Code
businessType integer 业务类型 ( 1、Direct Sale Store 2、Franchisees )
projectType string 项目类型 (PPCASH,VIP)

# 响应示例

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "10e051066810618100",
    "transactionId": "CU510579106014826496",
    "transactionStatus": "COMPLETED",
    "channelCode": "BLUEPAY_DIRECT_DEBIT",
    "businessType": 1,
    "projectType": "PPCASH"
  }
}

响应码集合

# 返回失败案例

{
    "code":21016,
    "message":"Merchant ip forbidden"
}

← 5. 代扣渠道列表 →