Visão geral
Modelo mental do offramp em três entidades. Bob deposita USDT, recebe BRL via Pix.
Offramp é a operação que converte USDT em BRL e entrega o BRL ao cliente final via Pix. O modelo mental tem três entidades.
Em três frases
- Você obtém uma cotação (
quote) para a taxa USDT → BRL no momento. - Você aceita a cotação e cria uma conversão (
conversion), que recebe um endereço de depósito on-chain. - O cliente final deposita USDT nesse endereço e a BlendFi liquida o BRL via Pix na chave registrada.
A conversão é a entidade central. Ela representa a operação completa, do aceite da taxa até a liquidação do Pix, e é o recurso que você lê e aciona no resto da integração.
O ciclo em três passos
1. POST /v1/quotes → cotação válida por 5 minutos
2. POST /v1/quotes/:id/accept → cria a conversão; janela de depósito de 15 minutos
3. cliente final deposita USDT → liquidação automática em Pix; webhook anuncia o desfechoSe o depósito chega no valor exato dentro da janela, a conversão segue direto para completed sem nenhuma ação adicional sua. Se o valor diverge ou o prazo passa com depósito presente, a conversão entra em standby, e você decide entre liquidar pelo valor recebido ou tratar caso a caso. O caminho de standby tem página dedicada em Standby e liquidação manual.
Convenções de termo
Vocabulário recorrente nesta seção. Os identificadores entre crases são nomes de campo da API e nunca traduzem.
| Termo na prosa | Significado | Identificador |
|---|---|---|
| cotação | Snapshot imutável de taxa, válido por 5 minutos | quote, quote_id |
| conversão | Operação visível ao parceiro, do aceite até a liquidação | conversion, conversion_id |
| standby | Estado em que a conversão recebeu valor divergente ou expirou com depósito | status standby |
| liquidar | Acionar a execução final em standby pelo valor efetivamente recebido | endpoint /liquidate |
| depositada | Conversão que recebeu o valor exato dentro da janela | status funded |
| valor recebido | Soma dos depósitos on-chain creditados na conversão | received_amount |
Próximos passos
- Cotação: o que uma cotação carrega e o que ela não faz.
- Conversão: a entidade central e seus estados.
- Lock por usuário e tipo: a regra de uma conversão aberta por cliente final.
- Tutorial: integrando offramp do zero: exemplo de ponta a ponta.