請求書のキャンセル
POST/v1/invoices/{id}/cancel
契約 v1 / 1.0.0 62 / 2026-10-10
このページの内容
未完了の請求書を削除せずにキャンセルします。照合のため引き続き参照できます。処理できない終了状態の場合は 409 を返します。
キー権限:invoices / write / payments。
パラメーター
| パラメーター | 入金 | 必須 | 説明 |
|---|---|---|---|
id | path | はい | 内部構造を持たないリソース 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 POST \
--header "Authorization: Bearer $CRYPTANIO_API_KEY" \
--header 'Accept: application/json' \
"https://api.cryptanio.com/v1/invoices/$(urlencode "$CRYPTANIO_RESOURCE_ID")/cancel" \
--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}/cancel"
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("POST", 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")?);
segments.push("cancel");
}
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());
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}/cancel';
$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 => 'POST',
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}/cancel"
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="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/invoices/{id}/cancel";
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: "POST", 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_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 組、JSON は最大 8192 バイト。シークレットを含めないでください。 |
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 の送金リクエストです。決済 QR には受取アドレスだけでなく、この 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 |
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"
}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"
}
}入れ子のオブジェクト
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 組、JSON は最大 8192 バイト。シークレットを含めないでください。 |
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 の送金リクエストです。決済 QR には受取アドレスだけでなく、この 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 組、JSON は最大 8192 バイト。シークレットを含めないでください。
object 最大 20 組、JSON は最大 8192 バイト。シークレットを含めないでください。
Decimal
string
RawAmount
string
Error
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |