currencies, estimate, min-amount). Depósitos: payment-crypto/*. Saques: transfer-crypto/*. Permissão de leitura compartilhada: payment-crypto/currencies.
payCurrency
É o código da moeda + rede. Você não inventa esse valor: use o campo code retornado por Moedas.
| Campo em Moedas | Use em payCurrency? |
|---|---|
code | Sim (ex.: usdttrc20) |
label | Não (só exibição) |
network | Não (informação da rede) |
extraIdRequired | Não — indica se a rede exige memo/tag no saque |
payCurrency serve em cotação, valor mínimo, criar depósito e criar transferência.
A lista de moedas depende da configuração da conta. Consulte Moedas antes de fixar um
payCurrency no seu sistema.Depósito vs transferência
| Operação | O que acontece | amount no create |
|---|---|---|
| Depósito | API gera endereço/QR; o cliente envia cripto | Reais (BRL) — mín. R$ 5,00 |
| Transferência | Você debita a conta e envia para address | Reais (BRL) debitados — mín. R$ 1,00 |
id ou use webhooks (evite polling em loop).
Fluxo: receber cripto (depósito)
1. Listar moedas
GET /payment-crypto/currencies — escolha o code.Moedas2. (Opcional) Cotar
GET /payment-crypto/estimate com direction=to_crypto (padrão): amount em BRL → quanto cripto o pagador deve enviar.Cotação3. Conferir mínimo
GET /payment-crypto/min-amount?payCurrency=... — valida mínimo on-chain e referência em BRL antes do primeiro depósito na rede.Valor mínimo4. Criar depósito
POST /payment-crypto/create — amount (BRL), payCurrency, description (opcional).Criar depósito5. Acompanhar
Corpo do depósito (POST /payment-crypto/create)
| Campo | Obrigatório | Descrição |
|---|---|---|
amount | Sim | Valor em BRL (mín. 5, máx. 1.000.000) |
payCurrency | Sim | code de Moedas |
description | Não | Padrão gerado pela API se omitido |
externalReference | Não | ID do seu sistema |
coverFee | Não | Padrão false — ver taxas no dashboard |
purpose | Não | gateway (cobrança ao cliente, padrão) ou topup (recarga da própria conta); não aparece na resposta pública |
payAddress, payCurrency, payAmount, id e status. Campos internos (provider, accountId, purpose) não são expostos em /v1.
Fluxo: enviar cripto (transferência)
1. Listar moedas
Mesmo
code de Moedas.2. (Opcional) Cotar em reais
direction=from_crypto: amount em cripto → estimated_amount em BRL (validar saldo).Cotação3. Criar transferência
POST /transfer-crypto/create — amount, address, payCurrency, description.Criar transferência4. Acompanhar
Corpo da transferência (POST /transfer-crypto/create)
| Campo | Obrigatório | Descrição |
|---|---|---|
amount | Sim | Valor em BRL debitado (mín. 1) |
address | Sim | Endereço on-chain de destino |
payCurrency | Sim | code de Moedas |
description | Sim | 3–180 caracteres |
payAmount | Não | Quantidade exata em cripto (ex.: lida de QR); quando informado, o payout usa esse valor on-chain |
extraId | Não | Memo ou destination tag — obrigatório em redes com extraIdRequired: true |
externalReference | Não | ID do seu sistema |
coverFee | Não | Padrão true: amount é o valor recebido pelo destino; taxa somada no débito |
direction na cotação
direction define em qual moeda você informou o amount, não o sentido do pagamento.
direction | Você envia amount em… | estimated_amount vem em… | Exemplo |
|---|---|---|---|
to_crypto (padrão) | Reais (BRL) | Cripto (payCurrency) | R$ 100 → ~18,42 USDT |
from_crypto | Cripto (payCurrency) | Reais (BRL) | 18,42 USDT → ~R$ 100 |
Resposta da cotação
| Campo | Significado |
|---|---|
currency_from | Moeda de origem |
currency_to | Moeda de destino |
estimated_amount | Valor estimado no destino (aproximado; pode variar até confirmar on-chain) |
to_crypto e from_crypto).
Valor mínimo (min-amount)
Consulte antes do primeiro depósito em cada payCurrency. Campos úteis na resposta:
| Campo | Significado |
|---|---|
minAmountCrypto | Mínimo aceito em cripto na rede |
minAmountBrl | Referência aproximada em reais |
payCurrency | Mesmo código enviado na query |
Filtros nas listagens
GET /payment-crypto/list e GET /transfer-crypto/list compartilham os query params:
| Parâmetro | Descrição |
|---|---|
page | Página (padrão 1) |
pageSize | Itens por página (padrão 50, máximo 100) |
dateFrom / dateTo | Período em ISO 8601 (createdAt) |
status | PENDING, PROCESSING, COMPLETED, FAILED, CANCELED, REVERSED |
externalReference | Filtro exato pela sua referência |
search | Busca parcial em id, descrição, referência, E2E, referenceId, endereço ou chave |
items, page, pageSize, total, pages.
- Listar depósitos — só CRYPTO_IN.
- Listar transferências — só CRYPTO_OUT (campos cripto no item, ex.:
payAddress,payCurrency).
Endpoints
Moedas
Lista
code habilitados.Cotação
BRL ↔ cripto.
Valor mínimo
Mínimo on-chain + BRL.
Criar depósito
Endereço e QR.
Consultar depósito
Por
id.Listar depósitos
Histórico.
Criar transferência
Saque para endereço on-chain.
Consultar transferência
Por
id.Listar transferências
Histórico de saques.
Sempre valide
min-amount na primeira vez que usar cada payCurrency. Cotações são aproximadas até a confirmação on-chain.