Pay : factures

Lire une facture, avec ses paiements, balayages et remboursements

GET/v1/invoices/{id}

Authentification: Clé d’API (Authorization: Bearer)
Portée requise: pay:read

Paramètres de chemin#

idstring · uuidobligatoire

Réponses#

200Facture.

Champs de l’objet

idstring · uuid
objectstring
Valeurs invoice
statusstring
Valeurs waiting confirming paid underpaid overpaid expired paid_late canceled held
environmentstring
Valeurs test live
external_refstringpeut valoir null
variantstring
Valeurs A B
chain_idintegerpeut valoir null
Chaîne du paiement (fixée à la création quand une seule chaîne est offerte).
tokenstringpeut valoir null
decimalsintegerpeut valoir null
amount_dueany
amount_receivedany
amount_pendingany
differencestringpeut valoir null
Écart signé au montant dû, en unités natives.
priceobjectpeut valoir null
Champs de l’objet
- currencystring
- price_e6string
- fx_rate_e6string
  Unités de la devise pour 1 USDT, en millionièmes, figé à la création.
- fx_sourcestring
- fx_as_ofstring · date-time
chainstableau de object
Champs de chaque élément
- amountstring
  Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
- amount_formattedstring
- decimalsinteger
- chain_idinteger
- tokenstring
- deposit_addressstring
  Base58 T… sur TRON.
- payment_uristringpeut valoir null
  URI EIP-681 pour un QR code (chaînes EVM).
expires_atstring · date-time
paid_atstring · date-timepeut valoir null
created_atstring · date-time
metadataobject
descriptionstringpeut valoir null
paymentstableau de object
Champs de chaque élément
- amountstring
  Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
- amount_formattedstring
- decimalsinteger
- idstring · uuid
- objectstring
  Valeurs payment
- invoice_idstring · uuidpeut valoir null
  null : paiement non attribué.
- environmentstring
  Valeurs test live
- chain_idinteger
- tx_hashstring
- log_indexinteger
- block_numberinteger
- block_timestring · date-time
- fromstring
- tokenstringpeut valoir null
- statusstring
  Valeurs pending confirmed orphaned
- ignored_reasonstringpeut valoir null
  Valeurs dust unattributed other_chain other_token null
- sanction_hitboolean
- created_atstring · date-time
sweepstableau de object
Champs de chaque élément
- idstring · uuid
- objectstring
  Valeurs sweep
- chain_idinteger
- tx_hashstring
- log_indexinteger
- block_numberinteger
- tokenstringpeut valoir null
- grossobject
  Montant de jeton (unités natives en chaîne, valeur formatée et décimales).
  Champs de l’objet
  - amountstring
    Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
  - amount_formattedstring
  - decimalsinteger
- feeobject
  Montant de jeton (unités natives en chaîne, valeur formatée et décimales).
  Champs de l’objet
  - amountstring
    Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
  - amount_formattedstring
  - decimalsinteger
- netobject
  Montant de jeton (unités natives en chaîne, valeur formatée et décimales).
  Champs de l’objet
  - amountstring
    Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
  - amount_formattedstring
  - decimalsinteger
- payoutstring
- statusstring
  Valeurs pending confirmed orphaned
- shared_depositboolean
  Variante B : le balayage peut couvrir plusieurs factures.
- created_atstring · date-time
refundstableau de object
Champs de chaque élément
- amountstring
  Unités natives, par exemple 12500000 pour 12,5 USDT à 6 décimales.
- amount_formattedstring
- decimalsinteger
- idstring · uuid
- objectstring
  Valeurs refund
- environmentstring
  Valeurs test live
- invoice_idstring · uuidpeut valoir null
- chain_idinteger
- tokenstringpeut valoir null
- to_addressstring
- statusstring
  Valeurs prepared pending succeeded failed canceled
- tx_hashstringpeut valoir null
- warningstableau de string
  Valeurs origin_address exchange_address
- created_atstring · date-time
- updated_atstring · date-time

4xx · 5xxErreur.

Erreur au format standard : voir Erreurs.

Requête

cURL

curl "https://aicscan.io/v1/invoices/0193a1d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f" \
  -H "Authorization: Bearer $AICSCAN_API_KEY"

JavaScript

const res = await fetch('https://aicscan.io/v1/invoices/0193a1d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f', {
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os
import requests

resp = requests.get(
    "https://aicscan.io/v1/invoices/0193a1d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Réponse 200

JSON

{
  "id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
  "object": "invoice",
  "status": "waiting",
  "environment": "test",
  "external_ref": "string",
  "variant": "A",
  "chain_id": 56,
  "token": "string",
  "decimals": 0,
  "amount_due": null,
  "amount_received": null,
  "amount_pending": null,
  "difference": "string",
  "price": {
    "currency": "string",
    "price_e6": "string",
    "fx_rate_e6": "string",
    "fx_source": "string",
    "fx_as_of": "2026-11-14T09:30:13Z"
  },
  "chains": [
    {
      "amount": "string",
      "amount_formatted": "string",
      "decimals": 0,
      "chain_id": 56,
      "token": "string",
      "deposit_address": "string",
      "payment_uri": "string"
    }
  ],
  "expires_at": "2026-11-14T09:30:13Z",
  "paid_at": "2026-11-14T09:30:13Z",
  "created_at": "2026-11-14T09:30:13Z",
  "metadata": {},
  "description": "string",
  "payments": [
    {
      "amount": "string",
      "amount_formatted": "string",
      "decimals": 0,
      "id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
      "object": "payment",
      "invoice_id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
      "environment": "test",
      "chain_id": 56,
      "tx_hash": "string",
      "log_index": 0,
      "block_number": 0,
      "block_time": "2026-11-14T09:30:13Z",
      "from": "string",
      "token": "string",
      "status": "pending",
      "ignored_reason": "dust",
      "sanction_hit": false,
      "created_at": "2026-11-14T09:30:13Z"
    }
  ],
  "sweeps": [
    {
      "id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
      "object": "sweep",
      "chain_id": 56,
      "tx_hash": "string",
      "log_index": 0,
      "block_number": 0,
      "token": "string",
      "gross": {
        "amount": "string",
        "amount_formatted": "string",
        "decimals": 0
      },
      "fee": {
        "amount": "string",
        "amount_formatted": "string",
        "decimals": 0
      },
      "net": {
        "amount": "string",
        "amount_formatted": "string",
        "decimals": 0
      },
      "payout": "string",
      "status": "pending",
      "shared_deposit": false,
      "created_at": "2026-11-14T09:30:13Z"
    }
  ],
  "refunds": [
    {
      "amount": "string",
      "amount_formatted": "string",
      "decimals": 0,
      "id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
      "object": "refund",
      "environment": "test",
      "invoice_id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
      "chain_id": 56,
      "token": "string",
      "to_address": "string",
      "status": "prepared",
      "tx_hash": "string",
      "warnings": [
        "origin_address"
      ],
      "created_at": "2026-11-14T09:30:13Z",
      "updated_at": "2026-11-14T09:30:13Z"
    }
  ]
}