Source: https://cryptanio.com/ja/docs/reference/create-invoice/
Contract / release / updated: v1 / 1.0.0 62 / 2026-10-10

[API リファレンス](https://cryptanio.com/ja/docs.html#reference)

# 請求書を作成

POST `/v1/invoices`

契約 v1 / 1.0.0 62 / 2026-10-10

[Markdown](https://cryptanio.com/ja/docs/reference/create-invoice/index.md) [OpenAPI](https://cryptanio.com/openapi.json)

Paymentsの請求書を作成します。支払情報を固定する場合はchainとamountを指定します。支払者が方法を選ぶ場合はchain、asset、amount、address、toleranceを省略し、invoice_currencyとinvoice_amountを指定します。後者には書き込み権限のある本番キーとIdempotency-Keyが必要です。作成時と同一内容の再試行時には操作可能な決済URLを返します。GETと一覧は読み取り専用リンクを返します。タイムアウト後は同じ本文と同じIdempotency-Keyで再試行してください。異なるパラメータには409を返します。キー付きの再試行は同じIDと201を返します。キーなしで固定方法の作成を再試行すると別の請求書が作成される場合があります。ブロックチェーン上の支払いは作成しません。

キー権限：`invoices` / write / `payments`。

## パラメーター

| パラメーター | 入金 | 必須 | 説明 |
| --- | --- | --- | --- |
| `Idempotency-Key` | header | いいえ | ASCII英字、数字、ハイフン、アンダースコアを16～80文字使用します。アカウント内で一意の論理注文IDです。支払者が支払方法を選ぶ場合は必須です。; `string` minLength: `16`; maxLength: `80`; pattern: `^[A-Za-z0-9_-]+$` |

## リクエスト本文

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `project` | `string` | いいえ | Payments プロジェクト ID。明示的な指定を推奨します。プロジェクトに制限されたキーは、そのプロジェクトを使用します。 |
| `chain` | `string` | いいえ | ネットワークコード。; minLength: `1` |
| `asset` | `string` | いいえ | 対応する支払い資産：native、シンボル、既知の識別子。利用できる資産はネットワークによって異なり、省略時は native を選択します。; 既定値：`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 組、JSON は最大 8192 バイト。シークレットを含めないでください。 |
| `invoice_currency` | `string` | いいえ | 注文の見積もりを表す 3 文字の通貨コード。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` |



### application/json

```json
{
  "project": "2002",
  "invoice_currency": "USD",
  "invoice_amount": "12.50",
  "reference": "order-42"
}
```



## リクエスト例

サンプルはお客様のアカウントで実際の操作を行います。コードで指定された環境変数を設定してください。キーは秘密に保管します。書き込みリクエストは自動再試行されません。



### Shell / cURL

```bash
#!/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
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.sh)



### Go

```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/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) }
}
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.go)



### Rust

```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");
    }
    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); }
}
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.rs)



### PHP

```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';

    $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);
}
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.php)



### Python

```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"

    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)
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.py)



### Node.js

```javascript
// 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;
}
```



[サンプルをダウンロード](https://cryptanio.com/files/examples/api/create-invoice.mjs)

## 応答とエラー

### 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 組、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` |



### 201 application/json

```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

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 401 有効で使用可能な API キーがありません（unauthorized）。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 401 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 403 キーが操作、プロジェクト、サービス、IP を許可していないか、メールアドレスが未確認です。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 403 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 409 状態の競合、再試行パラメーターの不一致、または支払いリソースの上限（conflict、limit_reached、service_inactive）。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 409 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 429 リクエストが多すぎます（rate_limited）。Retry-After の後に再試行してください。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 429 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 500 内部エラー（internal）。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 500 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



### 503 一時的に利用できません（unavailable）。バックオフを設けて再試行してください。

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `error` | `object` | はい |  |



### 503 application/json

```json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
```



[エラー処理と安全な再試行](https://cryptanio.com/ja/docs.html#errors)

## 入れ子のオブジェクト

### `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`

### `InvoiceRequest`

| フィールド | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `project` | `string` | いいえ | Payments プロジェクト ID。明示的な指定を推奨します。プロジェクトに制限されたキーは、そのプロジェクトを使用します。 |
| `chain` | `string` | いいえ | ネットワークコード。; minLength: `1` |
| `asset` | `string` | いいえ | 対応する支払い資産：native、シンボル、既知の識別子。利用できる資産はネットワークによって異なり、省略時は native を選択します。; 既定値：`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 組、JSON は最大 8192 バイト。シークレットを含めないでください。 |
| `invoice_currency` | `string` | いいえ | 注文の見積もりを表す 3 文字の通貨コード。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` | はい |  |