职乐一物一码支付系统接口文档
  1. 接口列表
职乐一物一码支付系统接口文档
  • 概述
  • 开发指南
    • 基本概念
    • 如何生成请求签名
  • 接口列表
    • 发起商家转账
      POST
    • 通过支付平台批次单号查询批次单
      GET
    • 通过商家批次单号查询批次单
      GET
    • 通过支付平台明细单号查询明细单
      GET
    • 通过商家明细单号查询明细单
      GET
    • 转账账单电子回单申请受理接口
      POST
    • 查询转账账单电子回单接口
      GET
    • 电子回单下载
      GET
  1. 接口列表

发起商家转账

POST
https://api.oioc.gzlle.com/v3/transfer/batches
发起商家转账接口。商户可以通过该接口同时向多个用户微信零钱进行转账操作。请求消息中应包含商家批次单号、转账名称、appid、转账总金额、转账总笔数、转账openid、收款用户姓名等信息。注意受理成功将返回批次单号，此时并不代表转账成功，请通过查单接口查询单据的付款状态

请求参数

Header 参数
Authorization
string 
可选
请参考 签名认证 生成认证信息
Accept
string 
可选
请设置为 application/json
Content-Type
string 
可选
请设置为 application/json
Body 参数application/json
appid
string 
微信appid
必需
out_batch_no
string 
商家批次单号
必需
此参数只能由数字、大小写字母组成，在商户系统内部唯一
batch_name
string 
批次名称
必需
该笔批量转账的名称
batch_remark
string 
批次备注
必需
UTF8编码，最多允许32个字符
total_amount
integer 
转账总金额
必需
转账金额单位为“分”。转账总金额必须与批次内所有明细转账金额之和保持一致，否则无法发起转账操作
total_num
integer 
转账总笔数
必需
一个转账批次单最多发起一千笔转账。转账总笔数必须与批次内所有明细之和保持一致，否则无法发起转账操作
transfer_scene_id
string 
转账场景ID
可选
该批次转账使用的转账场景，如不填写则使用商家的默认场景，如无默认场景可为空
transfer_detail_list
array [object {5}] 
转账明细列表
必需
发起批量转账的明细列表，最多一千笔
out_detail_no
string 
商家明细单号
必需
商户系统内部区分转账批次单下不同转账明细单的唯一标识，要求此参数只能由数字、大小写字母组成
transfer_amount
integer 
转账金额
必需
转账金额单位为“分”
transfer_remark
string 
转账备注
必需
单条转账备注（微信用户会收到该备注），UTF8编码，最多允许32个字符
openid
string 
微信收款用户openid
必需
微信商户appid下，某用户的openid
user_name
string 
收款用户姓名
可选

收款方真实姓名（金额<0.3元时，不允许填写收款用户姓名，金额 >= 2,000元时，该笔明细必须填写收款用户姓名）

示例
{
  "appid": "string",
  "out_batch_no": "string",
  "batch_name": "string",
  "batch_remark": "string",
  "total_amount": 0,
  "total_num": 0,
  "transfer_scene_id": "string",
  "transfer_detail_list": [
    {
      "out_detail_no": "string",
      "transfer_amount": 0,
      "transfer_remark": "string",
      "openid": "string",
      "user_name": "string"
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.oioc.gzlle.com/v3/transfer/batches' \
--header 'Authorization;' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appid": "string",
    "out_batch_no": "string",
    "batch_name": "string",
    "batch_remark": "string",
    "total_amount": 0,
    "total_num": 0,
    "transfer_scene_id": "string",
    "transfer_detail_list": [
        {
            "out_detail_no": "string",
            "transfer_amount": 0,
            "transfer_remark": "string",
            "openid": "string",
            "user_name": "string"
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
out_batch_no
string 
商家批次单号
必需
商户系统内部的商家批次单号，在商户系统内部唯一
batch_id
string 
支付平台批次单号
必需
支付平台批次单号，平台商家转账系统返回的唯一标识
create_time
string 
批次创建时间
必需
批次受理成功时返回，按照使用rfc3339所定义的格式，格式为YYYY-MM-DDThh:mm:ss+TIMEZONE
batch_status
string 
批次状态
可选
【批次状态】 ACCEPTED:已受理。批次已受理成功，若发起批量转账的30分钟后，转账批次单仍处于该状态，可能原因是商户账户余额不足等。商户可查询账户资金流水，若该笔转账批次单的扣款已经发生，则表示批次已经进入转账中，请再次查单确认 PROCESSING:转账中。已开始处理批次内的转账明细单 FINISHED:已完成。批次内的所有转账明细单都已处理完成 CLOSED:已关闭。可查询具体的批次关闭原因确认
示例
{
  "isSuccess": true,
  "data": {
    "out_batch_no": "CARRY70020230907001",
    "batch_id": "1567393367195680",
    "create_time": "2023-09-07T16:43:19.120+08:00",
    "batch_status": "FINISHED"
  }
}
修改于 2024-02-02 08:44:42
上一页
如何生成请求签名
下一页
通过支付平台批次单号查询批次单
Built with