API 参考

获取账单

GET/v1/invoices/{id}

合同 v1 / 1.0.0 62 / 2026-10-10

本页内容

读取 API 密钥获准项目中的账单。

密钥权限:invoices / read / payments。

参数

参数转入必填说明
idpath是不透明资源 ID。
string minLength: 1

请求示例

示例会在您的账户中执行真实操作。请设置代码指定的环境变量。保持密钥私密;写请求不会自动重试。

Shell / cURL
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_RESOURCE_ID:?Set CRYPTANIO_RESOURCE_ID}"
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
urlencode() {
  local LC_ALL=C text="$1" char index
  for ((index=0; index<${#text}; index++)); do
    char="${text:index:1}"
    case "$char" in [a-zA-Z0-9.~_-]) printf '%s' "$char" ;; *) printf '%%%02X' "'$char" ;; esac
  done
}
response_file="$(mktemp)"
trap 'rm -f "$response_file"' EXIT
transfer_status=0
http_status="$(curl \
  --silent --show-error --max-time 30 --request GET \
  --header "Authorization: Bearer $CRYPTANIO_API_KEY" \
  --header 'Accept: application/json' \
  "https://api.cryptanio.com/v1/invoices/$(urlencode "$CRYPTANIO_RESOURCE_ID")" \
  --output "$response_file" --write-out '%{http_code}')" || transfer_status=$?
if [[ "$http_status" == 2?? ]]; then
  cat "$response_file"
  exit "$transfer_status"
fi
printf 'HTTP %s\n' "$http_status" >&2
cat "$response_file" >&2
exit 1
下载示例
Go
// Go; standard library only. Run: go run request.go
package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
    "strings"
    "time"
)

func env(name string) string {
    value := os.Getenv(name)
    if value == "" { fmt.Fprintln(os.Stderr, "Set", name); os.Exit(1) }
    return value
}
func run() error {
    path := "/v1/invoices/{id}"
    path = strings.ReplaceAll(path, "{id}", url.PathEscape(env("CRYPTANIO_RESOURCE_ID")))
    endpoint, err := url.Parse("https://api.cryptanio.com" + path)
    if err != nil { return err }
    query := endpoint.Query()

    endpoint.RawQuery = query.Encode()

    request, err := http.NewRequest("GET", endpoint.String(), nil)
    if err != nil { return err }
    request.Header.Set("Authorization", "Bearer " + env("CRYPTANIO_API_KEY"))
    request.Header.Set("Accept", "application/json")
    client := &http.Client{Timeout: 30 * time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
    response, err := client.Do(request)
    if err != nil { return err }
    defer response.Body.Close()
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        body, err := io.ReadAll(response.Body)
        if err != nil { return err }
        return fmt.Errorf("HTTP %d: %s", response.StatusCode, body)
    }
    _, err = io.Copy(os.Stdout, response.Body)
    return err
}
func main() {
    if err := run(); err != nil { fmt.Fprintln(os.Stderr, err); os.Exit(1) }
}
下载示例
Rust
// Cargo.toml dependencies:
// reqwest = { version = "=0.12.24", features = ["blocking", "json"] }
// serde_json = "=1.0.145"
use std::{error::Error, io, time::Duration};
use reqwest::{blocking::Client, redirect::Policy, Method, Url};

fn env(name: &str) -> Result<String, Box<dyn Error>> {
    let value = std::env::var(name)?;
    if value.is_empty() { return Err(format!("Set {name}").into()); }
    Ok(value)
}
fn run() -> Result<(), Box<dyn Error>> {
    let mut url = Url::parse("https://api.cryptanio.com")?;
    {
        let mut segments = url.path_segments_mut().map_err(|_| "Invalid base URL")?;
        segments.clear();
        segments.push("v1");
        segments.push("invoices");
        segments.push(&env("CRYPTANIO_RESOURCE_ID")?);
    }
    let client = Client::builder().timeout(Duration::from_secs(30)).redirect(Policy::none()).build()?;
    let request = client.request(Method::GET, url)
        .header("Authorization", format!("Bearer {}", env("CRYPTANIO_API_KEY")?))
        .header("Accept", "application/json".to_owned());
    let mut response = request.send()?;
    let status = response.status();
    if !status.is_success() { return Err(format!("HTTP {}: {}", status.as_u16(), response.text()?).into()); }
    io::copy(&mut response, &mut io::stdout())?;
    Ok(())
}
fn main() {
    if let Err(error) = run() { eprintln!("{error}"); std::process::exit(1); }
}
下载示例
PHP
<?php
// PHP 8 with the cURL extension. Run this on your server.
function env(string $name): string {
    $value = getenv($name);
    if ($value === false || $value === '') throw new RuntimeException('Set ' . $name);
    return $value;
}
try {
    $path = '/v1/invoices/{id}';
    $path = str_replace('{id}', rawurlencode(env('CRYPTANIO_RESOURCE_ID')), $path);
    $query = [

    ];
    $url = 'https://api.cryptanio.com' . $path . ($query ? '?' . http_build_query($query, '', '&', PHP_QUERY_RFC3986) : '');
    $headers = [
        'Authorization: ' . 'Bearer ' . env('CRYPTANIO_API_KEY'),
        'Accept: ' . 'application/json',
    ];
    $curl = curl_init($url);
    curl_setopt_array($curl, [
        CURLOPT_CUSTOMREQUEST => 'GET',
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_CONNECTTIMEOUT => 10,
        CURLOPT_TIMEOUT => 30,
    ]);
    $response = curl_exec($curl);
    if ($response === false) throw new RuntimeException(curl_error($curl));
    $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    if ($status < 200 || $status >= 300) throw new RuntimeException('HTTP ' . $status . ': ' . $response);
    echo $response;
} catch (Throwable $error) {
    fwrite(STDERR, $error->getMessage() . PHP_EOL);
    exit(1);
}
下载示例
Python
# Python 3; standard library only.
import json
import os
import sys
from urllib.error import HTTPError, URLError
from urllib.parse import quote, urlencode
from urllib.request import HTTPRedirectHandler, Request, build_opener

