创建账单
POST/v1/invoices
合同 v1 / 1.0.0 62 / 2026-10-10
本页内容
创建Payments发票。若使用固定付款信息,请提供chain和amount;若由付款人选择方式,请省略chain、asset、amount、address和tolerance,并提供invoice_currency和invoice_amount。后一种方式需要具有写入权限的正式环境密钥和Idempotency-Key;创建及内容相同的重试会返回可交互的结账URL。GET和列表仍返回只读链接。超时后,请使用相同的请求正文和相同的Idempotency-Key重试;参数不同将返回409。带密钥的重试会返回201和相同的ID。没有密钥时,重试创建固定方式发票可能会生成另一张发票。此操作不会创建区块链付款。
密钥权限:invoices / write / payments。
参数
| 参数 | 转入 | 必填 | 说明 |
|---|---|---|---|
Idempotency-Key | header | 否 | 16–80个ASCII字母、数字、连字符或下划线。账户内唯一的逻辑订单ID。由付款人选择付款方式时必填。string minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$ |
请求正文
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
project | string | 否 | Payments 项目 ID;建议明确选择。项目范围密钥使用其所属项目。 |
chain | string | 否 | 网络代码。 minLength: 1 |
asset | string | 否 | 支持的付款资产:native、符号或已知标识符。可接受资产取决于网络;省略时选择 native。 Default: native |
amount | string | 否 | 以资产单位表示的正加密货币金额;精度不得超过资产的小数位数。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
reference | string | 否 | 您的订单参考编号;不能替代 Idempotency-Key。 maxLength: 120 |
address | string | 否 | 可选:项目付款地址池中的地址。否则由服务选择。 |
tolerance | string | 否 | 以资产为单位的允许不足额,必须严格小于 amount。容差为零时省略。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
customer | object | 否 | |
product | object | 否 | |
payer | object | 否 | |
metadata | object | 否 | 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。 |
invoice_currency | string | 否 | 三字母订单报价币种;仅能与 invoice_amount 一同使用。 pattern: ^[A-Za-z]{3}$ |
invoice_amount | string | 否 | 以invoice_currency计价的正数订单金额。与chain和amount同时提供时,表示商户保存的报价快照。未提供付款信息时,表示用于计算付款人所选资产金额的固定发票价值。 maxLength: 80; pattern: ^[0-9]+(?:\.[0-9]+)?$ |
expires_in | integer | 否 | 以分钟为单位的付款期限,从成功发放付款信息时开始计算。省略或设为0时使用项目政策(默认60);最大值为10080。旧的固定方式请求也会将负数视为省略;由付款人选择方式的结账请求则拒绝负数。 默认值: 60; maximum: 10080 |
{
"project": "2002",
"invoice_currency": "USD",
"invoice_amount": "12.50",
"reference": "order-42"
}请求示例
示例会在您的账户中执行真实操作。请设置代码指定的环境变量。保持密钥私密;写请求不会自动重试。
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
: "${CRYPTANIO_OPERATION_ID:?Set CRYPTANIO_OPERATION_ID}"
: "${CRYPTANIO_PROJECT_ID:?Set CRYPTANIO_PROJECT_ID}"
json_string() {
local text="$1" char code index output='"'
for ((index=0; index<${#text}; index++)); do
char="${text:index:1}"
case "$char" in
'"'|'\') output+="\\$char" ;;
*) printf -v code '%d' "'$char"
if ((code < 32)); then printf -v char '\\u%04x' "$code"; fi
output+="$char" ;;
esac
done
printf '%s"' "$output"
}
response_file="$(mktemp)"
trap 'rm -f "$response_file"' EXIT
transfer_status=0
http_status="$(curl \
--silent --show-error --max-time 30 --request POST \
--header "Authorization: Bearer $CRYPTANIO_API_KEY" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $CRYPTANIO_OPERATION_ID" \
--data-binary '{"project":'"$(json_string "$CRYPTANIO_PROJECT_ID")"',"invoice_currency":"USD","invoice_amount":"12.50","reference":"order-42"}' \
"https://api.cryptanio.com/v1/invoices" \
--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; standard library only. Run: go run request.go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"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"
endpoint, err := url.Parse("https://api.cryptanio.com" + path)
if err != nil { return err }
query := endpoint.Query()
endpoint.RawQuery = query.Encode()
var payload map[string]any
if err := json.Unmarshal([]byte("{\"project\":\"2002\",\"invoice_currency\":\"USD\",\"invoice_amount\":\"12.50\",\"reference\":\"order-42\"}"), &payload); err != nil { return err }
payload["project"] = env("CRYPTANIO_PROJECT_ID")
body, err := json.Marshal(payload)
if err != nil { return err }
request, err := http.NewRequest("POST", endpoint.String(), bytes.NewReader(body))
if err != nil { return err }
request.Header.Set("Authorization", "Bearer " + env("CRYPTANIO_API_KEY"))
request.Header.Set("Accept", "application/json")
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Idempotency-Key", env("CRYPTANIO_OPERATION_ID"))
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) }
}
// 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");
}
let client = Client::builder().timeout(Duration::from_secs(30)).redirect(Policy::none()).build()?;
let request = client.request(Method::POST, url)
.header("Authorization", format!("Bearer {}", env("CRYPTANIO_API_KEY")?))
.header("Accept", "application/json".to_owned())
.header("Content-Type", "application/json".to_owned())
.header("Idempotency-Key", env("CRYPTANIO_OPERATION_ID")?);
let mut body: serde_json::Value = serde_json::from_str("{\"project\":\"2002\",\"invoice_currency\":\"USD\",\"invoice_amount\":\"12.50\",\"reference\":\"order-42\"}")?;
body["project"] = serde_json::Value::String(env("CRYPTANIO_PROJECT_ID")?);
let request = request.json(&body);
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 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';
$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',
'Content-Type: ' . 'application/json',
'Idempotency-Key: ' . env('CRYPTANIO_OPERATION_ID'),
];
$body = json_decode('{"project":"2002","invoice_currency":"USD","invoice_amount":"12.50","reference":"order-42"}', true, 512, JSON_THROW_ON_ERROR);
$body['project'] = env('CRYPTANIO_PROJECT_ID');
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$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 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"
query = {
}
url = "https://api.cryptanio.com" + path + ("?" + urlencode(query) if query else "")
headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
"Content-Type": "application/json",
"Idempotency-Key": env("CRYPTANIO_OPERATION_ID"),
}
body = json.loads("{\"project\":\"2002\",\"invoice_currency\":\"USD\",\"invoice_amount\":\"12.50\",\"reference\":\"order-42\"}")
body["project"] = env("CRYPTANIO_PROJECT_ID")
data = json.dumps(body).encode("utf-8")
request = Request(url, data=data, headers=headers, method="POST")
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 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";
const url = new URL(path, "https://api.cryptanio.com");
const headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
"Content-Type": "application/json",
"Idempotency-Key": env("CRYPTANIO_OPERATION_ID"),
};
const body = {
"project": "2002",
"invoice_currency": "USD",
"invoice_amount": "12.50",
"reference": "order-42"
};
body["project"] = env("CRYPTANIO_PROJECT_ID");
const response = await fetch(url, {
method: "POST", headers, redirect: "manual",
signal: AbortSignal.timeout(30_000), body: JSON.stringify(body),
});
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;
}
响应与错误
201 成功响应。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
checkout_url | string | 否 | Cryptanio托管付款页面。创建由付款人选择方式的发票或重试时,会返回可交互的访问链接,允许在检测到付款前选择方式。创建固定方式发票以及所有GET和列表请求均返回单独的只读链接。两种链接都只能分享给指定付款人;它们均不授予账户或API密钥访问权限。请通过发票API或经过验证的Webhook确认付款,不要依据浏览器重定向判断。uri |
id | string | 是 | 不透明标识符;请保持为字符串。 minLength: 1 |
status | string | 是 | pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。pending、seen、paid、underpaid、partial、overpaid、expired、late、canceled |
project_id | string | 是 | 不透明标识符;请保持为字符串。 minLength: 1 |
reference | string | 否 | 订单参考编号。 |
customer | object | 否 | |
product | object | 否 | |
payer | object | 否 | |
metadata | object | 否 | 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。 |
invoice_currency | string | 否 | 订单报价币种。 |
invoice_amount | string | 否 | 精确十进制金额字符串;不要使用浮点数。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
chain | string | 是 | 网络代码。 |
asset | string | 是 | 付款资产。 |
address | string | 是 | 付款地址。 |
payment_route | object | 否 | 当自动来源生成 tag、memo、TON comment 或 Solana Pay reference 时,此链上支付标识为必填项。请将其与收款地址一同保存;商家的订单参考编号是另一个独立字段。 |
payment_uri | string | 否 | 包含收款人、准确金额、受支持代币的 mint 和必填 reference 的 Solana Pay 转账请求。支付二维码应编码此 URI,而不是仅使用收款地址。uri |
amount | string | string | 是 | 买家实际需要发送的金额;可能与原始请求金额不同,以便区分发票。选择方式前为空。 |
amount_raw | string | string | 是 | 以字符串表示的最小单位整数金额。选择方式前为空。 |
asked | string | string | 是 | 最初请求的加密资产金额。选择方式前为空。 |
decimals | integer | 是 | 资产的小数位数。 minimum: 0 |
tolerance | string | 否 | 以最小单位表示的容差;不同于 request.tolerance。 pattern: ^[0-9]+$ |
sandbox | boolean | 是 | 测试账单不能证明真实链上付款。 |
needs_decision | boolean | 否 | 不足额、超额或逾期付款需要作出决定。 |
paid | string | 否 | 以最小单位表示的已收金额。 pattern: ^[0-9]+$ |
tx_id | string | 否 | 付款交易标识符。 |
paid_at | string | 否 | RFC 3339 格式的 UTC 日期和时间。date-time |
expires_at | string | 是 | RFC 3339 格式的 UTC 日期和时间。date-time |
created_at | string | 是 | RFC 3339 格式的 UTC 日期和时间。date-time |
{
"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"
}400 无效请求(bad_request、unsupported_asset)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}401 没有有效且已启用的 API 密钥(unauthorized)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 密钥不允许该操作、项目、服务或 IP;电子邮件未确认。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}409 状态冲突、重试参数冲突或付款资源限制(conflict、limit_reached、service_inactive)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 请求过多(rate_limited);按 Retry-After 等待后重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 内部错误(internal)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 暂时不可用(unavailable);请退避重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}嵌套对象
Invoice
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
checkout_url | string | 否 | Cryptanio托管付款页面。创建由付款人选择方式的发票或重试时,会返回可交互的访问链接,允许在检测到付款前选择方式。创建固定方式发票以及所有GET和列表请求均返回单独的只读链接。两种链接都只能分享给指定付款人;它们均不授予账户或API密钥访问权限。请通过发票API或经过验证的Webhook确认付款,不要依据浏览器重定向判断。uri |
id | string | 是 | 不透明标识符;请保持为字符串。 minLength: 1 |
status | string | 是 | pending 等待付款;seen 已检测;partial 部分付款;paid 已结清;underpaid/overpaid/late 需要作出处理决定;expired 已过期限;canceled 已作废。pending、seen、paid、underpaid、partial、overpaid、expired、late、canceled |
project_id | string | 是 | 不透明标识符;请保持为字符串。 minLength: 1 |
reference | string | 否 | 订单参考编号。 |
customer | object | 否 | |
product | object | 否 | |
payer | object | 否 | |
metadata | object | 否 | 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。 |
invoice_currency | string | 否 | 订单报价币种。 |
invoice_amount | string | 否 | 精确十进制金额字符串;不要使用浮点数。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
chain | string | 是 | 网络代码。 |
asset | string | 是 | 付款资产。 |
address | string | 是 | 付款地址。 |
payment_route | object | 否 | 当自动来源生成 tag、memo、TON comment 或 Solana Pay reference 时,此链上支付标识为必填项。请将其与收款地址一同保存;商家的订单参考编号是另一个独立字段。 |
payment_uri | string | 否 | 包含收款人、准确金额、受支持代币的 mint 和必填 reference 的 Solana Pay 转账请求。支付二维码应编码此 URI,而不是仅使用收款地址。uri |
amount | string | string | 是 | 买家实际需要发送的金额;可能与原始请求金额不同,以便区分发票。选择方式前为空。 |
amount_raw | string | string | 是 | 以字符串表示的最小单位整数金额。选择方式前为空。 |
asked | string | string | 是 | 最初请求的加密资产金额。选择方式前为空。 |
decimals | integer | 是 | 资产的小数位数。 minimum: 0 |
tolerance | string | 否 | 以最小单位表示的容差;不同于 request.tolerance。 pattern: ^[0-9]+$ |
sandbox | boolean | 是 | 测试账单不能证明真实链上付款。 |
needs_decision | boolean | 否 | 不足额、超额或逾期付款需要作出决定。 |
paid | string | 否 | 以最小单位表示的已收金额。 pattern: ^[0-9]+$ |
tx_id | string | 否 | 付款交易标识符。 |
paid_at | string | 否 | RFC 3339 格式的 UTC 日期和时间。date-time |
expires_at | string | 是 | RFC 3339 格式的 UTC 日期和时间。date-time |
created_at | string | 是 | 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
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 您系统中的客户标识符。 maxLength: 120 |
Product
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 否 | 您系统中的产品标识符。 maxLength: 120 |
name | string | 否 | 产品名称。 maxLength: 200 |
quantity | integer | 否 | 数量。 minimum: 1; maximum: 1000000 |
Payer
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
comment | string | 是 | 付款人留言。 maxLength: 500 |
InvoiceMetadata
最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。
object 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。
Decimal
string
RawAmount
string
InvoiceRequest
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
project | string | 否 | Payments 项目 ID;建议明确选择。项目范围密钥使用其所属项目。 |
chain | string | 否 | 网络代码。 minLength: 1 |
asset | string | 否 | 支持的付款资产:native、符号或已知标识符。可接受资产取决于网络;省略时选择 native。 Default: native |
amount | string | 否 | 以资产单位表示的正加密货币金额;精度不得超过资产的小数位数。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
reference | string | 否 | 您的订单参考编号;不能替代 Idempotency-Key。 maxLength: 120 |
address | string | 否 | 可选:项目付款地址池中的地址。否则由服务选择。 |
tolerance | string | 否 | 以资产为单位的允许不足额,必须严格小于 amount。容差为零时省略。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
customer | object | 否 | |
product | object | 否 | |
payer | object | 否 | |
metadata | object | 否 | 最多 20 对,总计不超过 8192 个 JSON 字节。不要包含密钥。 |
invoice_currency | string | 否 | 三字母订单报价币种;仅能与 invoice_amount 一同使用。 pattern: ^[A-Za-z]{3}$ |
invoice_amount | string | 否 | 以invoice_currency计价的正数订单金额。与chain和amount同时提供时,表示商户保存的报价快照。未提供付款信息时,表示用于计算付款人所选资产金额的固定发票价值。 maxLength: 80; pattern: ^[0-9]+(?:\.[0-9]+)?$ |
expires_in | integer | 否 | 以分钟为单位的付款期限,从成功发放付款信息时开始计算。省略或设为0时使用项目政策(默认60);最大值为10080。旧的固定方式请求也会将负数视为省略;由付款人选择方式的结账请求则拒绝负数。 默认值: 60; maximum: 10080 |
Error
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |