跳转到主要内容
1签 (OneSign)

查询账号可用余额

本页内容

查询当前账号可用余额和金额单位。

适用场景

需要展示余额或在购买前确认资金情况时使用。

开始前

请先在开发者中心完成 API 接入配置,并为目标应用授予本次操作所需的权限。尚未完成首次调用时,请先阅读快速开始。

  • 具备账号财务只读权限。此接口返回当前账号的余额,不能通过参数选择其他用户。
所需权限
billing:ReadBalance,账号须开放财务查询,资源范围须覆盖全部自有应用
认证方式
长期 AccessKey(AKP),服务端 HMAC 签名

权限、应用范围和来源 IP 均需符合接入配置。详细说明见访问权限。

调用步骤

  1. 确认财务查询权限。
  2. 查询当前余额。
  3. 同时展示金额和返回的金额单位。

实际付款仍以服务端受理时的余额和预算检查为准。

请求方式

GET /api/v1/billing/balance
操作标识
getBalance
请求域名
https://www.onesignios.com
频率限制
账号财务读取共用每分钟 30 次额度。账号与 API 应用的额度同时生效。达到限额时按 Retry-After 等待。

请求参数

此接口没有业务路径参数或查询参数。

AccessKey 认证请求头

下表适用于 AccessKey 调用,由服务端 SDK 自动生成。使用长期或临时凭据自行实现 HTTP 调用时,请按照请求签名说明处理。

字段必填说明
Authorization 是

AccessKey 调用的认证签名,格式为 CS1-HMAC-SHA256 Credential=密钥ID,Signature=签名。使用 SDK 时自动生成。

类型:string · 位置:Header

X-Api-Date 是

UTC 时间,格式 YYYY-MM-DDTHH:mm:ssZ。与服务器的时间偏差最多 300 秒。

类型:string · 位置:Header

查看取值约束
  • 数据格式 date-time
X-Api-Nonce 是

每次请求生成 16 个随机字节,转为 32 位小写十六进制。重试时重新生成。

类型:string · 位置:Header

查看取值约束
  • 格式 ^[a-f0-9]{32}$
X-Api-Content-Sha256 是

实际发送的正文原始字节的 SHA-256 小写十六进制。GET 计算空字节串。

类型:string · 位置:Header

查看取值约束
  • 格式 ^[a-f0-9]{64}$
X-Api-Environment 是

生产环境传 production。

类型:string · 位置:Header

查看取值约束
  • 固定值 production

本接口仅支持长期 AccessKey,不支持临时凭据或 OAuth Bearer。查看认证方式对照。

请求体

GET 请求不发送正文。签名中的正文摘要取零字节内容的 SHA-256。

成功响应

HTTP 200 返回 JSON。请记录 request_id,排查问题时可提供此值。查看成功、失败与异步结果的区别。

如何判断结果

金额按字符串保留两位小数,同时读取金额单位。不要用二进制浮点数计算账务金额。

返回字段

字段按对象层级列出,[] 表示数组元素。“必返”指该对象出现时字段是否必须存在,值仍可能允许为 null;具体类型见展开说明。

字段必返说明
request_id 是

平台生成的请求标识。排查问题时请提供此值。

类型:string

查看取值约束
  • 格式 ^[a-f0-9]{32}$

示例:00000000000000000000000000000000

data 是

本次调用的业务结果,结构取决于操作。

类型:object

data.available 是

查询时账户可用的站内余额。

类型:string

查看取值约束
  • 格式 ^-?[0-9]{1,11}\.[0-9]{2}$

示例:100.25

data.currency 是

站内金额单位及展示信息,按本站配置解释所有金额。

类型:object

data.currency.code 是

站内金额单位代码,例如 CNY、USD 或 POINT。

类型:string

查看示例

示例:POINT

data.currency.unit 是

站点配置的金额单位显示名称。

类型:string

查看示例

示例:点

data.currency.external_settlement 是

外部支付的结算币种以支付渠道为准。

类型:string

查看示例

示例:payment_provider

data.observed_at 是

余额或预算的观测时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0

示例:1794000000

调用示例

请把示例中的应用 ID、资源 ID和业务数据替换为自己账号的真实返回值,再选择一种语言运行。安装、文件放置和 CLOUDSIGN_BASE_URL 等配置见SDK 使用说明。

下载示例依赖

Python 标准库示例使用 cloudsign_request.py;使用 SDK 时仅需准备所选语言。长期 Secret 保存在服务端,浏览器和移动端使用OAuth 授权。

调用示例
HTTP 请求
GET /api/v1/billing/balance HTTP/1.1
Host: www.onesignios.com
Authorization: CS1-HMAC-SHA256 Credential=<AccessKey ID>,Signature=<签名>
X-Api-Date: <当前 UTC 时间>
X-Api-Nonce: <新生成的 32 位十六进制值>
X-Api-Content-Sha256: <正文摘要>
X-Api-Environment: production
Python 标准库调用
Python
from cloudsign_request import request

result = request(
    'GET',
    '/api/v1/billing/balance',
)
print(result["request_id"])
Python SDK 调用
Python SDK
import os
from cloudsign import Client

client = Client(
    "https://www.onesignios.com",
    os.environ["CLOUDSIGN_ACCESS_KEY_ID"],
    os.environ["CLOUDSIGN_ACCESS_KEY_SECRET"],
    os.environ.get("CLOUDSIGN_SECURITY_TOKEN", ""),
)

result = client.get_balance()
print(result["request_id"])
PHP SDK 调用
PHP SDK
<?php
declare(strict_types=1);

// Extract the PHP SDK source ZIP beside this file. Keep credentials on your server.
require_once __DIR__ . '/cloudsign-sdk/php/Client.php';
$requiredEnv = static function (string $name): string {
    $value = getenv($name);
    if ($value === false || $value === '') { throw new RuntimeException('Missing environment variable'); }
    return $value;
};
try {
    $client = new \Cloudsign\Sdk\Client(
        $requiredEnv('CLOUDSIGN_BASE_URL'),
        $requiredEnv('CLOUDSIGN_ACCESS_KEY_ID'),
        $requiredEnv('CLOUDSIGN_ACCESS_KEY_SECRET'),
        getenv('CLOUDSIGN_SECURITY_TOKEN') ?: '',
    );
    $result = $client->getBalance();
    echo $result['request_id'], PHP_EOL;
} catch (\Cloudsign\Sdk\ApiError $error) {
    fwrite(STDERR, 'HTTP ' . $error->status . ' ' . $error->apiCode . '; RequestId: ' . $error->requestId . PHP_EOL);
    exit(1);
} catch (Throwable $error) {
    fwrite(STDERR, "Check SDK path, runtime and environment variables.\n");
    exit(1);
}
Node.js SDK 调用
Node.js SDK
// Node.js 20+ on a trusted server. Do not bundle this SDK in browsers or Vue.
import { ApiError, Client } from './cloudsign-sdk/node/client.mjs';

const requiredEnv = name => {
    const value = process.env[name];
    if (!value) throw new Error('Missing environment variable');
    return value;
};
try {
    const client = new Client(
        requiredEnv('CLOUDSIGN_BASE_URL'),
        requiredEnv('CLOUDSIGN_ACCESS_KEY_ID'),
        requiredEnv('CLOUDSIGN_ACCESS_KEY_SECRET'),
        process.env.CLOUDSIGN_SECURITY_TOKEN || '',
    );
    const result = await client.getBalance();
    console.log(result.request_id);
} catch (error) {
    if (error instanceof ApiError) console.error(`HTTP ${error.status} ${error.code}; RequestId: ${error.requestId}`);
    else console.error('Check SDK path, runtime and environment variables.');
    process.exitCode = 1;
}
Go SDK 调用
Go SDK
// Go 1.22+, trusted server. Extract the Go SDK ZIP beside example.go.
package main

import (
    "context"
    "errors"
    "fmt"
    "os"
    "time"

    cloudsign "cloudsign/sdk"
)

func main() {
    fail := func(err error) {
        var api *cloudsign.APIError
        if errors.As(err, &api) {
            fmt.Fprintf(os.Stderr, "HTTP %d %s; RequestId: %s\n", api.Status, api.Code, api.RequestID)
        } else {
            fmt.Fprintln(os.Stderr, "Check SDK path, runtime and environment variables.")
        }
        os.Exit(1)
    }
    client, err := cloudsign.New(
        os.Getenv("CLOUDSIGN_BASE_URL"),
        os.Getenv("CLOUDSIGN_ACCESS_KEY_ID"),
        os.Getenv("CLOUDSIGN_ACCESS_KEY_SECRET"),
        os.Getenv("CLOUDSIGN_SECURITY_TOKEN"),
    )
    if err != nil { fail(err); return }
    ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
    defer cancel()
    result, err := client.GetBalance(
		ctx,
	)
    if err != nil { fail(err); return }
    fmt.Println(result.RequestID)
}
Java SDK 调用
Java SDK
// Java 17+, server-side. Extract the Java SDK ZIP beside Example.java.
import com.cloudsign.openapi.Client;
import java.util.*;

public class Example {
    private static String env(String name) {
        String value = System.getenv(name);
        if (value == null || value.isEmpty()) throw new IllegalArgumentException("Missing environment variable");
        return value;
    }
    private static Map<String,Object> object(Object... pairs) {
        var result = new LinkedHashMap<String,Object>();
        for (int i = 0; i < pairs.length; i += 2) result.put((String)pairs[i], pairs[i+1]);
        return result;
    }
    public static void main(String[] args) {
        try {
            var client = new Client(
                env("CLOUDSIGN_BASE_URL"),
                env("CLOUDSIGN_ACCESS_KEY_ID"),
                env("CLOUDSIGN_ACCESS_KEY_SECRET"),
                System.getenv().getOrDefault("CLOUDSIGN_SECURITY_TOKEN", "")
            );
            var result = client.getBalance();
            System.out.println(result.requestId());
        } catch (Client.ApiException error) {
            System.err.printf("HTTP %d %s; RequestId: %s%n", error.status, error.code, error.requestId);
            System.exit(1);
        } catch (Exception error) {
            if (error instanceof InterruptedException) Thread.currentThread().interrupt();
            System.err.println("Check SDK path, runtime and environment variables.");
            System.exit(1);
        }
    }
}
Rust SDK 调用
Rust SDK
// Rust 1.88+, trusted server. Save as cloudsign-sdk/rust/examples/example.rs.
use cloudsign_openapi::{Client, Credentials, GetBalance};
use serde_json::json;
use std::{env, error::Error};

async fn run() -> Result<(), Box<dyn Error>> {
    let origin = env::var("CLOUDSIGN_BASE_URL")?;
    let credentials = Credentials::new(
        env::var("CLOUDSIGN_ACCESS_KEY_ID")?,
        env::var("CLOUDSIGN_ACCESS_KEY_SECRET")?,
        env::var("CLOUDSIGN_SECURITY_TOKEN").ok().filter(|v| !v.is_empty()),
        None,
    )?;
    let client = Client::new(&origin, credentials)?;
    let input: GetBalance = serde_json::from_value(json!({}))?;
    let result = client.get_balance(&input).await?;
    println!("{}", result.request_id);
    Ok(())
}

#[tokio::main]
async fn main() {
    if let Err(error) = run().await {
        if let Some(api) = error.downcast_ref::<cloudsign_openapi::Error>() {
            eprintln!("HTTP {} {}; RequestId: {}", api.status, api.code, api.request_id.as_deref().unwrap_or(""));
        } else {
            eprintln!("Check SDK path, runtime, environment variables and business input.");
        }
        std::process::exit(1);
    }
}
C SDK 调用

请求对象和响应对象的使用方式见C SDK 请求与响应。

C SDK
/* C11, trusted server. Save as example.c in the source ZIP root. */
#include <cloudsign/openapi.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

