查询能量值购买结果

生产环境

GET

https://apis.avata.bianjie.ai/v1beta1/orders/{order_id}

AVATA API 文档/AVATA API 文档/AVATA v1 API 文档/购买能量值接口

根据指定的 OrderID，查询相关的订单信息。

当前支持查询当月及上个月的购买结果，其它月历史数据已归档，暂不支持查询对应结果。

注意：

若查询出的订单状态 status 为 failed（充值失败），说明该交易执行失败。请在业务侧做容错处理。可以参考接口返回的 message（订单失败的错误描述信息）对业务接口的请求参数做适当调整后，使用 「新的 Order ID 」 重新发起业务接口请求。

请求参数

Path 参数

order_id

string

Order ID

必需

Header 参数

Content-Type

string

必需

固定值：application/json

X-Api-Key

string

必需

项目 API Key，用于 API 访问鉴权

X-Timestamp

string

必需

时间戳，1970年1月1日0点0分0秒到现在的毫秒数

X-Signature

string

必需

API 签名，算法为SHA256(Params+Timestamp+ApiSecret)

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://apis.avata.bianjie.ai/v1beta1/orders/' \
--header 'X-Api-Key;' \
--header 'X-Api-Key;' \
--header 'X-Timestamp;' \
--header 'X-Timestamp;' \
--header 'X-Signature;' \
--header 'X-Signature;'

返回响应

🟢200successful operation

application/json

Body

data

object

正确返回值

可选

order_id

string

订单流水号

必需

>= 10 字符<= 36 字符

status

string

必需

订单状态：success 充值成功 / failed 充值失败 / pending 正在充值

订单状态说明：

status 为 pending（正在充值），请等待充值完成；

status 为 success（充值成功），能量值/业务费充值成功；

status 为 failed（充值失败），说明该交易执行失败。**请在业务侧做容错处理。可以参考接口返回的 message（订单失败的错误描述信息）对业务接口的请求参数做适当调整后，使用「新的 Order ID 」**重新发起业务接口请求。

message

string

可选

订单失败的错误描述信息

account

string

可选

链账户地址

（调用「批量购买能量值」接口不展示此字段）

<= 128 字符

amount

string

可选

充值金额，为整数元金额；单位：分

（调用「批量购买能量值」接口不展示此字段）

number

string

可选

充值的数量，充值 gas 该值单位为 ugas，充值业务费单位为分

（调用「批量购买能量值」接口不展示此字段）

create_time

string

必需

创建时间（UTC 时间）

update_time

string

必需

最后操作时间（UTC 时间）

order_type

string

必需

订单类型，gas / business

示例

{
  "data": {
    "order_id": "stringstri",
    "status": "string",
    "message": "string",
    "account": "string",
    "amount": "string",
    "number": "string",
    "create_time": "string",
    "update_time": "string",
    "order_type": "string"
  }
}

修改于 2023-07-14 15:01:31

批量购买能量值

查询能量值购买结果列表