# 1. 功能介绍

    提供从支付账户直接闪兑的API,避免用户需要先划转到现货账户

    # 2. API 接口

    # 查询可用闪兑币种

    • 数据类型:JSON (content-type:application/json)

    • 请求⽅式:GET

    • 路径Path: /v1/pay/convert/currency

    • 验证方式:签名验证

    • 请求参数 (Query String):

      字段名 类型 是否必须 说明
      side string 交易方向值为( "buy" 或 "sell")
    • 响应内容

      字段名 类型 是否必须 说明
      currency string 币种
    • CURL 请求
    curl --location 'https://openplatform.gateapi.io/v1/pay/convert/currency?side=sell' \
    --header 'X-GatePay-Certificate-ClientId: SkZlbKOqPoMwnxhl' \
    --header 'X-GatePay-Timestamp: 1740018226125' \
    --header 'x-GatePay-Nonce: 5241889066' \
    --header 'x-GatePay-Signature: a428f2afc6103b515d4a774ffe8dda9f10bbe1a9815d4c10598f281e5db014e93c7ae42b6cff0c77166e136e5951261e6bcfc4672582483b814bf604ade50bb4' \
    --header 'Content-Type: application/json'
    
    
    • 响应
    {
        "status": "SUCCESS",
        "code": "000000",
        "errorMessage": "",
        "data": {
            "currency": [
                "USDT",
                "GT",
                "HOOK",
                "ETH",
                "DOT",
                "BTC",
                "DAL",
                "LTC",
                "COS",
                "POL",
                "SOL",
                "DOGE",
                "ALGO",
                "STPT",
                "BCH",
                "SHIB"
            ]
        }
    }
    
    

    # 查询可用币种对

    • 数据类型:JSON (content-type:application/json)

    • 请求⽅式:GET

    • 路径Path: /v1/pay/convert/pair

    • 验证方式:签名验证

    • 请求参数 (Query String):

      字段名 类型 是否必须 说明
      side string 交易方向 交易方向值为( "buy" 或 "sell")
      currency string 币种
    • 响应内容

      字段名 类型 是否必须 说明
      pair string 币种对
      sellCurrency string 出售币种
      buyCurrency string 购买币种
      sellCurrencyMax string 出售币种最大数量
      buyCurrencyMax string 购买币种最大数量
      buyCurrencyMin string 购买币种最小数量
      sellCurrencyMin string 出售币种最小数量
    • CURL 请求
    curl --location 'https://openplatform.gateapi.io/v1/pay/convert/pair?currency=GT&side=buy' \
    --header 'Content-Type: application/json' \
    --header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
    --header 'X-GatePay-Timestamp: 1740018611625' \
    --header 'x-GatePay-Nonce: 3347302609' \
    --header 'x-GatePay-Signature: 7209e852c0fca24a9430d097f93331b7d2bac82b2710763a73af67340b67c2d8fef524051d30a3ff42258a93a200b08fdd5849ec2d2fa0f7c7ba9ed52ce38010'
    
    • 响应
    
    {
        "status": "SUCCESS",
        "code": "000000",
        "errorMessage": "",
        "data": [
            {
                "pair": "BTC_USDT",
                "sellCurrency": "BTC",
                "sellCurrencyMax": "31",
                "sellCurrencyMin": "0.0002",
                "buyCurrency": "USDT",
                "buyCurrencyMax": "1980000",
                "buyCurrencyMin": "12"
            },
            {
                "pair": "BNB_USDT",
                "sellCurrency": "BNB",
                "sellCurrencyMax": "410",
                "sellCurrencyMin": "0.1",
                "buyCurrency": "USDT",
                "buyCurrencyMax": "100000",
                "buyCurrencyMin": "10"
            } 
        ]
    }
    

    # 预览报价

    • 数据类型:JSON (content-type:application/json)

    • 请求⽅式:POST

    • 路径Path: /v1/pay/convert/preview

    • 验证方式:签名验证

    • 请求体内容:

      字段名 类型 是否必须 说明
      buyCurrency string 购买币种
      buyAmount string 否 与 sellAmount 二选一 购买数量
      sellCurrency string 出售币种
      sellAmount string 否 与 buyAmount 二选一 出售数量
    • 响应内容

      字段名 类型 是否必须 说明
      sellCurrency string 出售币种
      buyCurrency string 购买币种
      sellAmount string 出售数量
      buyAmount string 购买数量
      price string 价格
      quoteId string 报价ID
    • CURL 请求
    curl --location 'https://openplatform.gateapi.io/v1/pay/convert/preview' \
    --header 'Content-Type: application/json' \
    --header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
    --header 'X-GatePay-Timestamp: 1740019013818' \
    --header 'x-GatePay-Nonce: 9722139164' \
    --header 'x-GatePay-Signature: 8504fe097f7297f8952c76e628ce59dbc93d1df64c95f26c73140ef365d4aa1471826ada0534315461682ec35c131d7e133c51d2ab0822fe7366650a111887ba' \
    --data '{
        "buyCurrency":"USDT",
        "buyAmount":"1",
        "sellCurrency":"GT"
    
    }'
    
    • 响应
    {
        "status": "SUCCESS",
        "code": "000000",
        "errorMessage": "",
        "data": {
            "sellCurrency": "GT",
            "buyCurrency": "USDT",
            "buyAmount": "1",
            "sellAmount": "0.04466796",
            "price": "22.38741462",
            "quoteId": "PAY-16991c65"
        }
    }
    

    # 发起闪兑

    • 数据类型:JSON (content-type:application/json)

    • 请求⽅式:POST

    • 路径Path: /v1/pay/convert

    • 验证方式:签名验证

    • 请求体内容:

      字段名 类型 是否必须 说明
      clientReqId string 客户端请求ID(由用户随机生成目的是为了保证幂等)
      quoteId string 报价ID (必须与preview 接口返回的一致 )
      buyAmount string 购买数量 (必须与preview 接口返回的一致 )
      buyCurrency string 购买币种 (必须与preview 接口返回的一致 )
      sellAmount string 出售数量 (必须与preview 接口返回的一致 )
      sellCurrency string 出售币种 (必须与preview 接口返回的一致 )
    • 响应内容

      字段名 类型 是否必须 说明
      order_id string 订单ID
      userId string 用户ID
      sellCurrency string 出售币种
      buyCurrency string 购买币种
      sellAmount string 出售数量
      buyAmount string 购买数量
      status string 状态 1 - 创建成功 3 - 成功 6 - 失败
      rate string 价格
      quoteId string 报价ID
      createTime string 创建时间
    • CURL 请求
    
    curl --location 'https://openplatform.gateapi.io/v1/pay/convert' \
    --header 'Content-Type: application/json' \
    --header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
    --header 'X-GatePay-Timestamp: 1740019013818' \
    --header 'x-GatePay-Nonce: 9722139164' \
    --header 'x-GatePay-Signature: 8504fe097f7297f8952c76e628ce59dbc93d1df64c95f26c73140ef365d4aa1471826ada0534315461682ec35c131d7e133c51d2ab0822fe7366650a111887ba' \
    --data '{
        "clientReqId":"181147",
            "sellCurrency": "GT",
            "buyCurrency": "USDT",
            "buyAmount": "1",
            "sellAmount": "0.04464002",
            "price": "22.40142565",
            "quoteId": "PAY-2a5743d8"
    }'
    
    
    • 响应
    
    {
        "status": "SUCCESS",
        "code": "000000",
        "errorMessage": "",
        "data": {
            "order_id": "327196066546229248",
            "userId": 10002,
            "sellCurrency": "GT",
            "buyCurrency": "USDT",
            "sellAmount": "0.04464002",
            "buyAmount": "1",
            "status": 1,
            "rate": 22.40142365527614,
            "quoteId": "PAY-2a5743d8",
            "createTime": 1739971221273
        }
    }
    
    

    # 查询订单

    • 数据类型:JSON (content-type:application/json)

    • 请求⽅式:GET

    • 路径Path: /v1/pay/convert/order

    • 验证方式:签名验证

    • 请求参数 (Query String):

      字段名 类型 是否必须 说明
      OrderID string 订单ID
    • 响应内容

      字段名 类型 是否必须 说明
      order_id string 订单ID
      userId string 用户ID
      sellCurrency string 出售币种
      buyCurrency string 购买币种
      sellAmount string 出售数量
      buyAmount string 购买数量
      status string 状态 1 - 创建成功 3 - 成功 6 - 失败
      rate string 价格
      quoteId string 报价ID
      createTime string 创建时间
    • CURL 请求
    curl --location --request GET 'https://openplatform.gateapi.io/v1/pay/convert/order?orderId=326850433152987136' \
    --header 'Content-Type: application/json' \
    --header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
    --header 'X-GatePay-Timestamp: 1740021137456' \
    --header 'x-GatePay-Nonce: 3735215968' \
    --header 'x-GatePay-Signature: 77516a1010d9c8d1f0b8e1d72810b62195ca01f8c1000558a7b1b9de4d79c13200d17036d6e4e555bc2bc4a5ca114b44b616dca03b5f9b72687eb34ebee1515d' \
    --data '{
        "buyCurrency":"BTC",
        "buyAmount":"1",
        "sellCurrency":"ETH",
        "sellAmount":"0"
    }'
    
    • 响应
    {
        "status": "SUCCESS",
        "code": "000000",
        "errorMessage": "",
        "data": {
            "order_id": "326850433152987136",
            "userId": 10002,
            "sellCurrency": "USDT",
            "buyCurrency": "GT",
            "sellAmount": "1",
            "buyAmount": "0.04369692",
            "status": 6,
            "rate": 22.884908135401762,
            "quoteId": "PAY-52f30798",
            "createTime": 1739888815851
        }
    }