通过支付平台批次单号查询批次单

GET

/v3/transfer/batches/batch-id/{batch_id}

平台批次单号查单接口。商户可以通过该接口查询转账批次单以及指定状态的转账明细单。返回消息中包含批次单号、批次状态、批次类型、转账总金额、转账总笔数、成功金额、失败金额等信息。

请求参数

Path 参数

batch_id

string

必需

【平台批次单号】平台商家转账系统返回的唯一标识

Query 参数

need_query_detail

boolean

可选

【是否查询转账明细单】 true-是；false-否，默认否。商户可选择是否查询指定状态的转账明细单，当转账批次单状态为“FINISHED”（已完成）时，才会返回满足条件的转账明细单

示例值:

true

offset

integer

可选

【请求资源起始位置】该次请求资源的起始位置。返回的明细是按照设置的明细条数进行分页展示的，一次查询可能无法返回所有明细，我们使用该参数标识查询开始位置，默认值为0

示例值:

limit

integer

可选

【最大资源条数】该次请求可返回的最大明细条数，最小20条，最大100条，不传则默认20条。不足20条按实际条数返回

detail_status

string

必需

【明细状态】 WAIT_PAY: 待确认。待商户确认, 符合免密条件时, 系统会自动扭转为转账中
ALL:全部。需要同时查询转账成功、失败和待确认的明细单
SUCCESS:转账成功
FAIL:转账失败。需要确认失败原因后，再决定是否重新发起对该笔明细单的转账（并非整个转账批次单）
当need_query_detail为true时该字段必填

Header 参数

Authorization

string

必需

请参考签名认证生成认证信息

string

必需

请设置为application/json

示例值:

application/json

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://test-cn.your-api-server.com/v3/transfer/batches/batch-id/?need_query_detail=true&offset=0&limit=&detail_status=' \
--header 'Authorization;' \
--header 'Accept: application/json'

返回响应

🟢200成功

application/json

Body

transfer_batch

object

必需

mchid

string

商户号

必需

商户号

out_batch_no

string

商家批次单号

必需

商户系统内部的商家批次单号，在商户系统内部唯一

batch_id

string

支付系统批次单号

必需

商家转账系统返回的唯一标识

appid

string

商户appid

必需

申请商户号的appid或商户号绑定的appid

batch_status

string

批次状态

必需

【批次状态】 WAIT_PAY: 待付款确认。需要付款出资商户在商家助手小程序或服务商助手小程序进行付款确认 ACCEPTED:已受理。批次已受理成功，若发起批量转账的30分钟后，转账批次单仍处于该状态，可能原因是商户账户余额不足等。商户可查询账户资金流水，若该笔转账批次单的扣款已经发生，则表示批次已经进入转账中，请再次查单确认 PROCESSING:转账中。已开始处理批次内的转账明细单 FINISHED:已完成。批次内的所有转账明细单都已处理完成 CLOSED:已关闭。可查询具体的批次关闭原因确认

batch_type

string

批次类型

必需

API:API方式发起，WEB:页面方式发起

batch_name

string

批次名称

必需

该笔批量转账的名称

batch_remark

string

批次备注

必需

转账说明，UTF8编码，最多允许32个字符

close_reason

string

批次关闭原因

可选

如果批次单状态为“CLOSED”（已关闭），则有关闭原因

total_amount

integer

转账总金额

必需

转账金额单位为“分”

total_num

integer

转账总笔数

必需

一个转账批次单最多发起一千笔转账

create_time

string

批次创建时间

可选

批次受理成功时返回，按照使用rfc3339所定义的格式，格式为YYYY-MM-DDThh:mm:ss+TIMEZONE

update_time

string

批次更新时间

可选

批次最近一次状态变更的时间，按照使用rfc3339所定义的格式，格式为YYYY-MM-DDThh:mm:ss+TIMEZONE

success_amount

integer

转账成功金额

可选

转账成功的金额，单位为“分”

success_num

integer

转账成功笔数

可选

fail_amount

integer

转账失败金额

可选

fail_num

integer

转账失败笔数

可选

transfer_scene_id

string

转账场景ID

可选

transfer_detail_list

array [object {5}]

转账明细单列表

可选

detail_id

string

支付系統明细单号

必需

支付系统内部区分转账批次单下不同转账明细单的唯一标识

out_detail_no

string

商家明细单号

必需

商户系统内部区分转账批次单下不同转账明细单的唯一标识

detail_status

string

明细状态

必需

INIT: 初始态。系统转账校验中 WAIT_PAY: 待确认。待商户确认, 符合免密条件时, 系统会自动扭转为转账中 PROCESSING:转账中。正在处理中，转账结果尚未明确 SUCCESS:转账成功 FAIL:转账失败。需要确认失败原因后，再决定是否重新发起对该笔明细单的转账（并非整个转账批次单）

fail_reason

string

明细失败原因

可选

如果转账失败则有失败原因

user_name

string

收款用户姓名

必需

商户转账时传入了收款用户姓名、查询时会返回收款用户姓名

示例

{
  "transfer_batch": {
    "mchid": "string",
    "out_batch_no": "string",
    "batch_id": "string",
    "appid": "string",
    "batch_status": "string",
    "batch_type": "string",
    "batch_name": "string",
    "batch_remark": "string",
    "close_reason": "string",
    "total_amount": 0,
    "total_num": 0,
    "create_time": "string",
    "update_time": "string",
    "success_amount": 0,
    "success_num": 0,
    "fail_amount": 0,
    "fail_num": 0,
    "transfer_scene_id": "string"
  },
  "transfer_detail_list": [
    {
      "detail_id": "string",
      "out_detail_no": "string",
      "detail_status": "string",
      "fail_reason": "string",
      "user_name": "string"
    }
  ]
}

修改于 2024-02-01 03:47:12

发起商家转账

通过商家批次单号查询批次单