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

[Referência da API](https://cryptanio.com/pt/docs.html#reference)

# Crie uma fatura

POST `/v1/invoices`

Contrato v1 / 1.0.0 62 / 2026-10-10

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

Criar uma fatura do Payments. Envie chain e amount para obter dados de pagamento fixos, ou omita chain, asset, amount, address e tolerance e envie invoice_currency e invoice_amount para o pagador escolher o método. A segunda opção exige uma chave de produção com permissão de escrita e Idempotency-Key; a criação e uma repetição idêntica devolvem a URL de pagamento interativa. GET e listagens mantêm links somente de leitura. Após um tempo limite, repita o mesmo corpo com o mesmo Idempotency-Key; parâmetros diferentes devolvem 409. Uma repetição com chave devolve 201 com o mesmo ID. Sem chave, repetir a criação com método fixo pode criar outra fatura. Não cria um pagamento na blockchain.

Permissões da chave: `invoices` / write / `payments`.

## Parâmetros

| Parâmetro | Entrada | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `Idempotency-Key` | header | Não | 16–80 letras ASCII, dígitos, hífens ou sublinhados. ID lógico de pedido único na conta. Obrigatório quando o pagador escolhe o método de pagamento.; `string` minLength: `16`; maxLength: `80`; pattern: `^[A-Za-z0-9_-]+$` |

## Corpo do pedido

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `project` | `string` | Não | ID do projeto Payments; recomenda-se seleção explícita. Uma chave limitada a projeto usa o seu projeto. |
| `chain` | `string` | Não | Código da rede.; minLength: `1` |
| `asset` | `string` | Não | Ativo de pagamento suportado: native, símbolo ou identificador conhecido. Ativos aceites dependem da rede; omissão seleciona native.; Predefinição: `native` |
| `amount` | `string` | Não | Montante cripto positivo em unidades do ativo; precisão não superior às casas decimais do ativo.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `reference` | `string` | Não | Referência da encomenda; não substitui Idempotency-Key.; maxLength: `120` |
| `address` | `string` | Não | Endereço facultativo do conjunto de pagamentos do projeto. Caso contrário, o serviço escolhe um. |
| `tolerance` | `string` | Não | Pagamento insuficiente permitido em unidades do ativo, estritamente inferior a amount. Omita para tolerância zero.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `customer` | `object` | Não |  |
| `product` | `object` | Não |  |
| `payer` | `object` | Não |  |
| `metadata` | `object` | Não | Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos. |
| `invoice_currency` | `string` | Não | Moeda da cotação com três letras; apenas com invoice_amount.; pattern: `^[A-Za-z]{3}$` |
| `invoice_amount` | `string` | Não | Valor positivo do pedido em invoice_currency. Com chain e amount, representa o registro do comerciante no momento da criação. Sem dados de pagamento, é o valor fixo da fatura usado para calcular o ativo escolhido pelo pagador.; maxLength: `80`; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `expires_in` | `integer` | Não | Prazo de pagamento em minutos, contado a partir da emissão bem-sucedida dos dados. A omissão ou 0 aplica a política do projeto (60 por padrão); máximo de 10080. As solicitações antigas com método fixo também tratam valores negativos como omitidos; o pagamento com escolha de método rejeita valores negativos.; Padrão: `60`; maximum: `10080` |



### application/json

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



## Exemplos de pedidos

Os exemplos executam uma operação real na conta. Defina as variáveis de ambiente indicadas no código. Mantenha a chave privada; pedidos de escrita não são repetidos automaticamente.



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



[Transferir exemplo](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) }
}
```



[Transferir exemplo](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); }
}
```



[Transferir exemplo](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);
}
```



[Transferir exemplo](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)
```



[Transferir exemplo](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;
}
```



[Transferir exemplo](https://cryptanio.com/files/examples/api/create-invoice.mjs)

## Respostas e erros

### 201 Resposta bem-sucedida.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `checkout_url` | `string` | Não | Página de pagamento hospedada pelo Cryptanio. A criação ou repetição de uma fatura com escolha de método devolve um link de acesso interativo que permite a escolha até que um pagamento seja detectado. A criação com método fixo e todos os GET e listagens devolvem um link separado somente de leitura. Compartilhe ambos apenas com o pagador pretendido; nenhum concede acesso à conta ou à chave API. Confirme o pagamento pela API de faturas ou por um webhook verificado, não por um redirecionamento do navegador.; `uri` |
| `id` | `string` | Sim | Identificador opaco; mantenha-o como cadeia.; minLength: `1` |
| `status` | `string` | Sim | pending aguarda pagamento; seen detetado; partial parcialmente pago; paid liquidado; underpaid/overpaid/late exigem decisão; expired prazo terminado; canceled anulado.; `pending`, `seen`, `paid`, `underpaid`, `partial`, `overpaid`, `expired`, `late`, `canceled` |
| `project_id` | `string` | Sim | Identificador opaco; mantenha-o como cadeia.; minLength: `1` |
| `reference` | `string` | Não | Referência da encomenda. |
| `customer` | `object` | Não |  |
| `product` | `object` | Não |  |
| `payer` | `object` | Não |  |
| `metadata` | `object` | Não | Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos. |
| `invoice_currency` | `string` | Não | Moeda da cotação da encomenda. |
| `invoice_amount` | `string` | Não | Montante decimal exato como cadeia; não use vírgula flutuante.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `chain` | `string` | Sim | Código da rede. |
| `asset` | `string` | Sim | Ativo do pagamento. |
| `address` | `string` | Sim | Endereço de pagamento. |
| `payment_route` | `object` | Não | Identificador obrigatório do pagamento na blockchain quando uma fonte automática emite um tag, memo, comentário TON ou referência Solana Pay. Guarde-o com o endereço de recebimento; a referência do pedido do comerciante é um campo separado. |
| `payment_uri` | `string` | Não | Pedido de transferência Solana Pay com o destinatário, valor exato, mint do token suportado e referência obrigatória. Codifique este URI no QR de pagamento em vez do endereço de recebimento simples.; `uri` |
| `amount` | `string \| string` | Sim | Valor real que o comprador deve enviar; pode diferir do solicitado para distinguir faturas. Vazio até a escolha de um método. |
| `amount_raw` | `string \| string` | Sim | Valor inteiro na menor unidade, como texto. Vazio até a escolha de um método. |
| `asked` | `string \| string` | Sim | Valor em criptomoeda solicitado originalmente. Vazio até a escolha de um método. |
| `decimals` | `integer` | Sim | Casas decimais do ativo.; minimum: `0` |
| `tolerance` | `string` | Não | Tolerância em unidades mínimas; diferente de request.tolerance.; pattern: `^[0-9]+$` |
| `sandbox` | `boolean` | Sim | Uma fatura de teste não comprova um pagamento real na blockchain. |
| `needs_decision` | `boolean` | Não | É necessária uma decisão para underpaid, overpaid ou late. |
| `paid` | `string` | Não | Montante recebido em unidades mínimas.; pattern: `^[0-9]+$` |
| `tx_id` | `string` | Não | Identificador da transação de pagamento. |
| `paid_at` | `string` | Não | Data e hora UTC em RFC 3339.; `date-time` |
| `expires_at` | `string` | Sim | Data e hora UTC em RFC 3339.; `date-time` |
| `created_at` | `string` | Sim | Data e hora UTC em RFC 3339.; `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 Pedido inválido (bad_request, unsupported_asset).

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 400 application/json

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



### 401 Nenhuma chave API ativa válida (unauthorized).

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 401 application/json

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



### 403 Chave não permite operação, projeto, serviço ou IP; email não confirmado.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 403 application/json

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



### 409 Conflito de estado, parâmetros de repetição incompatíveis ou limite de recursos de pagamento (conflict, limit_reached, service_inactive).

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 409 application/json

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



### 429 Demasiados pedidos (rate_limited); repita após Retry-After.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 429 application/json

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



### 500 Erro interno (internal).

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 500 application/json

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



### 503 Indisponibilidade temporária (unavailable); repita com espera progressiva.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |



### 503 application/json

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



