Hexpay API 文档

此页面展示了 Hexpay 提供的一些运行时 API 的使用方法。

API base URL- 请联系客服获取

批量代付上传接口

数据类型：JSON（content-type：application/json）
请求⽅式：POST
路径Path: /v1/hexpay/batchPayment/upload
验证方式：签名验证

接口说明

该接口接受商户传入的批量代付记录，进行数据校验和余额检查，创建批量代付申请。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
records	Array	-	是	代付记录列表
purpose	String	256	否	代付用途

Record Type

字段名	类型	是否必输	说明
recipientAddress	String	是	收款地址
paymentAmount	BigDecimal	是	代付金额
paymentCurrency	String	是	付款货币，可选值：USDT、USDC
networkType	String	是	网络类型，可选值：Tron（维护中）、Solana、Ethereum、Polygon、Arbitrum、Binance_smart_chain
remarks	String	否	备注信息
addressTag	String	否	地址标签

请求示例数据

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "purpose": "批量代付测试",
    "records": [
        {
            "recipientAddress": "TUEZSdKsoDHQMeZwihtdoBiN46zP8ulvDE",
            "paymentAmount": 10.50,
            "paymentCurrency": "USDT",
            "networkType": "Binance_smart_chain",
            "remarks": "代付备注1",
            "addressTag": "tag1"
        },
        {
            "recipientAddress": "TSNEZdKsoDHQMeZwihtdoBiN46zP8ulvDE",
            "paymentAmount": 20.30,
            "paymentCurrency": "USDC",
            "networkType": "Binance_smart_chain",
            "remarks": "代付备注2",
            "addressTag": "tag2"
        }
    ],
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

响应参数

字段名	类型	是否必须	说明
code	String	是	响应码
data	Object	否	响应数据
msg	String	否	响应信息

data数据格式

字段名	类型	说明
batchNo	String	批次号
totalCount	Integer	总记录数
totalAmount	Array	按币种统计的总金额
applyTime	Date	申请时间
checkErrorList	Array	数据校验错误列表
checkBalanceList	Array	余额检查结果（仅返回余额不足的币种）

totalAmount数据格式

字段名	类型	说明
currency	String	币种
amount	BigDecimal	金额

checkBalanceList数据格式

字段名	类型	说明
paymentCurrency	String	币种
paymentAmount	BigDecimal	代付金额
freeAmount	BigDecimal	手续费
totalAmount	BigDecimal	总金额（代付+手续费）
availableAmount	BigDecimal	当前账户可用余额
isSatisfy	Integer	是否满足条件（0=不足，1=充足）
validCount	Integer	有效记录数
errorCount	Integer	错误记录数

响应示例

json

{
    "code": 0,
    "data": {
        "batchNo": "BP20250905123456789",
        "totalCount": 2,
        "totalAmount": [
            {
                "currency": "USDT",
                "amount": 10.50
            },
            {
                "currency": "USDC",
                "amount": 20.30
            }
        ],
        "applyTime": "2025-09-05 14:30:25",
        "checkErrorList": [],
        "checkBalanceList": [
            {
                "paymentCurrency": "USDT",
                "paymentAmount": 10.50,
                "freeAmount": 0.50,
                "totalAmount": 11.00,
                "availableAmount": 5.00,
                "isSatisfy": 0,
                "validCount": 1,
                "errorCount": 0
            }
        ]
    },
    "msg": "SUCCESS"
}

批量代付查询接口

数据类型：JSON（content-type：application/json）
请求⽅式：POST
路径Path: /v1/hexpay/batchPayment/query
验证方式：签名验证

接口说明

该接口根据批次号查询批量代付申请的详细信息，包括审核状态和每条记录的执行状态。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
batchNo	String	64	是	批次号

请求示例数据

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "batchNo": "BP20250905123456789",
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

响应参数

字段名	类型	是否必须	说明
code	String	是	响应码
data	Object	否	响应数据
msg	String	否	响应信息

data数据格式

字段名	类型	说明
batchNo	String	批次号
mchNo	String	商户号
mchName	String	商户名称
auditStatus	Byte	审核状态：0-待审核，1-执行中，2-已拒绝，3-已完成，4-执行失败，5-已取消
totalCount	Integer	总记录数
successCount	Integer	成功数量
failCount	Integer	失败数量
processingCount	Integer	处理中数量
waitCount	Integer	待处理数量
totalAmount	BigDecimal	总金额
applyTime	Date	申请时间
auditTime	Date	审核时间
executeTime	String	执行时间
purpose	String	代付用途
rejectReason	String	拒绝原因
auditOpinion	String	审核意见
records	Array	具体记录列表

RecordDetail数据格式

