Skip to content

t0ny-w/gatexfer

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
README.md
README.md
 
 

Repository files navigation

跨交易所资产划转

签名算法

API 验签请求接口发送要求

  • 向客服人员申请一对API Key和API Secret, 并提供需要绑定的ip白名单
  • 在发送请求头部传入KEY,即API密钥对的 Key
  • 在发送请求头部传入Timestamp,即请求发送的时间,格式是秒级精度的 Unix 时间戳.同时该时间不能与当前时间差距超过 60 秒
  • 在发送请求头部传入SIGN,即将请求生成签名字符串并用 API Secret 加密后生成的签名
  • 加密算法为 HexEncode(HMAC_SHA512(secret, signature_string)),即通过 HMAC-SHA512 加密算法,将 API Secret 作为加密密钥，签名字符串作为加密消息， 生成加密结果的 16 进制输出
  • 确保发送请求的客户端IP地址在所使用的密钥的IP地址白名单里

签名字符串生成方式

  • 签名字符串按照如下方式拼接生成 (Query String或Request Payload没有则用空字符串“”替代)
Request Method + "\n" + Request URL + "\n" + Query String + "\n" + HexEncode(SHA512(Request Payload)) + "\n" + Timestamp

Request Method

  • 请求方法，全大写, 如 POST, GET

Request URL

  • 不包括服务地址和端口，如 /api/spot/withdraw

Query String

  • 没有使用 URL 编码的请求参数，请求参数在参与计算签名时的顺序一定要保证和实际请求里的顺序一致。 如 status=finished&limit=50

  • 如果没有请求参数，使用空字符串 ("")

HexEncode(SHA512(Request Payload))

  • 将请求体字符串使用 SHA512 哈希之后的结果。如果没有请求体，使用空字符串的哈希结果，即 cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e

Timestamp

  • 设置在请求头部 Timestamp 里的值 格式是秒级精度的 Unix 时间戳 数据类型为整型

API 接口

划转接口

请求方式

POST https://${url}/api/spot/withdraw

请求入参

字段名称 字段类型 是否必需 字段含义
withdrawMainAccountId String NO 提现母账户UID
withdrawSubAccountId String NO 提现子账户UID
depositMainAccountId String NO 充值母账户UID
depositSubAccountId String NO 充值子账户UID
currency String NO 充提币种。若非空，则充提币种认为一致
amount f64 YES 提现数量
withdrawChain String NO 提现网络。若空，则使用Gatexfer最高优先级的匹配网络
depositChain String NO 充值网络。同上
withdrawCoin String NO 提现币种。当充提币种名称不一样时需传入withdrawCoin和depositCoin
depositCoin String NO 充值币种。同上
clientTransId String NO 客户交易ID。用于幂等。长度限制[16, 32]

请求示例

POST https://${url}/api/spot/withdraw
Content-Type: application/json
KEY: <api-key>
Timestamp: 1234567890
SIGN: <sign>

{
  "withdrawMainAccountId": null,
  "withdrawSubAccountId": "binance@gatexfer.com",
  "depositMainAccountId": null,
  "depositSubAccountId": "123456789",
  "currency": "usdt",
  "amount": 100000.0
}

返回示例

{  
  "code": 代码
  "data": 请求成功 返回任务ID 用来查询状态
  "msg": 请求成功返回success 请求失败返回错误信息
}

充提的母账户&子账户ID 每个请求需要传两个 规则如下

提现账户类型 充值账户类型 传参
母账户 子账户 withdrawMainAccountId + depositSubAccountId
母账户 母账户 withdrawMainAccountId + depositMainAccountId
子账户 子账户 withdrawSubAccountId + depositSubAccountId
子账户 母账户 withdrawSubAccountId + depositMainAccountId

请求状态查询

请求方式

GET https://${url}/api/spot/withdraw/{id}

其中id长度为14位时，查询任务ID；
id长度在[16, 32]位时，查询客户交易ID对应的任务。

请求示例

GET https://${url}/api/spot/withdraw/123456789
KEY: <api-key>

返回示例