[Tratar erros e repetir com segurança](https://cryptanio.com/pt/docs.html#errors)

## Objetos aninhados

### `Invoice`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `checkout_url` | `string` | Não | Página de pagamento hospedada pelo Cryptanio. A criação ou repetição de uma fatura com escolha de método devolve um link de acesso interativo que permite a escolha até que um pagamento seja detectado. A criação com método fixo e todos os GET e listagens devolvem um link separado somente de leitura. Compartilhe ambos apenas com o pagador pretendido; nenhum concede acesso à conta ou à chave API. Confirme o pagamento pela API de faturas ou por um webhook verificado, não por um redirecionamento do navegador.; `uri` |
| `id` | `string` | Sim | Identificador opaco; mantenha-o como cadeia.; minLength: `1` |
| `status` | `string` | Sim | pending aguarda pagamento; seen detetado; partial parcialmente pago; paid liquidado; underpaid/overpaid/late exigem decisão; expired prazo terminado; canceled anulado.; `pending`, `seen`, `paid`, `underpaid`, `partial`, `overpaid`, `expired`, `late`, `canceled` |
| `project_id` | `string` | Sim | Identificador opaco; mantenha-o como cadeia.; minLength: `1` |
| `reference` | `string` | Não | Referência da encomenda. |
| `customer` | `object` | Não |  |
| `product` | `object` | Não |  |
| `payer` | `object` | Não |  |
| `metadata` | `object` | Não | Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos. |
| `invoice_currency` | `string` | Não | Moeda da cotação da encomenda. |
| `invoice_amount` | `string` | Não | Montante decimal exato como cadeia; não use vírgula flutuante.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `chain` | `string` | Sim | Código da rede. |
| `asset` | `string` | Sim | Ativo do pagamento. |
| `address` | `string` | Sim | Endereço de pagamento. |
| `payment_route` | `object` | Não | Identificador obrigatório do pagamento na blockchain quando uma fonte automática emite um tag, memo, comentário TON ou referência Solana Pay. Guarde-o com o endereço de recebimento; a referência do pedido do comerciante é um campo separado. |
| `payment_uri` | `string` | Não | Pedido de transferência Solana Pay com o destinatário, valor exato, mint do token suportado e referência obrigatória. Codifique este URI no QR de pagamento em vez do endereço de recebimento simples.; `uri` |
| `amount` | `string \| string` | Sim | Valor real que o comprador deve enviar; pode diferir do solicitado para distinguir faturas. Vazio até a escolha de um método. |
| `amount_raw` | `string \| string` | Sim | Valor inteiro na menor unidade, como texto. Vazio até a escolha de um método. |
| `asked` | `string \| string` | Sim | Valor em criptomoeda solicitado originalmente. Vazio até a escolha de um método. |
| `decimals` | `integer` | Sim | Casas decimais do ativo.; minimum: `0` |
| `tolerance` | `string` | Não | Tolerância em unidades mínimas; diferente de request.tolerance.; pattern: `^[0-9]+$` |
| `sandbox` | `boolean` | Sim | Uma fatura de teste não comprova um pagamento real na blockchain. |
| `needs_decision` | `boolean` | Não | É necessária uma decisão para underpaid, overpaid ou late. |
| `paid` | `string` | Não | Montante recebido em unidades mínimas.; pattern: `^[0-9]+$` |
| `tx_id` | `string` | Não | Identificador da transação de pagamento. |
| `paid_at` | `string` | Não | Data e hora UTC em RFC 3339.; `date-time` |
| `expires_at` | `string` | Sim | Data e hora UTC em RFC 3339.; `date-time` |
| `created_at` | `string` | Sim | Data e hora UTC em RFC 3339.; `date-time` |

### `ID`

Identificador opaco. Formato não garantido; não converta em número.

`string` Identificador opaco. Formato não garantido; não converta em número.

### `InvoiceStatus`

pending aguarda pagamento; seen detetado; partial parcialmente pago; paid liquidado; underpaid/overpaid/late exigem decisão; expired prazo terminado; canceled anulado.

`string` pending aguarda pagamento; seen detetado; partial parcialmente pago; paid liquidado; underpaid/overpaid/late exigem decisão; expired prazo terminado; canceled anulado.

### `Customer`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `id` | `string` | Sim | Identificador do cliente no seu sistema.; maxLength: `120` |

### `Product`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `id` | `string` | Não | Identificador do produto no seu sistema.; maxLength: `120` |
| `name` | `string` | Não | Nome do produto.; maxLength: `200` |
| `quantity` | `integer` | Não | Quantidade.; minimum: `1`; maximum: `1000000` |

### `Payer`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `comment` | `string` | Sim | Comentário do pagador.; maxLength: `500` |

### `InvoiceMetadata`

Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos.

`object` Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos.

### `Decimal`

`string`

### `RawAmount`

`string`

### `InvoiceRequest`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `project` | `string` | Não | ID do projeto Payments; recomenda-se seleção explícita. Uma chave limitada a projeto usa o seu projeto. |
| `chain` | `string` | Não | Código da rede.; minLength: `1` |
| `asset` | `string` | Não | Ativo de pagamento suportado: native, símbolo ou identificador conhecido. Ativos aceites dependem da rede; omissão seleciona native.; Predefinição: `native` |
| `amount` | `string` | Não | Montante cripto positivo em unidades do ativo; precisão não superior às casas decimais do ativo.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `reference` | `string` | Não | Referência da encomenda; não substitui Idempotency-Key.; maxLength: `120` |
| `address` | `string` | Não | Endereço facultativo do conjunto de pagamentos do projeto. Caso contrário, o serviço escolhe um. |
| `tolerance` | `string` | Não | Pagamento insuficiente permitido em unidades do ativo, estritamente inferior a amount. Omita para tolerância zero.; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `customer` | `object` | Não |  |
| `product` | `object` | Não |  |
| `payer` | `object` | Não |  |
| `metadata` | `object` | Não | Até 20 pares, no máximo 8192 bytes JSON. Não inclua segredos. |
| `invoice_currency` | `string` | Não | Moeda da cotação com três letras; apenas com invoice_amount.; pattern: `^[A-Za-z]{3}$` |
| `invoice_amount` | `string` | Não | Valor positivo do pedido em invoice_currency. Com chain e amount, representa o registro do comerciante no momento da criação. Sem dados de pagamento, é o valor fixo da fatura usado para calcular o ativo escolhido pelo pagador.; maxLength: `80`; pattern: `^[0-9]+(?:\.[0-9]+)?$` |
| `expires_in` | `integer` | Não | Prazo de pagamento em minutos, contado a partir da emissão bem-sucedida dos dados. A omissão ou 0 aplica a política do projeto (60 por padrão); máximo de 10080. As solicitações antigas com método fixo também tratam valores negativos como omitidos; o pagamento com escolha de método rejeita valores negativos.; Padrão: `60`; maximum: `10080` |

### `Error`

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `error` | `object` | Sim |  |