Referência da API

Simular pagamento Sandbox

POST/v1/simulate

Contrato v1 / 1.1.3 5 / 2026-11-17

Nesta página

Executa um cenário com chave de teste de escrita e permissão simulation. Exige Idempotency-Key; uma repetição idêntica retorna o resultado salvo sem outra transição ou envio. Reutilizar a chave com parâmetros diferentes retorna 409. Dados, destinatários, cotas e saldos são separados de Live. Nenhuma transação blockchain é criada. expire e late são aceitos; Pay e assinaturas estão excluídos.

Permissões da chave: simulation / write.

Parâmetros

ParâmetroEntradaObrigatórioDescrição
Idempotency-KeyheaderSim16–80 letras ASCII, dígitos, hífens ou sublinhados. Mantenha a mesma chave e requisição exata ao repetir. Use uma chave nova para cada transição distinta.
string minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$

Corpo do pedido

CampoTipoObrigatórioDescrição
operation_idstringNãoCópia opcional de Idempotency-Key no corpo; deve coincidir exatamente com o cabeçalho. Prefira apenas o cabeçalho.
minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$
invoice_idstringNãoFatura Sandbox da conta e projeto autorizados pela chave. Informe exatamente invoice_id ou watch_id.
minLength: 1
watch_idstringNãoEndereço Sandbox ativo da conta e projeto/serviço autorizados pela chave. Informe apenas um destino.
minLength: 1
transaction_idstringNãoOmita para um novo pagamento de teste. Reutilize o identificador simulated_ retornado nas próximas transições desse pagamento. Identificadores desconhecidos retornam 404; ativo e valor não podem mudar.
pattern: ^simulated_[0-9]+$
event_typestringNãoTransição da transação de teste. Confirme ou reverta o mesmo transaction_id para testar seu ciclo de vida.
payment.pending, payment.confirmed, payment.rolled_back; Padrão: payment.confirmed
amount_rawstringNãoValor inteiro positivo nas menores unidades do ativo. O padrão é o valor da fatura, da transação existente ou uma unidade inteira do ativo do catálogo para um novo pagamento de endereço. Use nova transação para um pagamento parcial adicional.
minLength: 1; maxLength: 78; pattern: ^[0-9]+$
assetstringNãoO ativo da fatura é fixo. Para endereços com várias regras de ativos, selecione explicitamente um ativo permitido do catálogo. A precisão de tokens desconhecidos não pode ser inferida.
decimalsintegerNãoVerificação opcional: deve coincidir com a precisão fixada na fatura ou catálogo. Não substitui a precisão.
minimum: 0; maximum: 255
occurred_atstringNãoHorário opcional do evento, entre 30 dias antes e 7 dias mais 1 minuto depois de agora. Não altera outros objetos nem o relógio do sistema. late define seu próprio horário.
date-time
actionstringNãoCenário exclusivo para faturas. expire aplica a expiração desta fatura sem evento ou webhook. late expira a fatura e simula um pagamento confirmado um segundo depois. invoice_status segue as regras normais de aceitação; late não garante um estado específico.
expire, late
application/json
{
  "invoice_id": "2001",
  "event_type": "payment.pending",
  "amount_raw": "1000000"
}

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
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
: "${CRYPTANIO_OPERATION_ID:?Set CRYPTANIO_OPERATION_ID}"
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 '{"invoice_id":"2001","event_type":"payment.pending","amount_raw":"1000000"}' \
  "https://api.cryptanio.com/v1/simulate" \
  --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
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/simulate"

    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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}"), &payload); err != nil { return err }

    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
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("simulate");
    }
    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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}")?;

    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
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/simulate';

    $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('{"invoice_id":"2001","event_type":"payment.pending","amount_raw":"1000000"}', true, 512, JSON_THROW_ON_ERROR);

    $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
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/simulate"

    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("{\"invoice_id\":\"2001\",\"event_type\":\"payment.pending\",\"amount_raw\":\"1000000\"}")

    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
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/simulate";

  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 = {
    "invoice_id": "2001",
    "event_type": "payment.pending",
    "amount_raw": "1000000"
  };

  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

Respostas e erros