失败的划转任务查询返回 
{
  "code": 0,
  "data": {
    "id": "606e037ab0e57",
    "clientTransId": "1234567890",
    "status": "-4",
    "txId": "",
    "currency": "usdt",
    "withdrawAmount": 100000.0,
    "depositAmount": 0.0,
    "msg": "Task Failed. Insufficient balance in sub-account.",
    "chain": "sol"
  },
  "msg": "success"
}
成功的划转任务查询返回
{
  "code": 0,
  "data": {
    "id": "c0dbe274c2a58",
    "clientTransId": "1234567890",
    "status": "9",
    "txId": "0x12345678987654321abcdefghijklmnoqprstuvwxyz",
    "currency": "usdt",
    "withdrawAmount": 100000.0,
    "depositAmount": 99999.0,
    "msg": "Task Completed",
    "chain": "sol"
  },
  "msg": "success"
}
母转子失败，退回资金成功时返回
{
  "code": 0,
  "data": {
    "id": "c0dbe274c2a58",
    "clientTransId": "1234567890",
    "status": "-4",
    "txId": "",
    "currency": "usdt",
    "withdrawAmount": 100000.0,
    "depositAmount": 0.0,
    "msg": "Task Completed",
    "chain": "sol",
    "refundAmount": 100000.0
  },
  "msg": "success"
}

状态列表

值 描述
-1 任务取消
-2 提现账户内部划转失败
-4 主账户提现失败
-7 主账户充值失败
-8 充值账户内部划转失败
-9 任务失败
-10 需要退回资金
1 新建请求
2 提现账户的内部划转请求已发出
3 提现账户的内部划转已完成
4 提现账户的提现请求审核中
5 链上转账进行中
6 充值账户的充值确认中
7 充值账户的充值已发出
8 充值账户的内部划转请求已发出
9 任务成功完成
0 已取消

批量查询任务

请求方式

POST https://${url}/api/spot/queryHistory

请求入参

条件为且

字段名称 字段类型 是否必需 字段含义
withdrawCoin String NO 提现币种
depositCoin String NO 充值币种
withdrawChain String NO 提现网络
depositChain String NO 充值网络
withdrawMasterUid String NO 提现母账户UID
depositMasterUid String NO 充值母账户UID
withdrawSubUid String NO 提现子账户UID
depositSubUid String NO 充值子账户UID
createStartTime u64 NO 创建开始时间
createEndTime u64 NO 创建结束时间
status i8 NO 任务状态

请求示例

POST https://${url}/api/spot/queryHistory
Content-Type: application/json
KEY: <api-key>
Timestamp: 1234567890
SIGN: <sign>

{
  "withdrawCoin": "usdt",
}

返回示例


{
  "code": 0,
  "data": [
    {
      "id": "606e037ab0e57",
      "clientTransId": "1234567890",
      "status": "9",
      "txId": "0x12345678987654321abcdefghijklmnoqprstuvwxyz",
      "currency": "usdt",
      "withdrawAmount": 100000.0,
      "depositAmount": 99999.0,
      "msg": "Task Completed",
      "chain": "sol"
    }
  ],
  "msg": "success"
}

查询充提支持情况

请求方式

POST https://${url}/api/spot/support

请求入参

字段名称 字段类型 是否必需 字段含义
currency String YES 充提币种
withdrawExchange String YES 提现交易所。如(gate、binance、huobi、okx、kucoin、mexc、bybit、deribit、bitget)
depositExchange String YES 充值交易所。同上

请求示例

POST https://${url}/api/spot/support
Content-Type: application/json
KEY: <api-key>
Timestamp: 1234567890
SIGN: <sign>

{
  "currency": "sol",
  "withdrawExchange": "Gate",
  "depositExchange": "Binance"
}

返回示例

{
  "code": 0,
  "data": {
    // 所有list结果中最大值
    "estFee": 0.00332,
    // 所有list结果中最小精度值
    "precision": 9,
    "lists": [
      {
        "withdrawExchange": "Gate",
        "depositExchange": "Binance", 
        "chain": "sol",
        "currency": "sol",
        "minWithdrawAmount": 0.00006663,
        // 并非所有交易所都支持
        "minDepositAmount": null,
        "estFee": 0.00332,
        // 并非所有交易所都支持
        "precision": 9
      },
      ...
    ]
  },
  "msg": "success"
}

sub-account-id 说明

Exchange SubAccountId
BINANCE Sub-account email
HUOBI Sub user’s UID
GATE Sub account user ID
GATE-MALTA Sub account user ID
OKX sub-account name
BYBIT sub-account UID
BITGET sub-account UID
KUCOIN sub-account UID

About

GateXfer API documentaion

Resources

Readme
Activity

Stars

6 stars

Watchers

2 watching

Forks

7 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors