Hexpay API 文档

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

API base URL- 请联系客服获取

出金接口

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

接口说明

该接口接受商户传入的提现信息，进行数据校验和余额检查，创建出金申请。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
currency	String	10	是	提现币种(参考入金币种，具体是否支持请和客服确认)
address	String	256	否	提现地址（币种为USDC/USDT时为稳定币地址，币种为BRL时，可以为：PIX码、CPF/CNPJ码、邮箱地址、手机号(比如+5511990028754)）等，稳定币和巴西等通道需要传。
amount	BigDecimal	-	是	提现金额
chain	String	30	否	链，currency为(USDC/USDT)时必传可选值：Tron（维护中）、Solana、Ethereum、Polygon、Arbitrum、Binance_smart_chain
mchWithdrawId	String	64	否	商户提现记录id
bankCode	String	-	否	银行编码（马来西亚、泰国、墨西哥等通道需要传）
bankHolderName	String	-	否	持卡人姓名（马来西亚、泰国、墨西哥等通道需要传）
bankAccount	String	-	否	银行账号（马来西亚、泰国、墨西哥等通道需要传）

请求示例数据

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "currency": "USDC",
    "address": "DZwb72WbFsxLF332nF5mYHiMkXpLJMtYV6kv8RtbYRTQ",
    "amount": 3.21,
    "chain": "Solana",
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

响应参数

json

{
    "code": 0,
    "data": {
        "withdrawId": 20,
        "state": 1
    },
    "msg": "SUCCESS"
}

出金状态查询接口

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

接口说明

该接口根据提现记录id查询提现申请的执行状态。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
withdrawId	Long		否	提现记录id（withdrawId、mchWithdrawId至少传一个）
mchWithdrawId	String	64	否	商户提现记录id（withdrawId、mchWithdrawId至少传一个）

请求示例数据

json

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

响应参数

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

data数据格式

字段名	类型	说明
withdrawId	Long	提现记录id
currency	String	币种
chain	String	网络
address	String	提现地址
amount	BigDecimal	提现金额
state	Byte	提现状态， 0-待处理, 1-处理中, 2-成功, 3-失败, 4-已取消
failReason	String	失败原因
gatewayResponse	String	回执信息。巴西通道返回字段说明：通道记录id：transaction_id 金额：amount 收款码：key 收款账号：recipient_account_id 收款支行：recipient_branch_id 收款人CPF/CNPJ：recipient_legal_id 收款人名称：recipient_name 收款账号类型：recipient_account_type 操作记录Id：operationUuid 错误描述1：erro_descriptor 错误描述2：new_erro_descriptor

data示例：

json

{
    "code": 0,
    "data": {
        "withdrawId": 20,
        "currency": "USDC",
        "chain": "Solana",
        "address": "DZwb72WbFsxLF332nF5mYHiMkXpLJMtYV6kv8RtbYRTQ",
        "amount": 3.21,
        "state": 0,
        "failReason": "失败原因",
        "gatewayResponse": null
    },
    "msg": "SUCCESS"
}

巴西通道gatewayResponse示例：

json

{
  "transaction_id": "111",
  "amount": 100,
  "key": "222",
  "recipient_account_id": "333",
  "recipient_branch_id": "1",
  "recipient_legal_id": "444",
  "recipient_name": "name abc",
  "recipient_account_type": "PAYMENT_ACCOUNT",
  "operationUuid": "123",
  "erro_descriptor": "",
  "new_erro_descriptor": ""
}

批量查询记录接口

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

接口说明

该接口根据mchNo与appId批量查询出金记录

请求参数

字段名	类型	最大长度	是否必输	说明
appId	String	64	是	应用id，商户后台创建
mchNo	String	30	是	商户号
version	String	10	是	版本：v1.0
signType	String	10	是	签名类型：当前版本仅支持RSA2
sign	String	256	是	签名
startTime	Date		否	（按createdAt）日期格式字符串（yyyy-MM-dd HH:mm:ss），时间范围查询--开始时间，查询范围：大于等于此时间
endTime	Date		否	（按createdAt）日期格式字符串（yyyy-MM-dd HH:mm:ss），时间范围查询--结束时间，查询范围：小于等于此时间
currency	String	30	否	币种, 可选值：(USDC/USDT/BRL)
chain	String	10	否	网络，可选值：Tron（维护中）、Solana、Ethereum、Polygon、Arbitrum、Binance_smart_chain
pageNum	Integer		否	当前页码，默认为1
pageSize	Integer		否	每页大小，默认为10
state	Byte		否	提现状态， 0-待处理, 1-处理中, 2-成功, 3-失败, 4-已取消

