1) Integração de um exchange no site

Objetivo

adicionar ao site um formulário de troca com seleção de moedas/redes, validação de endereço e criação de ordem.

Endpoints

• v2: POST /api/v2/instruments/public/validate-address, POST /api/v2/instruments/public/one, GET /api/v2/instruments/public, POST /api/v2/orders/public/create, POST /api/v2/orders/public/set-email
• v1 (adicionalmente se precisar de status/vitrine): GET /api/v1/instruments/public, GET /api/v1/instruments/public/one, POST /api/v1/instruments/public/validate-address

Fluxo

1. Carregar o catálogo de instrumentos ativos (moeda + rede) para montar as listas “Entrego/Recebo”.
2. Com a seleção do usuário, solicitar detalhes do instrumento “recebo” (precisão, memo/tag, limites).
3. Validar o endereço de destino via validate-address.
4. Criar a ordem: POST /api/v2/orders/public/create (recomenda-se v2). Salvar o orderId e exibir o depositAddress ao usuário.
5. (Opcional) adicionar e-mail à ordem: POST /api/v2/orders/public/set-email — para notificações ao usuário.
6. Exibir uma tela com instruções de pagamento para o depositAddress e um temporizador.

2) Obtenção e exibição de taxas

Objetivo

mostrar ao usuário as taxas atualizadas para o par selecionado.

Endpoints

• v1: GET /api/v1/rates/public/one — taxa pública em JSON.

Fluxo

1. Quando o usuário escolher um par — solicitar a taxa pública via rates/public/one.
2. Exibir a taxa, os valores mínimo/máximo (se retornados) e o horário de atualização.
3. (Opcional) aplicar “markup” visual à taxa exibida na vitrine (ver cenário 4), mas não use a taxa ajustada para criar efetivamente uma ordem em outra versão da API.

3) Criação e acompanhamento de ordens

Objetivo

criar uma ordem e fornecer ao usuário um status de execução claro.

Endpoints

• v2: POST /api/v2/orders/public/create, POST /api/v2/orders/public/set-email
• v1: POST /api/v1/orders/public/create, GET /api/v1/orders/public-info, GET /api/v1/orders/public/latest, POST /api/v1/orders/public/accept-rate-mode-change, POST /api/v1/orders/public/request-refund, GET /api/v1/orders/order-refund-info

Fluxo (v2 — recomendado para criação)

1. Validar a entrada e o endereço de destino.
2. Criar a ordem: v2/orders/public/create → obter orderId, depositAddress.
3. Oferecer “Adicionar e-mail”: v2/orders/public/set-email.
4. Mostrar ao usuário as instruções para realizar o depósito.

Acompanhamento de status (vitrine e conta do usuário)

• Vitrine “trocas recentes”: GET /api/v1/orders/public/latest.
• Detalhes de uma ordem específica: GET /api/v1/orders/public-info?orderId=...&destinationAddress=... — arrays deposits/withdrawals, confirmations, txId, networkFee.
• Mudança do modo de taxa sob demanda: POST /api/v1/orders/public/accept-rate-mode-change.
• Reembolsos: POST /api/v1/orders/public/request-refund → detalhes via GET /api/v1/orders/order-refund-info.

4) Verificação do status de transações

Objetivo

dar ao usuário transparência sobre o progresso de depósitos e saques.

Endpoints

• v1: GET /api/v1/orders/public-info, GET /api/v1/orders/order-refund-info

Fluxo

1. Consultar periodicamente public-info por orderId e destinationAddress.
2. No bloco deposits[0], analisar isPending, confirmations, txId, depositAddress.
3. Quando o depósito for confirmado — exibir as informações do saque a partir do array withdrawals (valor, networkFee, txId).
4. Em caso de reembolso — obter detalhes via order-refund-info e mostrar o status “Reembolso em andamento/concluído”.