logo

搜索...

⌘ K

中文

产品文档
接口文档
资源下载
帮助中心

开始使用

总体概览

场景能力

接入步骤

收款能力

CKP 集成收银台页面

交互示意

集成准备

集成步骤

Deeplink 直跳方式

交互示意

集成准备

集成步骤

QRCode 展示二维码

交互示意

集成准备

集成步骤

付款能力

能力概述

充值入金

发起 U 提现/付款

发起法币提现

接收付款结果

支持的链和币种

支持的链

支持的币种

附录

钱包/币种/链

交易状态枚举值

支付状态

退款状态

提现状态

批量提现状态

错误码说明

签名算法

发起批量提现

请求方式和路径

POST /payout/v1/batch/apply

请求头

字段名 类型 必传 描述
content-type string 是 application/json
x-api-key string 是 Paydify提供,跟appId相同
x-api-timestamp string 是 时间戳,单位毫秒
x-api-signature string 是 签名,具体参看签名算法

请求体

字段名 类型 必传 描述
mchBatchId string 是 商户批次号,商户侧唯一,用于幂等控制
batchName string 是 批次名称,用于商户 Portal 展示和对账
currency string 是 批次统一币种,同一批次所有明细必须使用相同币种,支持:USDT、USDC
totalAmount string 是 批次总金额,必须等于所有明细 transferAmount 之和
totalCount string 是 批次总笔数,必须等于 transferDetailList 的实际数量
transferDetailList array 是 明细列表
merchantId string 否 批次归属商户 ID(子商户)。合作伙伴(Partner)凭据代发时必填;商户自有凭据可不传,默认归属凭据所属商户。最长 64 字符
merchantAppId string 否 归属商户下的应用 ID,用于归属商户存在多个已授权应用时消歧。凭据覆盖该商户多个应用时必填;仅一个授权应用时可不传,系统自动匹配。最长 64 字符

transferDetailList 明细

字段名 类型 必传 描述
mchDetailId string 是 商户明细号,批次内唯一,用于明细级幂等
transferAmount decimal 是 单笔转账金额
network string 是 链网络,支持:BSC/SOL/ETH/TRON/BASE
address string 是 收款地址,需符合对应 network 的地址格式
remark string 否 备注信息

响应头参数

字段名 类型 必传 描述
x-api-key string 是 Paydify提供,跟appId相同
x-api-timestamp string 是 时间戳,单位毫秒
x-api-signature string 是 签名,具体参看签名算法

返回值

字段名 类型 描述
code string 响应码,SYS_SUCCESS表示成功
message string 响应消息
messageDetail string 响应消息详情
success boolean 是否成功
data.batchId string Paydify批次号
data.mchBatchId string 商户批次号
data.status string 批次状态,初始为CREATED

示例

# 请求
{
  "mchBatchId": "MCH_BATCH_1756287002",
  "batchName": "月度结算批次",
  "currency": "USDT",
  "totalAmount": "300.00",
  "totalCount": "2",
  "transferDetailList": [
    {
      "mchDetailId": "D_001",
      "transferAmount": "100.00",
      "network": "TRON",
      "address": "TXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "remark": "user 001"
    },
    {
      "mchDetailId": "D_002",
      "transferAmount": "200.00",
      "network": "TRON",
      "address": "TYyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
      "remark": "user 002"
    }
  ]
}

# 成功返回值
{
  "code": "SYS_SUCCESS",
  "message": null,
  "messageDetail": null,
  "data": {
    "batchId": "B1167515578018041857",
    "mchBatchId": "MCH_BATCH_1756287002",
    "status": "CREATED"
  },
  "success": true
}

# 失败返回值
{
  "code": "SYS_ERROR",
  "message": "System error",
  "messageDetail": "Error details",
  "data": null,
  "success": false
}

目录