请求示例数据

json

{
    "appId": "68760330a2cf0af37c52a173",
    "mchNo": "M1752561528",
    "version": "v1.0",
    "signType": "RSA2",
    "state":0,
    "pageNum":1,
    "pageSize":5,
    "currency":"USDC",
    "chain":"ethereum",
    "startTime":"2025-08-28 00:00:00",
    "endTime":"2025-08-28 23:59:59",
    "sign": "g+NAXi68wJ8J9hnKbBEzf6gbF+acYSyn8eMQrQDE6ndzcma9dBVYIRTBaNaeE/aFDAdMB4ARbXpLit8QIaH7vn3ZF6iKqu7tGpax817C9Yz+c9zvLtbt6rvTpwuBCKVfQJNJ+JbWCjXqwfRMJBmDfnUCujdeLnXf2l7QW6azi0Q3CC18UKyRtHGiRZ8kdwP+s3YX7JXCD+N35aFUdf7vwP19nEhXpyjMrZKColFbarQdrPZ1MsrROcnAKPqfMgV0gQ39GizIUi0fSdBR3xD7YtG+pcmJ6iCUzNbpkpMyTYBg5J4sp2MT+ejhUXSp+hYellp20Lt22TE1yCUajAlJkQ=="
}

响应参数

data数据格式

字段名	类型	说明
withdrawId	Long	提现记录id
currency	String	币种
chain	BigDecimal	网络链路
address	String	提现地址
amount	BigDecimal	提现金额
state	Byte	提现状态， 0-待处理, 1-处理中, 2-成功, 3-失败, 4-已取消
failReason	String	失败原因
gatewayResponse	String
mchWithdrawId	String	商户提现id

json

{
    "code": 0,
    "msg": "SUCCESS",
    "data": {
        "records": [
            {
                "withdrawId": 11,
                "currency": "USDC",
                "chain": "arbitrum",
                "address": "0xddc101d26c59d6b10c95e7b7b3928986741ea13f",
                "amount": "0.11",
                "state": 1
            },
            {
                "withdrawId": 10,
                "currency": "USDC",
                "chain": "arbitrum",
                "address": "0x4fd16e1c608f437f60d324ce1a96097ee85c8843",
                "amount": "0.11",
                "state": 2
            }
        ],
        "total": 2,
        "size": 5,
        "current": 1,
        "pages": 1
    }
}

下载出金回执接口

接口信息

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

接口说明

该接口根据提现记录id下载出金回执PDF文件。支持多语言版本的回执文件下载。

请求参数

字段名	类型	最大长度	是否必输	说明
mchNo	String	30	是	商户号
appId	String	64	是	应用id，商户平台创建应用分配
sign	String	512	是	签名
signType	String	10	是	签名类型，默认值RSA2
version	String	10	是	版本号,例：v1.0
withdrawId	Long		否	提现记录id（withdrawId、mchWithdrawId至少传一个）
mchWithdrawId	String	64	否	商户提现记录id（withdrawId、mchWithdrawId至少传一个）
lang	String	20	否	回执语言，可选值：english（默认）、portuguese、chinese

请求示例

json

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

响应参数

成功响应

Content-Type: application/pdf
Content-Disposition: attachment; filename="WithdrawReceipt{mchWithdrawId}.pdf"
响应体: PDF文件流

失败响应

HTTP状态码: 404 Not Found（当提现记录不存在时）

响应状态说明

情况	HTTP状态码	说明
成功	200	返回PDF文件流，浏览器会自动下载文件
记录不存在	404	提现记录不存在或无权限访问
参数错误	400	请求参数验证失败
签名错误	401	签名验证失败

Hexpay API 文档 ​

出金接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

出金状态查询接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

批量查询记录接口 ​

接口说明 ​

请求参数 ​

响应参数 ​

下载出金回执接口 ​

接口信息 ​

接口说明 ​

请求参数 ​

请求示例 ​

响应参数 ​

成功响应 ​

失败响应 ​

响应状态说明 ​

Hexpay API 文档

出金接口

接口说明

请求参数

响应参数

出金状态查询接口

接口说明

请求参数

响应参数

批量查询记录接口

接口说明

请求参数

响应参数

下载出金回执接口

接口信息

接口说明

请求参数

请求示例

响应参数

成功响应

失败响应

响应状态说明