API列表 | Roogoo Docs

新建收款订单

post

新建一笔收款订单所需权限：app操作权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

Header parameters

api-keystringOptionalExample: T3h5CSRd3wSlswCrOkXTXuDDM3FWQ2qj

Body

customerIDstringRequired

自定义订单ID

amountstringRequired

金额

Example: 1.01

titlestring · max: 255Required

标题

remarkstring · max: 255Optional

备注

payerEmailstringOptional

付款者邮箱

payerIPstringOptional

付款者IP

tokenSymbolstringRequired

付款币种

Responses

200Success

application/json

post

/api/v1/app/{appID}/order

POST /api/v1/app/{appID}/order HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "tokenSymbol": "",
  "customerID": "",
  "amount": "",
  "title": "",
  "remark": "",
  "payerEmail": "",
  "payerIP": ""
}

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "address": "text",
    "amount": "text",
    "symbol": "text",
    "unit": "text",
    "expireAt": 1,
    "tokenID": 1,
    "orderID": "text"
  }
}

获取订单列表

get

获取APP的订单列表所需权限：APP查询权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/app/{appID}/order

GET /api/v1/app/{appID}/order HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "pageSize": 1,
    "pageNum": 1,
    "data": [
      {
        "orderID": "text",
        "customOrderID": "text",
        "price": "text",
        "minPrice": "text",
        "createdAt": "text",
        "appID": "text",
        "appName": "text",
        "status": "text",
        "stage": "text",
        "mark": "text",
        "billDetails": [
          {
            "billID": "text",
            "tokenID": 1,
            "networkKey": "text",
            "protocol": "text",
            "symbol": "text",
            "fromWallet": "text",
            "toWallet": "text",
            "fromAccountName": "text",
            "fromAccountID": "text",
            "blockNum": 1,
            "confirmBlockNum": 1,
            "latestBlockNum": 1,
            "confirm": "text",
            "amount": "text",
            "fee": "text",
            "netFee": "text",
            "received": "text",
            "createdAt": "text",
            "txHash": "text",
            "txUrl": "text",
            "status": "text"
          }
        ]
      }
    ],
    "total": 1
  }
}

新建付款订单

post

用于新建一笔付款订单，需要注意，调用该接口需要谷歌验证器的验证码所需权限：APP操作权限，付款账户操作权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

accountIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

google-codestringOptional

Body

customerIDstringRequired

自定义订单ID

amountstringRequired

金额

Example: 1.01

remarkstring · max: 255Optional

备注

receiverAddressstringRequired

receiverEmailstringRequired

feeTypestringRequired

Responses

200Success

application/json

post

/api/v1/app/{appID}/payOrder/{accountID}

POST /api/v1/app/{appID}/payOrder/{accountID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "appID": "",
  "tokenID": 0,
  "netWorkKey": "",
  "customerID": "",
  "amount": "",
  "title": "",
  "remark": "",
  "payerEmail": "",
  "payerIP": ""
}

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "address": "text",
    "amount": "text",
    "symbol": "text",
    "unit": "text",
    "expireAt": 1,
    "tokenID": 1,
    "orderID": "text"
  }
}

获取APP列表

get

用于获取app列表所需权限：基础权限

Authorizations

api-keystringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/app

GET /api/v1/app HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "pageSize": 1,
    "pageNum": 1,
    "data": [
      {
        "name": "text",
        "appID": "text",
        "accountID": "text",
        "icon": "text",
        "CreatedAt": "text",
        "language": "text",
        "status": "normal",
        "systemStatus": "normal"
      }
    ],
    "total": 1
  }
}

获取APP

get

获取APP具体信息所需权限：APP查询权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequiredExample: c3ead10b-a00d-11ef-bb06-74d713b1c92e

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/app/{appID}

GET /api/v1/app/{appID} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "CreatedAt": "text",
    "UpdatedAt": "text",
    "userID": 1,
    "appID": "text",
    "accountID": "text",
    "name": "text",
    "icon": "text",
    "title": "text",
    "language": "text",
    "informUrl": "text",
    "tokenID": 1,
    "status": "text",
    "expire": 1,
    "emails": "text",
    "redirectUrl": "text",
    "autoRedirect": true,
    "emailWhenComplete": true,
    "emailWhenException": true,
    "tolerance": "0.001",
    "payToType": "app"
  }
}

获取订单详情

get

获取APP下某个order的具体数据所需权限：app查询权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

orderIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/app/{appID}/order/{orderID}

GET /api/v1/app/{appID}/order/{orderID} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "orderID": "text",
    "customOrderID": "text",
    "appID": "text",
    "appName": "text",
    "price": "text",
    "minPrice": "text",
    "received": "text",
    "fee": "text",
    "symbol": "text",
    "informUrl": "text",
    "redirectUrl": "text",
    "status": "text",
    "stage": "text",
    "mark": "text",
    "createdAt": "text",
    "expireAt": 1,
    "title": "text",
    "remark": "text",
    "fromEmail": "text",
    "fromIP": "text",
    "tokenID": 1,
    "billDetailList": [
      "text"
    ],
    "orderEventList": [
      {
        "CreatedAt": "text",
        "orderID": "text",
        "eventType": "text",
        "stage": "text",
        "status": "text",
        "desc": "text"
      }
    ],
    "refundList": [
      "text"
    ]
  }
}

修改订单状态

patch

修改订单的状态，仅在订单处于close阶段可以调用。目前仅支持从expire设置为invalid或complete状态，和从invalid设置为conplete状态所需权限为：APP操作权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

orderIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Body

statusstring · enumRequired

只有阶段为close的订单可以修改

Possible values:

Responses

200Success

application/json

Responseobject

patch

/api/v1/app/{appID}/order/{orderID}

PATCH /api/v1/app/{appID}/order/{orderID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "invalid"
}

200Success

{}

订单退款

post

用于向指定地址退款。需要注意的是，只有close阶段的订单可以退款。退款金额估值累计不能超过订单金额估值。所需权限：APP操作权限，退款账户操作权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

orderIDstringRequired

accountIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Body

amountstringRequired

退款金额

toWalletstringRequired

退款收款地址

FeeTypestring · enumRequired

网络费扣除方式

Possible values:

remarkstring · max: 255Required

备注

Responses

200Success

application/json

post

/api/v1/app/{appID}/order/{orderID}/refund/{accountID}

POST /api/v1/app/{appID}/order/{orderID}/refund/{accountID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "amount": "text",
  "toWallet": "text",
  "FeeType": "fromPaid",
  "remark": "text"
}

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "billID": "text",
    "symbol": "text",
    "network": "text",
    "protocol": "text",
    "accountType": "text",
    "accountID": "text",
    "receiverAddress": "text",
    "amount": "text",
    "netFee": "text",
    "receiveAmount": "text",
    "status": "text"
  }
}

订单退款撤销

delete

用于撤销一笔退款，仅在退款账单处于审核（review）状态可以操作所需权限：APP操作权限

Authorizations

api-keystringRequired

Path parameters

appIDstringRequired

orderIDstringRequired

退款订单ID

billIDstringRequired

退款账单ID

Header parameters

api-keystringOptionalExample: {{api-key}}

Body

objectOptional

Responses

200Success

application/json

delete

/api/v1/app/{appID}/order/{orderID}/refund/{billID}

DELETE /api/v1/app/{appID}/order/{orderID}/refund/{billID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": null
}

获取account列表

get

用于获取APP列表所需权限：基础权限

Authorizations

api-keystringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/account

GET /api/v1/account HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    {
      "CreatedAt": "text",
      "userID": 1,
      "accountID": "text",
      "type": "system",
      "name": "text",
      "icon": "text",
      "status": "normal",
      "systemStatus": "normal"
    }
  ]
}

根据ID获取账户

get

用于获取账户的详细信息所需权限：账户查询权限

Authorizations

api-keystringRequired

Path parameters

accountIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/account/{accountID}

GET /api/v1/account/{accountID} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    {
      "CreatedAt": "text",
      "userID": 1,
      "accountID": "text",
      "type": "system",
      "name": "text",
      "icon": "text",
      "status": "normal",
      "systemStatus": "normal"
    }
  ]
}

获取充值地址

get

该接口用于获取像资金账户充值的链上地址所需权限：资金账户读取权限

Authorizations

api-keystringRequired

Query parameters

tokenIDstringRequired

充值币种ID

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/assets/topup

GET /api/v1/assets/topup?tokenID=text HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "address": "text",
    "symbol": "text",
    "contract": "text",
    "logo": "text",
    "confirmNum": 1
  }
}

资金划转

post

Authorizations

api-keystringRequired

Path parameters

accountFromstringRequired

accountTostringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

Body

tokenSymbolstringRequired

币种符号

numstringRequired

转移的币数量

Responses

200Success

application/json

post

/api/v1/assets/transfer/{accountFrom}/{accountTo}

POST /api/v1/assets/transfer/{accountFrom}/{accountTo} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "tokenSymbol": "text",
  "num": "text"
}

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    {
      "CreatedAt": "text",
      "userID": 1,
      "accountID": "text",
      "type": "system",
      "name": "text",
      "icon": "text",
      "status": "normal",
      "systemStatus": "normal"
    }
  ]
}

获取账户的资金账单

get

该接口用于获取账户的账单所需权限：账户查询权限

Authorizations

api-keystringRequired

Path parameters

accountIDstringRequired

Query parameters

pageSizeinteger · min: 6 · max: 50Optional

每页大小

Default: 10Example: 10

pageNumintegerOptional

页码

Default: 1Example: 1

Header parameters

api-keystringOptionalExample: {{api-key}}

Responses

200Success

application/json

get

/api/v1/assets/bill/{accountID}

GET /api/v1/assets/bill/{accountID} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "pageSize": 1,
    "pageNum": 1,
    "order": true,
    "orderBy": "text",
    "data": [
      {
        "billID": "receive",
        "type": "text",
        "amount": "text",
        "balance": "text",
        "accountName": "text",
        "origin": "auto",
        "remark": "text",
        "tokenSymbol": "text",
        "tokenID": 1,
        "timestamp": 1,
        "negative": true
      }
    ],
    "total": 1
  }
}

提现

post

该接口用于从某账户提现数字货币，需要注意，调用该接口需要邮箱验证码和谷歌验证器验证码所需权限：账户的操作权限

Authorizations

api-keystringRequired

Path parameters

accountIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

google-codestringOptional

email-codestringOptional

Body

addressstringRequired

networkstringRequired

网络唯一标识

withdrawAmountstringRequired

remarkstringOptional

tokenIDintegerRequired

token的唯一ID

Responses

200Success

application/json

Responseobject

post

/api/v1/assets/withdraw/{accountID}

POST /api/v1/assets/withdraw/{accountID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "address": "text",
  "network": "text",
  "withdrawAmount": "text",
  "remark": "text",
  "tokenID": 1
}

200Success

{}

发送提现邮箱验证码

post

用于获取提现时所需的邮箱验证码。所需权限：基础权限

Authorizations

api-keystringRequired

Path parameters

accountIDstringRequired

Header parameters

api-keystringOptionalExample: {{api-key}}

google-codestringOptional

email-codestringOptional

Body

addressstringRequired

networkstringRequired

网络唯一标识

withdrawAmountstringRequired

remarkstringOptional

tokenIDstringRequired

token的唯一ID

Responses

200Success

application/json

Responseobject

post

/api/v1/assets/withdraw/{accountID}/sendValidateCode

POST /api/v1/assets/withdraw/{accountID}/sendValidateCode HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "address": "text",
  "network": "text",
  "withdrawAmount": "text",
  "remark": "text",
  "tokenID": "text"
}

200Success

{}

获取网络列表

get

获取平台支持的网络的唯一标识符networkKey列表所需权限：基础权限

Authorizations

api-keystringRequired

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

get

/api/v1/network

GET /api/v1/network HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    "text"
  ]
}

获取token列表

get

获取平台支持的所有token列表所需权限：基础权限

Authorizations

api-keystringRequired

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

get

/api/v1/token

