Documentação
Carteira e depósitos
A API só lê a carteira e os depósitos: o dinheiro chega e o sistema o detecta. Em prática, POST /v1/test/fund simula um depósito e os valores 50.01 a 50.05 provocam cada ramo.
A carteira
- No ambiente de prática há uma carteira por dono, com dinheiro de prática.
GET /v1/walletsa lista eGET /v1/wallets/{wallet_id}a consulta. balance.availableé o que já se pode usar.balance.pendingsão depósitos que chegaram e ainda não foram creditados.controlsdiz quem pode assinar. Exportar a chave não existe na API.- São rotas do dono, e só leem: a chave de um agente não vê carteiras nem depósitos, e nenhuma rota move dinheiro para dentro nem para fora.
Como depositar
GET /v1/deposit-instructions devolve o endereço, a rede e o mínimo. Não existe POST /v1/deposits: o dinheiro chega e o sistema o detecta. Hoje só há USDC na rede Base, e em prática o endereço não recebe dinheiro real.
curl https://api.nouronpass.com/v1/deposit-instructions \
-H "Authorization: Bearer $NOURON_OWNER_KEY"{ "object": "deposit_instruction", "method": "usdc_onchain", "chain": "base", "address": "0x1f2e3d4c5b6a79880a1b2c3d4e5f60718293a4b5", "wallet_id": "wal_3c4d5e6f708192a3b4c5d6e7f8091a2b", "minimum_amount": "1.00", "confirmations_required": 12, "notice": "Dinero de práctica: esta dirección es del entorno de prueba y no recibe dinero real.", "request_id": "req_2c6d9wLx"}Estados de um depósito
A lista de estados é aberta: seu código deve tolerar um estado novo. Cada mudança de estado emite um evento funding.*.
| Estado | O que significa |
|---|---|
| `awaiting_deposit` | Espera-se que chegue. |
| `received` | Chegou e ainda não foi creditado. |
| `under_review` | Ficou em revisão antes de ser creditado. |
| `converted` | Creditado: já faz parte de balance.available. É final. |
| `returned` | Foi devolvido a quem o enviou e não foi creditado. É final. |
| `failed` | Não pôde ser concluído e não foi creditado. failure.code diz o motivo. É final. |
Como avança
Estes são todos os passos possíveis. Um estado final não tem saída.
criação→awaiting_depositawaiting_deposit→receivedawaiting_deposit→failedreceived→convertedreceived→under_reviewreceived→returnedreceived→failedunder_review→convertedunder_review→returnedunder_review→failed
Simular um depósito (só prática)
POST /v1/test/fund cria um depósito de prática e soma o dinheiro à carteira. Com uma chave real responde 404. Se você mandar Idempotency-Key, repetir a requisição devolve o mesmo depósito.
curl -X POST https://api.nouronpass.com/v1/test/fund \
-H "Authorization: Bearer $NOURON_OWNER_KEY" \
-H "Content-Type: application/json" \
-d '{"amount":"25.00"}'{ "object": "test_funding", "amount": "25.00", "balance_after": "1025.00", "deposit": { "id": "dep_9a1b2c3d4e5f60718293a4b5c6d7e8f9", "object": "deposit", "livemode": false, "status": "converted", "method": "test", "amount": "25.50", "amount_credited": "25.50", "fee": "0.00", "currency": "usdc", "wallet_id": "wal_3c4d5e6f708192a3b4c5d6e7f8091a2b", "source": { "chain": "base", "tx_hash": "0x5f1d3b8a2c4e6f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708", "from_address": "0x7a9c1e3b5d7f9021a3b5c7d9e1f30415a6b7c8d9" }, "failure": null, "created_at": "2026-10-13T14:03:21.114Z", "received_at": "2026-10-13T14:03:21.114Z", "credited_at": "2026-10-13T14:03:21.114Z", "request_id": "req_4k8m2pQ7" }}Valores com um ramo
Estes valores de teste levam o depósito por um caminho especial. A espera corre com o relógio de prática: adiante-o com POST /v1/test/clock/advance.
| Valor | O que significa |
|---|---|
| `50.01` | Fica em revisão por 10 minutos e depois é creditado. |
| `50.02` | É devolvido e não é creditado. |
| `50.03` | Falha por um limite e não é creditado. |
| `50.04` | Chega já e é creditado 30 minutos depois. |
| `50.05` | É menor que o mínimo: falha e não é creditado. |
Limites de prática
- Mínimo 1.00 USDC: um valor menor não é creditado.
- Até 10000.00 por depósito.
- Até 20000.00 e 30 depósitos por dia.
- Passado um limite, a resposta é 422
quota_exceeded.
Eventos
Cada passo emite um evento para o servidor do dono, nesta ordem. O detalhe da entrega está em Eventos e webhooks.
funding.awaiting_depositfunding.deposit_receivedfunding.failedfunding.convertedfunding.under_reviewfunding.returned