Lister les factures
GET/v1/invoices
Contrat v1 / 1.0.0 62 / 2026-10-10
Sur cette page
Factures uniquement, pas les dons. ID les plus récents en premier. La réponse contient data sans next_before ; transmettez l’ID du dernier élément comme before pour continuer. Arrêtez-vous sur une page vide.
Permissions de la clé : invoices / read / payments.
Paramètres
| Paramètre | Entrant | Obligatoire | Description |
|---|---|---|---|
project | query | Non | ID du projet. Requis pour lister ou créer des surveillances sauf si la clé est limitée à un projet. Pour les autres opérations, l’omission utilise le contexte de compte/projet de l’opération ; indiquez-le explicitement.string |
chain | query | Non | Filtre du code réseau.string |
status | query | Non | État de la facture.string pending, seen, paid, underpaid, partial, overpaid, expired, late, canceled |
limit | query | Non | Taille de page : au maximum 200. Les valeurs invalides utilisent la valeur par défaut ; celles supérieures à 200 sont plafonnées.integer Par défaut : 50 ; minimum: 1 ; maximum: 200 |
before | query | Non | Curseur issu de next_before ou de l’ID du dernier élément de la page précédente ; les plus récents en premier.string minLength: 1 |
Exemples de requêtes
Les exemples réalisent une opération réelle dans votre compte. Définissez les variables d’environnement nommées dans le code. Gardez votre clé privée ; les requêtes d’écriture ne sont pas réessayées automatiquement.
#!/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=50' \
"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 (
"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()
query.Set("project", env("CRYPTANIO_PROJECT_ID"))
query.Set("limit", "50")
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) }
}
// 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");
}
url.query_pairs_mut()
.append_pair("project", &env("CRYPTANIO_PROJECT_ID")?)
.append_pair("limit", &"50".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 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 = [
'project' => env('CRYPTANIO_PROJECT_ID'),
'limit' => '50',
];
$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 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 = {
"project": env("CRYPTANIO_PROJECT_ID"),
"limit": "50",
}
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 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");
url.searchParams.set("project", env("CRYPTANIO_PROJECT_ID"));
url.searchParams.set("limit", "50");
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;
}
Réponses et erreurs
200 Réponse réussie.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
data | object[] | Oui |
401 Aucune clé API active valide (unauthorized).
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 La clé n’autorise pas l’opération, le projet, le service ou l’IP ; e-mail non confirmé.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 Trop de requêtes (rate_limited) ; réessayez après Retry-After.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 Erreur interne (internal).
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 Indisponibilité temporaire (unavailable) ; réessayez avec un délai progressif.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}Objets imbriqués
InvoiceList
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
data | object[] | Oui |
Invoice
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
checkout_url | string | Non | Page de paiement hébergée par Cryptanio. La création ou la nouvelle tentative d’une facture avec choix du moyen renvoie un lien d’accès interactif permettant ce choix jusqu’à la détection d’un paiement. La création à moyen fixe et tous les GET et listes renvoient un lien distinct en lecture seule. Ne partagez ces liens qu’avec le payeur prévu ; aucun ne donne accès au compte ni à la clé API. Confirmez le paiement via l’API des factures ou un webhook vérifié, jamais par une redirection du navigateur.uri |
id | string | Oui | Identifiant opaque ; conservez-le sous forme de chaîne. minLength: 1 |
status | string | Oui | pending attend le paiement ; seen détecté ; partial partiellement payé ; paid réglé ; underpaid/overpaid/late nécessitent une décision ; expired délai dépassé ; canceled annulé.pending, seen, paid, underpaid, partial, overpaid, expired, late, canceled |
project_id | string | Oui | Identifiant opaque ; conservez-le sous forme de chaîne. minLength: 1 |
reference | string | Non | Référence de la commande. |
customer | object | Non | |
product | object | Non | |
payer | object | Non | |
metadata | object | Non | Jusqu’à 20 paires, au maximum 8192 octets JSON. N’incluez pas de secrets. |
invoice_currency | string | Non | Devise du prix indiqué pour la commande. |
invoice_amount | string | Non | Montant décimal exact sous forme de chaîne ; n’utilisez pas de virgule flottante. pattern: ^[0-9]+(?:\.[0-9]+)?$ |
chain | string | Oui | Code réseau. |
asset | string | Oui | Actif de paiement. |
address | string | Oui | Adresse de paiement. |
payment_route | object | Non | Identifiant de paiement sur la blockchain obligatoire lorsqu’une source automatique fournit un tag, un memo, un commentaire TON ou une référence Solana Pay. Conservez-le avec l’adresse de réception ; la référence de commande du commerçant est un champ distinct. |
payment_uri | string | Non | Demande de transfert Solana Pay avec le destinataire, le montant exact, le mint du jeton pris en charge et la référence obligatoire. Encodez cet URI dans le QR de paiement au lieu de la simple adresse de réception.uri |
amount | string | string | Oui | Montant réel que l’acheteur doit envoyer ; il peut différer du montant demandé pour distinguer les factures. Vide tant qu’aucun moyen n’est choisi. |
amount_raw | string | string | Oui | Montant entier dans la plus petite unité, sous forme de chaîne. Vide tant qu’aucun moyen n’est choisi. |
asked | string | string | Oui | Montant en cryptomonnaie demandé à l’origine. Vide tant qu’aucun moyen n’est choisi. |
decimals | integer | Oui | Nombre de décimales de l’actif. minimum: 0 |
tolerance | string | Non | Tolérance en plus petites unités ; contrairement à request.tolerance. pattern: ^[0-9]+$ |
sandbox | boolean | Oui | Une facture de test ne prouve pas un paiement réel sur la blockchain. |
needs_decision | boolean | Non | Une décision est nécessaire pour les états underpaid, overpaid ou late. |
paid | string | Non | Montant reçu en plus petites unités. pattern: ^[0-9]+$ |
tx_id | string | Non | Identifiant de la transaction de paiement. |
paid_at | string | Non | Date et heure UTC selon RFC 3339.date-time |
expires_at | string | Oui | Date et heure UTC selon RFC 3339.date-time |
created_at | string | Oui | Date et heure UTC selon RFC 3339.date-time |
ID
Identifiant opaque. Son format n’est pas garanti ; ne le convertissez pas en nombre.
string Identifiant opaque. Son format n’est pas garanti ; ne le convertissez pas en nombre.
InvoiceStatus
pending attend le paiement ; seen détecté ; partial partiellement payé ; paid réglé ; underpaid/overpaid/late nécessitent une décision ; expired délai dépassé ; canceled annulé.
string pending attend le paiement ; seen détecté ; partial partiellement payé ; paid réglé ; underpaid/overpaid/late nécessitent une décision ; expired délai dépassé ; canceled annulé.
Customer
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id | string | Oui | Identifiant du client dans votre système. maxLength: 120 |
Product
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id | string | Non | Identifiant du produit dans votre système. maxLength: 120 |
name | string | Non | Nom du produit. maxLength: 200 |
quantity | integer | Non | Quantité. minimum: 1 ; maximum: 1000000 |
Payer
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
comment | string | Oui | Commentaire du payeur. maxLength: 500 |
InvoiceMetadata
Jusqu’à 20 paires, au maximum 8192 octets JSON. N’incluez pas de secrets.
object Jusqu’à 20 paires, au maximum 8192 octets JSON. N’incluez pas de secrets.
Decimal
string
RawAmount
string
Error
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
error | object | Oui |