GET /api/v1/token HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    {
      "token_id": 1,
      "symbol": "text",
      "network_key": "text",
      "protocol": "text",
      "contract_address": "text",
      "full_name": "text",
      "logo": "text",
      "company": "text"
    }
  ]
}

获取token种类

get

获取平台支持的token种类所需权限：基础权限

Authorizations

api-keystringRequired

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

get

/api/v1/tokenKind

GET /api/v1/tokenKind HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": [
    {
      "symbol": "text",
      "logo": "text",
      "company": "text"
    }
  ]
}

获取token

get

通过指定的tokenID查询token的具体参数信息所需权限：基础权限

Path parameters

tokenIDstringRequired

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

get

/api/v1/token/{tokenID}

GET /api/v1/token/{tokenID} HTTP/1.1
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "ID": 1,
    "networkKey": "text",
    "protocol": "text",
    "symbol": "text",
    "fullName": "text",
    "contract": "text",
    "logo": "text",
    "company": "text",
    "defaultUnit": "text",
    "minUnit": "text",
    "decimal": 1,
    "displayDecimal": 1,
    "feeRate": "text"
  }
}

获取网络

get

通过网络唯一标识符networkKey 查询网络的具体参数所需权限：基础权限

Authorizations

api-keystringRequired

Path parameters

networkKeystringRequiredExample: TRON-NILE

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

get

/api/v1/network/{networkKey}

GET /api/v1/network/{networkKey} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "networkKey": "text",
    "accountKey": "text",
    "decimal": 1,
    "symbol": "text",
    "fullSymbol": "text",
    "archType": "text",
    "confirmStrategy": 1,
    "ScanURL": "text",
    "orderExpireSecond": 1,
    "netFee": "text"
  }
}

获取网络最新块高

get

建立一个SSE长连接，持续推送指定networkKey网络的最新区块高度所需权限：基础权限

Authorizations

api-keystringRequired

Path parameters

networkKeystringRequiredExample: TRON-NILE

Header parameters

api-keystringOptionalExample: 4FW3Sebox80ylywUBsYbdLAIzwgGeqnK

Responses

200Success

application/json

Responseobject

get

/api/v1/network/{networkKey}/latestBlockNumber

GET /api/v1/network/{networkKey}/latestBlockNumber HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200Success

{}

更改订单邮箱和网络

patch

Authorizations

api-keystringRequired

Path parameters

orderIDstringRequired

Body

emailstringOptional

networkstringOptional

Responses

200Success

application/json

Responseobject

patch

/api/v1/payer/order/{orderID}

PATCH /api/v1/payer/order/{orderID} HTTP/1.1
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "email": "text",
  "network": "text"
}

200Success

{}

获取支付信息

get

Authorizations

api-keystringRequired

Path parameters

orderIDstringRequired

Responses

200Success

application/json

x-200:成功（已经填写了信息）

application/json

get

/api/v1/payer/{orderID}

GET /api/v1/payer/{orderID} HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

{
  "code": 1,
  "msg": "text",
  "rawErrMsg": null,
  "data": {
    "needEmail": true,
    "needNetWork": true
  }
}

hashtag新建收款订单

hashtag获取订单列表

hashtag新建付款订单

hashtag获取APP列表

hashtag获取APP

hashtag获取订单详情

hashtag修改订单状态

hashtag订单退款

hashtag订单退款撤销

hashtag获取account列表

hashtag根据ID获取账户

hashtag获取充值地址

hashtag资金划转

hashtag获取账户的资金账单

hashtag提现

hashtag发送提现邮箱验证码

hashtag获取网络列表

hashtag获取token列表

hashtag获取token种类

hashtag获取token

hashtag获取网络

hashtag获取网络 最新块高

hashtag更改订单邮箱和网络

hashtag获取支付信息

新建收款订单

获取订单列表

新建付款订单

获取APP列表

获取APP

获取订单详情

修改订单状态

订单退款

订单退款撤销

获取account列表

根据ID获取账户

获取充值地址

资金划转

获取账户的资金账单

提现

发送提现邮箱验证码

获取网络列表

获取token列表

获取token种类

获取token

获取网络

获取网络最新块高

更改订单邮箱和网络

获取支付信息