Satogate 接口文档

Description:Satogate 接口文档

HOST: https://api.satogate.io

Contacts:

Version:v1.0

URL:/v3/api-docs

[TOC]

01.货币信息

支持的货币列表

url:/currency/list

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

None

Response Example:

{
  "data": {
    "BSC": [
      {
        "symbol": "BNB",
        "contract": null,
        "icon": "https://pifutures.oss-cn-shanghai.aliyuncs.com/cash/bnb.png",
        "decimals": 18,
        "minCharge": "0"
      },
      {
        "symbol": "USDT",
        "contract": "0x0047b319f85284acb41d29fc2a1fa9066a13fe3f",
        "icon": "https://pifutures.oss-cn-shanghai.aliyuncs.com/cash/usdt.png",
        "decimals": 6,
        "minCharge": "100.0"
      },
      {
        "symbol": "USDC",
        "contract": "0x0047b319f85284acb41d29fc2a1fa9066a13fe3f",
        "icon": "https://pifutures.oss-cn-shanghai.aliyuncs.com/cash/usdc.png",
        "decimals": 18,
        "minCharge": "0"
      }
    ],
    "TRON": [
      {
        "symbol": "TRX",
        "contract": null,
        "icon": "https://pifutures.oss-cn-shanghai.aliyuncs.com/cash/TRX.png",
        "decimals": 12,
        "minCharge": "0"
      },
      {
        "symbol": "USDT",
        "contract": "TAK91B45WCr8Dz8QZQZGwHgvEZJEYa8wQK",
        "icon": "https://pifutures.oss-cn-shanghai.aliyuncs.com/cash/usdt.png",
        "decimals": 6,
        "minCharge": "0"
      }
    ]
  },
  "code": 200,
  "message": ""
}

02.钱包地址

获取收款地址

url:/wallet/address

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

本接口接受一个可选参数merchantAddressId。
当参数为空时，会生成一次性收款地址，并包含一个充值订单ID；
当参数不为空时，将生成一个与此ID绑定的钱包地址，并持续监听收款情况，商户需要维护此ID与收款地址的关联，该情况下，返回结果将不包含充值订单ID（depositOrderId）
*目前暂不支持一次性钱包地址，merchantAddressId必填

Example:

{
  "merchantAddressId": "String, 必填"
}

Params:

Status:

Response Params:

Response Example:

{
    "depositOrderId": "",
    "merchantAddressId": "",
    "type": "BOUND/DISPOSABLE",
    "wallets": [
        {
            "address": "",
            "chain": "ETH/BSC/TRON",
            "supportTokens": []
        }
    ]
}

钱包充值历史流水

url:/wallet/deposit/history

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

merchantAddressId与address两者必填其一

Params:

Status:

Response Params:

Response Example:

{
    "data": [
        {
            "address": "",
            "amount": "",
            "amountUsd": "",
            "chain": "ETH/BSC/TRON",
            "createTime": 0,
            "depositAmount": "",
            "finishedTime": 0,
            "fromAddress": "",
            "id": "",
            "merchantAddressId": "",
            "orderModeStatus": "",
            "settleTxid": "",
            "status": "",
            "token": "USDT",
            "txHash": "",
            "txList": []
        }
    ],
    "page": 0,
    "pageSize": 0,
    "total": 0
}

查询项目ACCOUNT信息

url:/wallet/project/account

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": [
        {
            "address": "",
            "balance": "",
            "chain": "",
            "currency": "",
            "id": ""
        }
    ],
    "message": ""
}

查询实时链上余额

url:/wallet/project/account/balance

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": "",
    "message": ""
}

商户创建新项目

url:/wallet/project/create

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "assembleAddress": "",
  "assembleChain": "",
  "callbackUrl": "",
  "name": "String, 必填",
  "paymentPageCallbackUrl": "String, 选填",
  "settleToken": ""
}

Params:

Status:

