跳转到主要内容
POST
/
v1
/
pay
/
withdraw
/
query
提现订单状态查询
curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/withdraw/query \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "batch_id": "237394559478075555",
  "detail_status": "ALL"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "batch_id": "237394559478075350",
    "merchant_id": 10002,
    "client_id": "mZ96D37oKk-HrWJc",
    "status": "FAIL",
    "create_time": 1726055849126,
    "channel_id": "123456",
    "withdraw_list": [
      {
        "id": 35,
        "batch_id": "237394559478075350",
        "merchant_id": 10002,
        "suborder_id": "268830764354768896",
        "chain": "ETH",
        "address": "0x1234567890abcdef",
        "currency": "USDT",
        "amount": "1",
        "fee": "0",
        "tx_id": "",
        "timestamp": 0,
        "memo": "Payment for services-1",
        "status": "FAIL",
        "merchant_withdraw_id": "M137394559478075550",
        "err_msg": "unexpected http code error",
        "create_time": 1726055848856,
        "update_time": 1726055856011,
        "channel_id": "123456",
        "fee_type": 1,
        "done_amount": "1"
      },
      {
        "id": 36,
        "batch_id": "237394559478075350",
        "merchant_id": 10002,
        "suborder_id": "268830764354768897",
        "chain": "ETH",
        "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "currency": "USDT",
        "amount": "0.001",
        "fee": "0",
        "tx_id": "",
        "timestamp": 0,
        "memo": "Payment for services-1",
        "status": "FAIL",
        "merchant_withdraw_id": "M137394559478075551",
        "err_msg": "unexpected http code error",
        "create_time": 1726055848856,
        "update_time": 1726055856010,
        "channel_id": "123456",
        "fee_type": 1,
        "done_amount": "0.001"
      }
    ]
  }
}

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"3525756760"

请求体

application/json

提现订单查询请求体。

batch_id
string
必填

由商户侧在 /v1/pay/withdraw 生成的唯一批次 ID。

detail_status
string
必填

接口查询状态 ALL 全部子订单 INIT 新建子订单 PENDING 待处理子订单 PROCESSING 已提交提现请求,待确认子订单 CHECK 审核中子订单 FAIL 失败子订单 DONE 提现成功子订单

响应

200 - application/json

提现订单详情

提现订单查询响应体。

status
string
必填

SUCCESS 或者 FAIL

code
string
必填

出错代码

errorMessage
string

错误信息

data
object

提现订单信息