字段名	类型	说明
id	Long	记录ID
recipientAddress	String	收款地址
paymentAmount	BigDecimal	代付金额
paymentCurrency	String	付款货币
networkType	String	网络类型
feeAmount	BigDecimal	手续费金额
remarks	String	备注信息
addressTag	String	地址标签
status	Byte	记录状态：0-待处理，1-处理中，2-代付成功，3-代付失败，4-已取消
failReason	String	失败原因
txHash	String	交易哈希
processedAt	Date	处理时间
createdAt	Date	创建时间

响应示例

json

{
    "code": 0,
    "data": {
        "batchNo": "BP20250905123456789",
        "mchNo": "M1752564528",
        "mchName": "测试商户",
        "auditStatus": 1,
        "totalCount": 2,
        "successCount": 1,
        "failCount": 0,
        "processingCount": 1,
        "waitCount": 0,
        "totalAmount": 30.80,
        "applyTime": "2025-09-05 14:30:25",
        "auditTime": "2025-09-05 14:35:10",
        "executeTime": "2025-09-05 14:35:15",
        "purpose": "批量代付测试",
        "rejectReason": null,
        "auditOpinion": "审核通过",
        "records": [
            {
                "id": 1001,
                "recipientAddress": "TUEZSdKsoDHQMeZwihtdoBiN46zP8ulvDE",
                "paymentAmount": 10.50,
                "paymentCurrency": "USDT",
                "networkType": "",
                "feeAmount": 0.50,
                "remarks": "代付备注1",
                "addressTag": "tag1",
                "status": 2,
                "failReason": null,
                "txHash": "0x1234567890abcdef1234567890abcdef12345678",
                "processedAt": "2025-09-05 14:40:20",
                "createdAt": "2025-09-05 14:30:25"
            },
            {
                "id": 1002,
                "recipientAddress": "TSNEZdKsoDHQMeZwihtdoBiN46zP8ulvDE",
                "paymentAmount": 20.30,
                "paymentCurrency": "USDC",
                "networkType": "Binance_smart_chain",
                "feeAmount": 1.00,
                "remarks": "代付备注2",
                "addressTag": "tag2",
                "status": 1,
                "failReason": null,
                "txHash": null,
                "processedAt": null,
                "createdAt": "2025-09-05 14:30:25"
            }
        ]
    },
    "msg": "SUCCESS"
}

批量代付取消接口

数据类型：JSON（content-type：application/json）
请求⽅式：POST
路径Path: /v1/hexpay/batchPayment/cancel
验证方式：签名验证

接口说明

该接口用于取消状态为"待审核"的批量代付申请，取消后会回滚冻结的余额。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
batchNo	String	64	是	批次号

请求示例数据

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "batchNo": "BP20250905123456789",
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

响应参数

字段名	类型	是否必须	说明
code	String	是	响应码
data	Object	否	响应数据
msg	String	否	响应信息

data数据格式

字段名	类型	说明
id	Long	主键ID
batchNo	String	批次号
mchNo	String	商户号
mchName	String	商户名称
totalCount	Integer	总记录数
totalAmount	BigDecimal	总金额
status	Byte	审核状态：0-待审核，1-执行中，2-已拒绝，3-已完成，4-执行失败，5-已取消
auditUserId	Long	审核人ID
auditUserName	String	审核人昵称
auditTime	Date	审核时间
remarks	String	备注
purpose	String	代付用途
rejectReason	String	拒绝原因
auditOpinion	String	审核意见
executeTime	String	执行时间
successCount	Integer	成功数量
failCount	Integer	失败数量
executingCount	Integer	执行中数量
createdAt	Date	创建时间
updatedAt	Date	更新时间

响应示例

json

{
    "code": 0,
    "data": {
        "id": 1001,
        "batchNo": "BP20250905123456789",
        "mchNo": "M1752564528",
        "mchName": "测试商户",
        "totalCount": 2,
        "totalAmount": 30.80,
        "status": 5,
        "auditUserId": null,
        "auditUserName": null,
        "auditTime": null,
        "remarks": null,
        "purpose": "批量代付测试",
        "rejectReason": null,
        "auditOpinion": null,
        "executeTime": null,
        "successCount": 0,
        "failCount": 0,
        "executingCount": 0,
        "createdAt": "2025-09-05 14:30:25",
        "updatedAt": "2025-09-05 15:20:15"
    },
    "msg": "SUCCESS"
}

Hexpay API 文档 ​

批量代付上传接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

批量代付查询接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

批量代付取消接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

Hexpay API 文档

批量代付上传接口

接口说明

请求参数

响应参数

批量代付查询接口

接口说明

请求参数

响应参数

批量代付取消接口

接口说明

请求参数

响应参数