Response Params:

Response Example:

{
    "apiKey": "",
    "apiSecret": "",
    "assembleAddress": "",
    "assembleChain": "",
    "projectName": "",
    "settleToken": ""
}

钱包转账流水

url:/wallet/transfer/history

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "content": [
        {
            "amount": "",
            "chain": "",
            "createTime": 0,
            "currency": "",
            "fromAddress": "",
            "gas": "",
            "gasPrice": "",
            "id": "",
            "status": "",
            "toAddress": "",
            "txTime": 0,
            "txid": ""
        }
    ],
    "last": true,
    "page": 0,
    "page_size": 0,
    "total": 0,
    "total_pages": 0
}

03.充值订单

修改订单状态

url:/deposit_order/changeStatus

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "id": "",
  "status": "FINISHED/TIMEOUT"
}

Params:

Status:

Response Params:

Response Example:

{
    "address": "",
    "amount": "",
    "amountUsd": "",
    "chain": "ETH/BSC/TRON",
    "createTime": 0,
    "depositAmount": "",
    "finishedTime": 0,
    "fromAddress": "",
    "id": "",
    "merchantAddressId": "",
    "orderModeStatus": "",
    "settleTxid": "",
    "status": "",
    "token": "USDT",
    "txHash": "",
    "txList": []
}

(新)获取收款地址

url:/deposit_order/depositAddress

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "merchantOrderAmount": 0,
  "merchantOrderExpireTime": 0,
  "merchantOrderId": "String, 必填"
}

Params:

Status:

Response Params:

Response Example:

{
    "depositOrderId": "",
    "merchantOrderId": "",
    "type": "BOUND/DISPOSABLE",
    "wallets": [
        {
            "address": "",
            "chain": "ETH/BSC/TRON",
            "supportTokens": []
        }
    ]
}

查询订单详情

url:/deposit_order/detail

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "address": "",
    "amount": "",
    "amountUsd": "",
    "chain": "ETH/BSC/TRON",
    "createTime": 0,
    "depositAmount": "",
    "finishedTime": 0,
    "fromAddress": "",
    "id": "",
    "merchantAddressId": "",
    "orderModeStatus": "",
    "settleTxid": "",
    "status": "",
    "token": "USDT",
    "txHash": "",
    "txList": []
}

锁定价格并提交订单

url:/deposit_order/lock

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "asset": "充值币种",
  "chain": "充值链",
  "depositOrderId": "充值订单id",
  "merchantOrderId": "商户方订单ID",
  "price": 0
}

Params:

Status:

Response Params:

Response Example:

{
    "amount": 0,
    "asset": "",
    "chain": "",
    "depositAddress": "",
    "price": 0
}

询价

url:/deposit_order/quote

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "assetAmount": 0,
    "price": 0
}

解锁订单价格

url:/deposit_order/unlock

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "depositOrderId": "充值订单id",
  "merchantOrderId": "商户方订单id"
}

Params:

Status:

Response Params:

None

Response Example:

04.项目模块

创建项目

url:/project/create

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "assembleAddr": "",
  "assembleChain": "",
  "name": "",
  "settleCurrency": ""
}

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": {
        "appKey": "",
        "assembleAddress": "",
        "assembleChain": "",
        "callbackDomain": "",
        "callbackUrl": "",
        "createTime": 0,
        "id": "",
        "name": "",
        "paymentPageUrl": "",
        "settleCurrency": "",
        "status": ""
    },
    "message": ""
}

项目列表

url:/project/list

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": {
        "content": [
            {
                "appKey": "",
                "assembleAddress": "",
                "assembleChain": "",
                "callbackDomain": "",
                "callbackUrl": "",
                "createTime": 0,
                "id": "",
                "name": "",
                "paymentPageUrl": "",
                "settleCurrency": "",
                "status": ""
            }
        ],
        "last": true,
        "page": 0,
        "page_size": 0,
        "total": 0,
        "total_pages": 0
    },
    "message": ""
}

移除项目

url:/project/remove

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "projectId": ""
}

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": true,
    "message": ""
}

查询项目App Secret

url:/project/secret

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": "",
    "message": ""
}

05.转账服务

发起转账

url:/transaction/transfer

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "amount": "充值数量",
  "asset": "充值币种",
  "chain": "区块链",
  "toAddress": "收款地址"
}

Params:

Status:

Response Params:

Response Example:

{
    "code": 0,
    "data": {
        "amount": "",
        "chain": "",
        "createTime": 0,
        "currency": "",
        "fromAddress": "",
        "gas": "",
        "gasPrice": "",
        "id": "",
        "status": "",
        "toAddress": "",
        "txTime": 0,
        "txid": ""
    },
    "message": ""
}

06.支付页面

锁定价格并提交订单

url:/paymentPage/depositOrder/lock

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "asset": "充值币种",
  "chain": "充值链",
  "depositOrderId": "充值订单id",
  "merchantOrderAmount": 0,
  "merchantOrderExpireTime": 0,
  "merchantOrderId": "商户方订单ID",
  "price": 0
}

Params:

Status:

Response Params:

Response Example:

{
    "amount": 0,
    "asset": "",
    "chain": "",
    "depositAddress": "",
    "price": 0
}

解锁订单价格

url:/paymentPage/depositOrder/unlock

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

Example:

{
  "depositOrderId": "充值订单id",
  "merchantOrderAmount": 0,
  "merchantOrderExpireTime": 0,
  "merchantOrderId": "商户方订单id"
}

Params:

Status:

Response Params:

None

Response Example:

生成payment page跳转链接

url:/paymentPage/gen_payment_page

method:POST

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

None

Response Example:

PaymentPage页面参数

url:/paymentPage/index

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

Params:

Status:

Response Params:

Response Example:

{
    "name": "",
    "ppUrl": "",
    "priceLockSecond": 0,
    "requestedDepositOrderInfo": {
        "asset": "",
        "chain": "",
        "id": "",
        "lastPriceLockedTime": 0,
        "price": 0,
        "status": ""
    },
    "wallets": [
        {
            "address": "",
            "chain": "ETH/BSC/TRON",
            "chainId": "",
            "tokens": [
                {
                    "contract": "",
                    "decimals": 0,
                    "enabled": false,
                    "icon": "",
                    "minCharge": "",
                    "symbol": ""
                }
            ]
        }
    ]
}

07.结算订单

结算历史流水

url:/settlement_order/history

method:GET

produces:application/x-www-form-urlencoded

consumes:*/*

Note:

每一条结算记录包含相关的充值订单，字段:depositOrderList，是由order id组成的列表

Params:

Status:

Response Params:

Response Example:

{
    "data": [
        {
            "amount": "",
            "createTime": 0,
            "currency": "ETH/BNB/TRX/USDT/USDC/USD",
            "depositOrderList": [],
            "errorMsg": "",
            "finishedTime": 0,
            "id": "",
            "status": ""
        }
    ],
    "page": 0,
    "pageSize": 0,
    "total": 0
}

08.回调模板

回调给商家接口（demo）

url:/demo/callback

method:POST

produces:application/x-www-form-urlencoded,application/json

consumes:*/*

Note:

当商户接受到请求并处理完成后，返回字符串“OK”即可。

Example:

{
  "address": "",
  "amount": "",
  "amountUsd": "",
  "chain": "ETH/BSC/TRON",
  "createTime": 0,
  "finishedTime": 0,
  "fromAddress": "",
  "id": "",
  "merchantAddressId": "",
  "merchantOrderId": "",
  "orderModeStatus": "",
  "status": "",
  "token": "USDT",
  "txHash": "",
  "txList": []
}

Params:

Status:

Response Params:

None

Response Example: