一、文档说明

1. 写在前面2. 错误代码表

二、安全认证与签名

1. 签名方法2. AES加解密

三、结算公司和资金余额

1. 资金池余额查询2. 税源地公司信息查询

四、实时发放

1. 接口使用流程2. 实时发放数据上报3. 查询实时发放数据4. 实时发放回调通知5. 申请实时发放业务账单6. 查询实时发放业务账单申请状态7. 申请实时发放业务回单

五、业务级错误代码

1. 实时发放接口错误代码2. 数据格式正则校验失败code

六、枚举类型

1. 证件类型2. 支付宝支付交易失败code3. 交易状态4. 导出状态
2. 实时发放数据上报
  • 生产环境平均到账时间在1-3分钟左右,测试环境不能真实到账。

  • 当接口连接超时或者反馈ERROR时,请不要更换业务流水号,一定要使用原业务流水号重试,否则可能造成重复支付等资金风险。同一个流水号只能上报一次,重复上报接口将提示订单号重复错误。

  • 请您在自身系统中合理设置付款频次并做好并发控制,防范错付风险,因您自身系统设置存在问题导致的资金损失,由您自行承担。

  • 企业余额扣减计算公式:接口上报金额(用户实际到账金额)+ (接口上报金额服务费比例);例,打包价6%,张三提现1000 ,则余额扣减 = 1000+(10000.06)=1060

单笔付款区间:0.3-50000

请求URL

pay/singleSubmit

公共请求参数

参数名 必选 类型 说明
plat string 来源,本接口固定值:api
version string 接口版本, 本接口固定值:100000
access_key string 平台分配给商户唯一ID
timestamp string 请求时的时间戳,示例:1625590924
signature string 签名字符串 见签名说明
content string 必填 业务参数需要通过AES加密

请注意

  • 下面的业务参数对象构建完毕后,序列化到 JSON 字符串
  • JSON 字符串 进行 AES 加密后,给到公共参数的 content

业务参数

参数 类型(长度) 是否必填 描述
notifyUrl string(100) 必填 回调地址
taxFundId string(32) 必填 查询税源地 得到的ID
month string(32) 必填 提现月份
outerTradeNo string(32) 必填 商户业务流水号 商户自行生成,全局唯一
empNum string(32) 可空 自定义员工编号 商户系统中用户唯一编号
empName string(32) 必填 收款人户名
empPhone string(11) 必填 收款人手机号 税务局报税要求必填
licenseType string(10) 必填 收款人证件类型
licenseId string(32) 必填 收款人证件号码
settleType string(10) 必填 交易类型 bankcard-银行卡 / alipay-支付宝
payAccount string(32) 必填 收款账号,交易类型为支付宝时,为支付宝账号; 交易类型为银行卡时,为银行卡号
bankName string(32) 可空 收款人银行名称 (无需细到支行名称)
positionName string(32) 必填 服务类型 (您实际的业务场景说明)
payAmount Number(12) 必填 交易金额(实际到账金额,单位元,精确两位小数
remarks string(10) 可空 业务备注说明:若需要对每笔提现区分业务来源,可自行定义,后续可在SaaS后台查看,与用户到账说明无关(不能超过10个字)
bankRemo string(10) 可空 银行摘要备注(可在收款行交易明细中查看到,默认:"服务费收入")

如不需要回调,则参数填入 https://api.workersaas.com/api/pay/notifyTest

业务响应参数

参数 类型(长度) 描述
outerTradeNo string(32) 商户业务流水号

响应示例

正常

{
    "code":200,
    "msg":"success",
    "data":{
        "outerTradeNo":"f2cb9c91f3c3637fb41ea5b647836dfe"
    }
}

异常

{
    "code":500,
    "msg":"重复的业务订单号",
    "errcode":"DUPLICATE_REQUEST_NO"
}