Obtendo a pré-visualização de uma transação PIX

Este endpoint permite obter a pré-visualização de taxas, valores líquidos e dados do destinatário de uma transação PIX antes de executá-la de fato. É ideal para exibir telas de confirmação de transferência e taxas para os usuários finais.

📍 Endpoint

POST https://api.etherglobalassets.com/pix/preview

🧾 Cabeçalhos obrigatórios (Headers)

Cabeçalho	Valor	Descrição
`Authorization`	`Bearer <token>`	Token JWT de autenticação.
`Content-Type`	`application/json`	Formato do corpo da requisição.

🧰 Corpo da Requisição (JSON)

{
  "pixKey": "fulano@email.com",
  "pixKeyType": "EMAIL",
  "amount": 1000,
  "type": "DEPOSIT"
}

Explicação dos campos:

Campo	Tipo	Obrigatório	Descrição
`pixKey`	string	✅	Chave PIX do destinatário (e-mail, CPF, CNPJ, telefone, aleatória ou código Copia e Cola/EMV).
`pixKeyType`	enum	✅	Tipo da chave PIX (`CPF`, `CNPJ`, `PHONE`, `EMAIL`, `RANDOM`, `QRCODE`).
`amount`	number	❌	Valor da transação em centavos. Exemplo: para R$ 10,00, envie `1000`.
`type`	enum	❌	Tipo da transação (`PIX_CASH_IN`, `PIX_CASH_OUT`, `CRYPTO_TRADE`, `MANAGER_COMMISSION`, `TENANT_COMMISSION`, `SYSTEM_COMMISSION`, `PIX_TO_CRYPTO`, `CRYPTO_TO_PIX`, `WITHDRAWAL`, `DEPOSIT`).

📌 Exemplo com curl

curl https://api.etherglobalassets.com/pix/preview \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "pixKey": "fulano@email.com",
    "pixKeyType": "EMAIL",
    "amount": 1000,
    "type": "DEPOSIT"
  }'

✅ Resposta esperada (HTTP 200 - OK)

{
  "amount": 1000,
  "fees": 0,
  "net_amount": 1000,
  "pix_data": {
    "recipient_name": "Fulano de Tal",
    "recipient_document": "***.123.456-**",
    "recipient_bank": "Banco Santander (Brasil) S.A."
  },
  "pix_key": "fulano@email.com",
  "pix_key_type": "EMAIL",
  "type": "DEPOSIT"
}

Entendendo a Resposta:

amount: Valor bruto em centavos informado na requisição.
fees: Taxa em centavos calculada para essa transação.
net_amount: Valor líquido resultante em centavos (após aplicação de taxas).
pix_data: Dados do destinatário/titular da chave Pix retornado pela instituição de destino:
- recipient_name: Nome completo ou mascarado do recebedor.
- recipient_document: Documento CPF/CNPJ mascarado.
- recipient_bank: Nome da instituição bancária de destino.

⚠️ Possíveis erros

Código	Erro	Causa comum
`400`	Bad Request	Chave Pix com formato incorreto ou inexistente, ou tipo de chave incompatível.
`401`	Unauthorized	Token inválido ou expirado.
`500`	Internal Server Error	Falha de comunicação temporária com o DICT/Banco Central.

🛡️ Dicas de Implementação

✅ FAÇA:

Sempre exiba os dados de pix_data (principalmente o nome do recebedor) para o usuário antes de confirmar a execução da transação de fato, para evitar fraudes ou envios errados.
Utilize o endpoint /pix/preview para calcular dinamicamente as taxas que serão cobradas no momento do envio e evitar surpresas no saldo.

❌ NÃO FAÇA:

Executar saques ou depósitos sem antes obter a validação (Preview) dos dados do destinatário, especialmente para chaves manuais (e-mail, CPF, etc.).

Suporte Técnico

Para dúvidas ou inconsistências nos dados exibidos de um preview, entre em contato via suporte@etherglobalassets.com.br.

Realizando um saque PIX para uma chave fixa

Realizando um saque PIX via QR Code