202 Cenário aceito ou resultado salvo de uma repetição idêntica.
CampoTipoObrigatórioDescrição
event_idstringNãoID do evento registrado. Omitido em expire, que não cria evento.
event_typestringNãoTransição de pagamento registrada; omitida em expire.
watch_idstringSimEndereço Sandbox usado por este cenário.
transaction_idstringNãoIdentificador estável do pagamento de teste para transições posteriores; omitido em expire.
invoice_idstringNãoFatura Sandbox afetada quando o cenário se refere a uma fatura.
invoice_statusstringNãoEstado real da fatura após a operação; não presuma um resultado fixo para atraso ou expiração.
actionstringNãoCenário explícito de fatura, quando solicitado.
expire, late
queuedbooleanSimO processamento da notificação foi enfileirado. Isso não comprova a aceitação de um envio externo.
replayedbooleanSimVerdadeiro quando a mesma operação idempotente retorna sem outra transição ou evento.
202 application/json
{
  "event_id": "2301",
  "event_type": "payment.pending",
  "watch_id": "2000",
  "transaction_id": "simulated_2300",
  "invoice_id": "2001",
  "invoice_status": "pending",
  "queued": true,
  "replayed": false
}
400 Pedido inválido (bad_request, unsupported_asset).
CampoTipoObrigatórioDescrição
errorobjectSim
400 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
401 Nenhuma chave API ativa válida (unauthorized).
CampoTipoObrigatórioDescrição
errorobjectSim
401 application/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.
CampoTipoObrigatórioDescrição
errorobjectSim
403 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
404 Objeto não encontrado no âmbito da chave (not_found).
CampoTipoObrigatórioDescrição
errorobjectSim
404 application/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).
CampoTipoObrigatórioDescrição
errorobjectSim
409 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
429 Demasiados pedidos (rate_limited); repita após Retry-After.
CampoTipoObrigatórioDescrição
errorobjectSim
429 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
500 Erro interno (internal).
CampoTipoObrigatórioDescrição
errorobjectSim
500 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
503 Indisponibilidade temporária (unavailable); repita com espera progressiva.
CampoTipoObrigatórioDescrição
errorobjectSim
503 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}

Tratar erros e repetir com segurança

Objetos aninhados

SimulateRequest

CampoTipoObrigatórioDescrição
operation_idstringNãoCópia opcional de Idempotency-Key no corpo; deve coincidir exatamente com o cabeçalho. Prefira apenas o cabeçalho.
minLength: 16; maxLength: 80; pattern: ^[A-Za-z0-9_-]+$
invoice_idstringNãoFatura Sandbox da conta e projeto autorizados pela chave. Informe exatamente invoice_id ou watch_id.
minLength: 1
watch_idstringNãoEndereço Sandbox ativo da conta e projeto/serviço autorizados pela chave. Informe apenas um destino.
minLength: 1
transaction_idstringNãoOmita para um novo pagamento de teste. Reutilize o identificador simulated_ retornado nas próximas transições desse pagamento. Identificadores desconhecidos retornam 404; ativo e valor não podem mudar.
pattern: ^simulated_[0-9]+$
event_typestringNãoTransição da transação de teste. Confirme ou reverta o mesmo transaction_id para testar seu ciclo de vida.
payment.pending, payment.confirmed, payment.rolled_back; Padrão: payment.confirmed
amount_rawstringNãoValor inteiro positivo nas menores unidades do ativo. O padrão é o valor da fatura, da transação existente ou uma unidade inteira do ativo do catálogo para um novo pagamento de endereço. Use nova transação para um pagamento parcial adicional.
minLength: 1; maxLength: 78; pattern: ^[0-9]+$
assetstringNãoO ativo da fatura é fixo. Para endereços com várias regras de ativos, selecione explicitamente um ativo permitido do catálogo. A precisão de tokens desconhecidos não pode ser inferida.
decimalsintegerNãoVerificação opcional: deve coincidir com a precisão fixada na fatura ou catálogo. Não substitui a precisão.
minimum: 0; maximum: 255
occurred_atstringNãoHorário opcional do evento, entre 30 dias antes e 7 dias mais 1 minuto depois de agora. Não altera outros objetos nem o relógio do sistema. late define seu próprio horário.
date-time
actionstringNãoCenário exclusivo para faturas. expire aplica a expiração desta fatura sem evento ou webhook. late expira a fatura e simula um pagamento confirmado um segundo depois. invoice_status segue as regras normais de aceitação; late não garante um estado específico.
expire, late
Simulation

CampoTipoObrigatórioDescrição
event_idstringNãoID do evento registrado. Omitido em expire, que não cria evento.
event_typestringNãoTransição de pagamento registrada; omitida em expire.
watch_idstringSimEndereço Sandbox usado por este cenário.
transaction_idstringNãoIdentificador estável do pagamento de teste para transições posteriores; omitido em expire.
invoice_idstringNãoFatura Sandbox afetada quando o cenário se refere a uma fatura.
invoice_statusstringNãoEstado real da fatura após a operação; não presuma um resultado fixo para atraso ou expiração.
actionstringNãoCenário explícito de fatura, quando solicitado.
expire, late
queuedbooleanSimO processamento da notificação foi enfileirado. Isso não comprova a aceitação de um envio externo.
replayedbooleanSimVerdadeiro quando a mesma operação idempotente retorna sem outra transição ou evento.
Error

CampoTipoObrigatórioDescrição
errorobjectSim