def env(name):
    result = os.environ.get(name)
    if not result:
        raise ValueError("Set " + name)
    return result

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

try:
    path = "/v1/invoices/{id}"
    path = path.replace("{id}", quote(env("CRYPTANIO_RESOURCE_ID"), safe=""))
    query = {

    }
    url = "https://api.cryptanio.com" + path + ("?" + urlencode(query) if query else "")
    headers = {
        "Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
        "Accept": "application/json",
    }
    data = None
    request = Request(url, data=data, headers=headers, method="GET")
    with build_opener(NoRedirect()).open(request, timeout=30) as response:
        if not 200 <= response.status < 300:
            raise ValueError("HTTP " + str(response.status))
        sys.stdout.buffer.write(response.read())
except HTTPError as error:
    print("HTTP " + str(error.code) + ": " + error.read().decode("utf-8", errors="replace"), file=sys.stderr)
    sys.exit(1)
except (ValueError, URLError, OSError) as error:
    print(str(error), file=sys.stderr)
    sys.exit(1)
下载示例
Node.js
// Node.js 18+. Run on your server, never in a browser.
const env = name => {
  const result = process.env[name];
  if (!result) throw new Error(`Set ${name}`);
  return result;
};
try {
  let path = "/v1/invoices/{id}";
  path = path.replace("{id}", encodeURIComponent(env("CRYPTANIO_RESOURCE_ID")));
  const url = new URL(path, "https://api.cryptanio.com");

  const headers = {
    "Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
    "Accept": "application/json",
  };
  const response = await fetch(url, {
    method: "GET", headers, redirect: "manual",
    signal: AbortSignal.timeout(30_000),
  });
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  if (response.body) {
    for await (const chunk of response.body) process.stdout.write(chunk);
  }
} catch (error) {
  console.error(error.message);
  process.exitCode = 1;
}
下载示例

响应与错误

200 成功响应。
字段类型必填说明
checkout_urlstring否Cryptanio托管付款页面。创建由付款人选择方式的发票或重试时,会返回可交互的访问链接,允许在检测到付款前选择方式。创建固定方式发票以及所有GET和列表请求均返回单独的只读链接。两种链接都只能分享给指定付款人;它们均不授予账户或API密钥访问权限。请通过发票API或经过验证的Webhook确认付款,不要依据浏览器重定向判断。
uri
idstring是不透明标识符;请保持为字符串。
minLength: 1
statusstring是pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。
pending、seen、paid、underpaid、partial、overpaid、expired、late、canceled
project_idstring是不透明标识符;请保持为字符串。
minLength: 1
referencestring否订单参考编号。
customerobject否
productobject否
payerobject否
metadataobject否最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。
invoice_currencystring否订单报价币种。
invoice_amountstring否精确十进制金额字符串;不要使用浮点数。
pattern: ^[0-9]+(?:\.[0-9]+)?$
chainstring是网络代码。
assetstring是付款资产。
addressstring是付款地址。
payment_routeobject否当自动来源生成 tag、memo、TON comment 或 Solana Pay reference 时,此链上支付标识为必填项。请将其与收款地址一同保存;商家的订单参考编号是另一个独立字段。
payment_uristring否包含收款人、准确金额、受支持代币的 mint 和必填 reference 的 Solana Pay 转账请求。支付二维码应编码此 URI,而不是仅使用收款地址。
uri
amountstring | string是买家实际需要发送的金额;可能与原始请求金额不同,以便区分发票。选择方式前为空。
amount_rawstring | string是以字符串表示的最小单位整数金额。选择方式前为空。
askedstring | string是最初请求的加密资产金额。选择方式前为空。
decimalsinteger是资产的小数位数。
minimum: 0
tolerancestring否以最小单位表示的容差;不同于 request.tolerance。
pattern: ^[0-9]+$
sandboxboolean是测试账单不能证明真实链上付款。
needs_decisionboolean否不足额、超额或逾期付款需要作出决定。
paidstring否以最小单位表示的已收金额。
pattern: ^[0-9]+$
tx_idstring否付款交易标识符。
paid_atstring否RFC 3339 格式的 UTC 日期和时间。
date-time
expires_atstring是RFC 3339 格式的 UTC 日期和时间。
date-time
created_atstring是RFC 3339 格式的 UTC 日期和时间。
date-time
200 application/json
{
  "id": "2100",
  "status": "pending",
  "project_id": "2002",
  "reference": "order-42",
  "chain": "ethereum",
  "asset": "USDC",
  "address": "0x52908400098527886E0F7030069857D2E4169EE7",
  "amount": "12.5",
  "amount_raw": "12500000",
  "asked": "12.5",
  "decimals": 6,
  "sandbox": true,
  "expires_at": "2026-10-06T11:00:00Z",
  "created_at": "2026-10-06T10:00:00Z"
}
401 没有有效且已启用的 API 密钥(unauthorized)。
字段类型必填说明
errorobject是
401 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
403 密钥不允许该操作、项目、服务或 IP;电子邮件未确认。
字段类型必填说明
errorobject是
403 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
404 密钥权限范围内未找到对象(not_found)。
字段类型必填说明
errorobject是
404 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
429 请求过多(rate_limited);按 Retry-After 等待后重试。
字段类型必填说明
errorobject是
429 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
500 内部错误(internal)。
字段类型必填说明
errorobject是
500 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
503 暂时不可用(unavailable);请退避重试。
字段类型必填说明
errorobject是
503 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}

处理错误与安全重试

嵌套对象

Invoice

字段类型必填说明
checkout_urlstring否Cryptanio托管付款页面。创建由付款人选择方式的发票或重试时,会返回可交互的访问链接,允许在检测到付款前选择方式。创建固定方式发票以及所有GET和列表请求均返回单独的只读链接。两种链接都只能分享给指定付款人;它们均不授予账户或API密钥访问权限。请通过发票API或经过验证的Webhook确认付款,不要依据浏览器重定向判断。
uri
idstring是不透明标识符;请保持为字符串。
minLength: 1
statusstring是pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。
pending、seen、paid、underpaid、partial、overpaid、expired、late、canceled
project_idstring是不透明标识符;请保持为字符串。
minLength: 1
referencestring否订单参考编号。
customerobject否
productobject否
payerobject否
metadataobject否最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。
invoice_currencystring否订单报价币种。
invoice_amountstring否精确十进制金额字符串;不要使用浮点数。
pattern: ^[0-9]+(?:\.[0-9]+)?$
chainstring是网络代码。
assetstring是付款资产。
addressstring是付款地址。
payment_routeobject否当自动来源生成 tag、memo、TON comment 或 Solana Pay reference 时,此链上支付标识为必填项。请将其与收款地址一同保存;商家的订单参考编号是另一个独立字段。
payment_uristring否包含收款人、准确金额、受支持代币的 mint 和必填 reference 的 Solana Pay 转账请求。支付二维码应编码此 URI,而不是仅使用收款地址。
uri
amountstring | string是买家实际需要发送的金额;可能与原始请求金额不同,以便区分发票。选择方式前为空。
amount_rawstring | string是以字符串表示的最小单位整数金额。选择方式前为空。
askedstring | string是最初请求的加密资产金额。选择方式前为空。
decimalsinteger是资产的小数位数。
minimum: 0
tolerancestring否以最小单位表示的容差;不同于 request.tolerance。
pattern: ^[0-9]+$
sandboxboolean是测试账单不能证明真实链上付款。
needs_decisionboolean否不足额、超额或逾期付款需要作出决定。
paidstring否以最小单位表示的已收金额。
pattern: ^[0-9]+$
tx_idstring否付款交易标识符。
paid_atstring否RFC 3339 格式的 UTC 日期和时间。
date-time
expires_atstring是RFC 3339 格式的 UTC 日期和时间。
date-time
created_atstring是RFC 3339 格式的 UTC 日期和时间。
date-time
ID

不透明标识符。格式不保证固定;不要转换为数字。

string 不透明标识符。格式不保证固定;不要转换为数字。

InvoiceStatus

pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。

string pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。

Customer

字段类型必填说明
idstring是您系统中的客户标识符。
maxLength: 120
Product

字段类型必填说明
idstring否您系统中的产品标识符。
maxLength: 120
namestring否产品名称。
maxLength: 200
quantityinteger否数量。
minimum: 1; maximum: 1000000
Payer

字段类型必填说明
commentstring是付款人留言。
maxLength: 500
InvoiceMetadata

最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。

object 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。

Decimal

string

RawAmount

string

Error

字段类型必填说明
errorobject是