API リファレンス

Payments のイベント一覧を取得

GET/v1/payments

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

このページの内容

/events と同じ形式とカーソルですが、Payments サービスのイベントに限定されます。アカウント全体を対象とする別名ではありません。

キー権限:events / read / payments。

パラメーター

パラメーター入金必須説明
projectqueryいいえプロジェクト ID。監視対象の一覧取得または作成では、キーがプロジェクトに制限されていない限り必須です。その他の操作では、省略すると操作のアカウント/プロジェクトのコンテキストを使用します。明示的に指定してください。
string
watch_idqueryいいえプロジェクト監視 ID。
string
chainqueryいいえネットワークコードのフィルター。
string
typequeryいいえpayment.confirmed などのイベント種別。
string
addressqueryいいえアドレスです。
string
tx_idqueryいいえ取引 ID。
string
limitqueryいいえページサイズ:最大 200 件。無効な値では既定値を使用し、200 を超える値は上限に制限されます。
integer 既定値:25、minimum: 1、maximum: 200
beforequeryいいえnext_before または前ページの最後の項目の ID を使うカーソル。新しい順です。
string minLength: 1

リクエスト例

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

Shell / cURL
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_PROJECT_ID:?Set CRYPTANIO_PROJECT_ID}"
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
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' \
  --get \
  --data-urlencode "project=$CRYPTANIO_PROJECT_ID" \
  --data-urlencode 'limit=25' \
  "https://api.cryptanio.com/v1/payments" \
  --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"
    "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/payments"

    endpoint, err := url.Parse("https://api.cryptanio.com" + path)
    if err != nil { return err }
    query := endpoint.Query()
    query.Set("project", env("CRYPTANIO_PROJECT_ID"))
    query.Set("limit", "25")
    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("payments");
    }
    url.query_pairs_mut()
        .append_pair("project", &env("CRYPTANIO_PROJECT_ID")?)
        .append_pair("limit", &"25".to_owned());
    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/payments';

    $query = [
        'project' => env('CRYPTANIO_PROJECT_ID'),
        'limit' => '25',
    ];
    $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/payments"

    query = {
        "project": env("CRYPTANIO_PROJECT_ID"),
        "limit": "25",
    }
    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/payments";

  const url = new URL(path, "https://api.cryptanio.com");
  url.searchParams.set("project", env("CRYPTANIO_PROJECT_ID"));
  url.searchParams.set("limit", "25");
  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 成功応答。
フィールド型必須説明
dataobject[]はい
next_beforestringいいえ次ページのカーソル。続きのページがある場合のみ含まれます。
minLength: 1
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"
  }
}
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"
  }
}

エラー処理と安全な再試行

入れ子のオブジェクト

EventList

フィールド型必須説明
dataobject[]はい
next_beforestringいいえ次ページのカーソル。続きのページがある場合のみ含まれます。
minLength: 1
Event

フィールド型必須説明
event_idstringはい内部構造を持たない識別子。文字列のまま保持してください。
minLength: 1
event_typestringはいイベントの種別。新しい種別が追加される場合があります。
chainstringはいネットワークコード。
servicestringいいえ判明している場合のサービス。
watch_idstringいいえ監視対象に紐付いている場合のプロジェクト監視 ID。
minLength: 1
occurred_atstringはいRFC 3339 形式の UTC 日時。
date-time
paymentobject | nullはい支払いデータ。支払い以外のイベントでは null。GET /events は contract/notice ペイロードを返しません。
sandboxbooleanいいえテストイベント。省略時は false。
ID

内部構造を持たない識別子。形式は保証されないため、数値に変換しないでください。

string 不透明な識別子。形式は保証されていません。数値に変換しないでください。

EventPayment

REST/SSE の支払いデータ。フィールドはイベントとネットワークにより異なり、正規化された Webhook v1 の形式とは異なります。

フィールド型必須説明
tx_idstringいいえ取引の識別子。
indexintegerいいえ取引内の送金インデックス。
minimum: 0
heightintegerいいえ分かる場合のブロック高。
minimum: 0
addressstringいいえ監視対象のアドレス。
assetstringいいえREST/SSE の資産:文字列の識別子です。Webhook の asset オブジェクトではありません。
amount_rawstringいいえ最小単位の整数金額を表す文字列。
pattern: ^[0-9]+$
amountstringいいえ正確な小数の金額を表す文字列。浮動小数点は使用しないでください。
pattern: ^[0-9]+(?:\.[0-9]+)?$
decimalsintegerいいえ小数点以下の桁数。
minimum: 0
confirmationsintegerいいえ承認数。
minimum: 0
revisionintegerいいえ送金状態のリビジョン。
minimum: 0
directionstringいいえ監視対象のアドレスを基準とする方向。
in、out
simulatedbooleanいいえシミュレーションされたイベント。
latebooleanいいえ遅れて検出された送金。
block_hashstringいいえブロックハッシュ。
match_keystringいいえネットワークで使用される場合の照合識別子。
metaobjectいいえ
invoiceobjectいいえ
customerobjectいいえ
productobjectいいえ
payerobjectいいえ
metadataobjectいいえ
RawAmount

string

Decimal

string

StringMap

object

Customer

フィールド型必須説明
idstringはいお客様のシステム内の顧客識別子。
maxLength: 120
Product

フィールド型必須説明
idstringいいえ自分のシステム内の製品識別子。
maxLength: 120
namestringいいえ製品名。
maxLength: 200
quantityintegerいいえ数量。
minimum: 1、maximum: 1000000
Payer

フィールド型必須説明
commentstringはい支払者のコメント。
maxLength: 500
Error

フィールド型必須説明
errorobjectはい