static int copy_env(char *out, size_t capacity, const char *name, int required) {
    const char *value = getenv(name);
    if (!value || !*value) return !required;
    size_t length = strlen(value);
    if (length >= capacity) return 0;
    memcpy(out, value, length + 1);
    return 1;
}

int main(void) {
    cloudsign_credentials credentials = {0};
    cloudsign_client *client = NULL;
    cloudsign_result *result = NULL;
    cloudsign_decoded_response *decoded = NULL;
    cloudsign_built_request *built = NULL;
    cloudsign_status status = CLOUDSIGN_INVALID_CONFIGURATION;
    int initialized = 0, exit_code = 1;
    const char *origin = getenv("CLOUDSIGN_BASE_URL");
    if (!origin || !copy_env(credentials.access_key_id, sizeof(credentials.access_key_id), "CLOUDSIGN_ACCESS_KEY_ID", 1)
        || !copy_env(credentials.access_key_secret, sizeof(credentials.access_key_secret), "CLOUDSIGN_ACCESS_KEY_SECRET", 1)
        || !copy_env(credentials.security_token, sizeof(credentials.security_token), "CLOUDSIGN_SECURITY_TOKEN", 0)) goto done;
    status = cloudsign_global_init();
    if (status != CLOUDSIGN_OK) goto done;
    initialized = 1;
    cloudsign_options options = {.origin = origin, .credentials = &credentials, .timeout_ms = 15000};
    status = cloudsign_client_create(&options, &client);
    cloudsign_credentials_clear(&credentials);
    if (status != CLOUDSIGN_OK) goto done;
    const cloudsign_input_get_balance input = {0};
    status = cloudsign_build_get_balance(&input, &built);
    if (status != CLOUDSIGN_OK) goto done;
    status = cloudsign_send_built_request(client, built, &result);
    if (status == CLOUDSIGN_OK) {
        status = cloudsign_decode_get_balance(result, &decoded);
        if (status != CLOUDSIGN_OK) goto done;
        const cloudsign_model_account_balance *data = cloudsign_response_get_balance(decoded);
        if (!data) { status = CLOUDSIGN_INVALID_RESPONSE; goto done; }
        /* Read typed fields here; NULL/absent is distinct from zero/false. */
        (void)data;
        puts(cloudsign_decoded_request_id(decoded));
        exit_code = 0;
    }
done:
    if (exit_code) {
        if (status == CLOUDSIGN_API_ERROR) fprintf(stderr, "HTTP %ld %s; RequestId: %s\n", cloudsign_result_http_status(result), cloudsign_result_error_code(result), cloudsign_result_request_id(result));
        else fputs("Check SDK path, runtime, environment variables and business input.\n", stderr);
    }
    cloudsign_result_free(result);
    cloudsign_decoded_free(decoded);
    cloudsign_built_request_free(built);
    cloudsign_client_free(client);
    if (initialized) cloudsign_global_cleanup();
    cloudsign_credentials_clear(&credentials);
    return exit_code;
}
JSON 响应
{
    "request_id": "00000000000000000000000000000000",
    "data": {
        "available": "100.25",
        "currency": {
            "code": "POINT",
            "unit": "点",
            "external_settlement": "payment_provider"
        },
        "observed_at": 1794000000
    }
}

错误处理

失败或中断后

查询成功不预留资金。付款前后的并发资金变化由付款接口检查,读取失败时不假定余额为零或无限。

相关错误码

HTTP错误码处理方式
403BillingDisabled账号尚未开放财务读取。单独申请对应查询能力。
403AccessDenied检查当前身份的动作、资源范围、来源 IP 及功能准入。
503BillingUnavailable财务数据暂时不可用。记录 request_id 后稍后查询。
401InvalidCredentials凭据无效、已停用,或请求签名不匹配。核对 AK、环境、正文摘要和签名头。
429Throttled请求达到限额,按 Retry-After 返回的秒数等待,再以新 nonce 发起请求。
公共错误、重试与幂等说明 →