模拟 Sandbox 支付
POST/v1/simulate
合同 v1 / 1.1.3 5 / 2026-11-17
本页内容
使用测试写入密钥及 simulation 权限执行支付场景。必须提供 Idempotency-Key;相同重试返回已保存结果,不再产生状态变更或发送。相同密钥配不同参数返回 409。数据、接收者、配额和余额与 Live 分离。不创建区块链交易。支持 expire 和 late;不包含 Pay 和订阅。
密钥权限:simulation / write。
参数
| 参数 | 转入 | 必填 | 说明 |
|---|---|---|---|
Idempotency-Key | header | 是 | 16–80 个 ASCII 字母、数字、连字符或下划线。重试时保留相同密钥和准确请求。每个不同的状态变更使用新密钥。string minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$ |
请求正文
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
operation_id | string | 否 | 请求体中可选的 Idempotency-Key 副本;必须与请求头完全一致。建议仅使用请求头。 minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$ |
invoice_id | string | 否 | 密钥账户及其授权项目中的 Sandbox 账单。必须且只能提供 invoice_id 或 watch_id。 minLength: 1 |
watch_id | string | 否 | 密钥账户及其授权项目/服务中的有效 Sandbox 地址。只能提供一个目标。 minLength: 1 |
transaction_id | string | 否 | 新测试支付请省略此字段。后续状态变更复用返回的 simulated_ 标识符。未知标识符返回 404;资产和金额不可更改。 pattern: ^simulated_[0-9]+$ |
event_type | string | 否 | 测试交易的状态变更。确认或回滚同一 transaction_id 来测试完整生命周期。payment.pending, payment.confirmed, payment.rolled_back; 默认: payment.confirmed |
amount_raw | string | 否 | 以资产最小单位表示的正整数金额。默认使用账单金额、已有交易金额,或新地址支付的一个完整目录资产单位。单独的追加付款应创建新交易。 minLength: 1; maxLength: 78; pattern: ^[0-9]+$ |
asset | string | 否 | 账单资产已固定。地址有多条资产规则时,必须明确选择允许的目录资产。不能推断未知代币的精度。 |
decimals | integer | 否 | 可选的一致性断言,必须等于账单或目录中固定的资产精度,不能覆盖精度。 minimum: 0; maximum: 255 |
occurred_at | string | 否 | 可选事件时间,范围为当前时间前 30 天至后 7 天 1 分钟。不更改其他对象或系统时间。late 会设置自己的时间。date-time |
action | string | 否 | 仅适用于账单。expire 对此账单执行过期处理,不创建事件或 Webhook。late 先使账单过期,再模拟过期一秒后的已确认支付。返回的 invoice_status 遵循正常接收规则;late 不保证特定状态。expire, late |
application/json
{
"invoice_id": "2001",
"event_type": "payment.pending",
"amount_raw": "1000000"
}请求示例
示例会在您的账户中执行真实操作。请设置代码指定的环境变量。保持密钥私密;写请求不会自动重试。
Shell / cURL
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
: "${CRYPTANIO_OPERATION_ID:?Set CRYPTANIO_OPERATION_ID}"
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 '{"invoice_id":"2001","event_type":"payment.pending","amount_raw":"1000000"}' \
"https://api.cryptanio.com/v1/simulate" \
--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 (
"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/simulate"
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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}"), &payload); err != nil { return err }
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) }
}
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("simulate");
}
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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}")?;
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
// 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/simulate';
$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('{"invoice_id":"2001","event_type":"payment.pending","amount_raw":"1000000"}', true, 512, JSON_THROW_ON_ERROR);
$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
# 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/simulate"
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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}")
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
// 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/simulate";
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 = {
"invoice_id": "2001",
"event_type": "payment.pending",
"amount_raw": "1000000"
};
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;
}
响应与错误
202 场景已接受,或返回相同重试的已保存结果。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
event_id | string | 否 | 已记录的事件 ID。expire 不创建事件,因此省略。 |
event_type | string | 否 | 已记录的支付状态变更;expire 时省略。 |
watch_id | string | 是 | 此场景使用的 Sandbox 地址。 |
transaction_id | string | 否 | 用于后续状态变更的稳定测试支付标识符;expire 时省略。 |
invoice_id | string | 否 | 场景以账单为目标时受影响的 Sandbox 账单。 |
invoice_status | string | 否 | 操作后的真实账单状态;不要预先假定逾期或过期的固定结果。 |
action | string | 否 | 请求时指定的账单场景。expire, late |
queued | boolean | 是 | 事件通知处理已加入队列。这不代表外部发送已被接受。 |
replayed | boolean | 是 | 同一幂等操作在未产生新状态变更或事件的情况下返回结果时为真。 |
202 application/json
{
"event_id": "2301",
"event_type": "payment.pending",
"watch_id": "2000",
"transaction_id": "simulated_2300",
"invoice_id": "2001",
"invoice_status": "pending",
"queued": true,
"replayed": false
}400 无效请求(bad_request、unsupported_asset)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
400 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}401 没有有效且已启用的 API 密钥(unauthorized)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
401 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 密钥不允许该操作、项目、服务或 IP;电子邮件未确认。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
403 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}404 密钥权限范围内未找到对象(not_found)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
404 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}409 状态冲突、重试参数冲突或付款资源限制(conflict、limit_reached、service_inactive)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
409 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 请求过多(rate_limited);按 Retry-After 等待后重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
429 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 内部错误(internal)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
500 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 暂时不可用(unavailable);请退避重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
503 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}嵌套对象
SimulateRequest
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
operation_id | string | 否 | 请求体中可选的 Idempotency-Key 副本;必须与请求头完全一致。建议仅使用请求头。 minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$ |
invoice_id | string | 否 | 密钥账户及其授权项目中的 Sandbox 账单。必须且只能提供 invoice_id 或 watch_id。 minLength: 1 |
watch_id | string | 否 | 密钥账户及其授权项目/服务中的有效 Sandbox 地址。只能提供一个目标。 minLength: 1 |
transaction_id | string | 否 | 新测试支付请省略此字段。后续状态变更复用返回的 simulated_ 标识符。未知标识符返回 404;资产和金额不可更改。 pattern: ^simulated_[0-9]+$ |
event_type | string | 否 | 测试交易的状态变更。确认或回滚同一 transaction_id 来测试完整生命周期。payment.pending, payment.confirmed, payment.rolled_back; 默认: payment.confirmed |
amount_raw | string | 否 | 以资产最小单位表示的正整数金额。默认使用账单金额、已有交易金额,或新地址支付的一个完整目录资产单位。单独的追加付款应创建新交易。 minLength: 1; maxLength: 78; pattern: ^[0-9]+$ |
asset | string | 否 | 账单资产已固定。地址有多条资产规则时,必须明确选择允许的目录资产。不能推断未知代币的精度。 |
decimals | integer | 否 | 可选的一致性断言,必须等于账单或目录中固定的资产精度,不能覆盖精度。 minimum: 0; maximum: 255 |
occurred_at | string | 否 | 可选事件时间,范围为当前时间前 30 天至后 7 天 1 分钟。不更改其他对象或系统时间。late 会设置自己的时间。date-time |
action | string | 否 | 仅适用于账单。expire 对此账单执行过期处理,不创建事件或 Webhook。late 先使账单过期,再模拟过期一秒后的已确认支付。返回的 invoice_status 遵循正常接收规则;late 不保证特定状态。expire, late |
Simulation
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
event_id | string | 否 | 已记录的事件 ID。expire 不创建事件,因此省略。 |
event_type | string | 否 | 已记录的支付状态变更;expire 时省略。 |
watch_id | string | 是 | 此场景使用的 Sandbox 地址。 |
transaction_id | string | 否 | 用于后续状态变更的稳定测试支付标识符;expire 时省略。 |
invoice_id | string | 否 | 场景以账单为目标时受影响的 Sandbox 账单。 |
invoice_status | string | 否 | 操作后的真实账单状态;不要预先假定逾期或过期的固定结果。 |
action | string | 否 | 请求时指定的账单场景。expire, late |
queued | boolean | 是 | 事件通知处理已加入队列。这不代表外部发送已被接受。 |
replayed | boolean | 是 | 同一幂等操作在未产生新状态变更或事件的情况下返回结果时为真。 |
Error
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |