Criando uma cotação
POST /v1/quotes para offramp. O que enviar, o que recebe de volta, o que essa chamada não faz.
Ponto de partida do offramp. A chamada cria uma cotação com TTL de 5 minutos. Não cria conversão e não emite endereço de depósito.
Pré-requisitos
- Cliente final com KYC aprovado. Sem KYC aprovado, a cotação falha com erro de validação. Veja Fluxo de KYC.
- Chave Pix do destinatário registrada no cliente final.
- Valor: USDT (
source_amount) ou BRL (target_amount).
A chamada
POST /v1/quotes
O corpo carrega o cliente final (user_id), o tipo (pix_offramp), o valor e a chave Pix de destino. Os campos exatos vão na referência da API.
O que volta
A resposta carrega:
id: identificador estável da cotação.exchange_rate: a taxa USDT → BRL aplicada, considerando o modo de taxas configurado para sua organização.source_amountetarget_amount: USDT e BRL implicados.expires_at: timestamp em que a cotação deixa de ser aceitável.
A taxa exposta depende do modo de taxas da sua organização.
O que não volta
- Endereço de depósito. O endereço só é emitido no aceite. Veja Aceitando a cotação.
- Conversão. Cotação não cria conversão.
- Reserva de limite. Reserva acontece no aceite.
TTL de 5 minutos, prominente
A cotação vale 5 minutos a partir da criação. Se a sua UX precisa de mais tempo entre obter a taxa e o cliente final confirmar, cote de novo no aceite, não tente estender a validade.
Não polle cotações
Uma cotação não muda de estado. Se você precisa de uma taxa mais nova, crie outra cotação. Polling em cima de cotação não traz informação nova e consome quota.
Erros comuns
- KYC do cliente final pendente ou rejeitado → erro de validação com código estável.
- Chave Pix do destinatário inválida ou não verificada → erro de validação.
- Sem permissão para o tipo
pix_offrampna sua organização → erro de autorização.
A taxonomia completa de erros vai na referência da API quando publicada.
Reference em breve
A documentação detalhada da resposta e dos códigos de erro vai aparecer aqui em conjunto com a disponibilidade da API. Para o desenho conceitual, veja Cotação.
Próximo passo
- Aceitando a cotação: converte a cotação em conversão e gera o endereço de depósito.
