Criando um PIX dinâmico para depósito na conta

Este endpoint permite gerar um PIX dinâmico (Copy & Paste / QR Code) para realizar depósitos na conta. O tempo de expiração padrão para este PIX é de 5 minutos.

[!IMPORTANT] ⚠️ Atenção à Titularidade:

Contas Cripto: O pagamento deve ser realizado obrigatoriamente por uma conta bancária com o mesmo CPF ou CNPJ cadastrado na plataforma (Titularidade Própria).
Contas de Pagamento: É permitido receber depósitos de qualquer CPF ou CNPJ (Titularidade de Terceiros).

📍 Endpoint

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

🧾 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)

{
  "amount": 500,
  "expirationTime": 300,
  "idempotencyKey": "IDEMP-12345"
}

Explicação dos campos:

Campo	Tipo	Obrigatório	Descrição
`amount`	number	✅	Valor da transação em centavos. Exemplo: para R$ 5,00, envie `500`.
`expirationTime`	number	❌	Tempo de expiração em segundos (opcional).
`idempotencyKey`	string	❌	Chave de idempotência (opcional).

📌 Exemplo com curl

curl https://api.etherglobalassets.com/pix/deposit \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 500
  }'

✅ Resposta esperada (HTTP 201 - Created)

{
  "uuid": "u1u2i3d4-v5a6-7890-abcd-ef1234567890",
  "qrCodeId": "q1r2c3o4-d5e6-7890-f1g2-h3i4j5k6l7m8",
  "pixKey": "00020126870014BR.GOV.BCB.PIX...",
  "pixKeyType": "QRCODE",
  "amount": 500,
  "status": "PENDING",
  "expireAt": "2026-01-14T17:04:33.665Z",
  "type": "DEPOSIT",
  "receiverAccountType": "CRYPTO",
  "id": "trans-123-456-789",
  "totalFeeAmount": 1,
  "createdAt": "2026-01-14T16:54:33.669Z"
}

Campos Principais da Resposta:

Campo	Tipo	Descrição
`uuid`	string	Identificador único da transação.
`pixKey`	string	Copia e Cola: Chave completa para ser usada em aplicativos bancários.
`status`	string	Status inicial (ex: `PENDING`).
`expireAt`	string	Timestamp de quando o PIX deixará de ser válido.
`totalFeeAmount`	number	Valor total de taxas aplicadas (em centavos).

⏰ Ciclo de Vida e Expiração

Duração: O PIX dinâmico expira em 5 minutos.
⚠️ Atenção: Após o campo expireAt, o pagamento não poderá mais ser processado. Recomenda-se exibir um cronômetro regressivo para o usuário.

⚠️ Possíveis erros

Código	Erro	Causa comum
`400`	Bad Request	Valor inválido ou campo `amount` ausente.
`401`	Unauthorized	Token inválido ou expirado.
`500`	Internal Server Error	Falha temporária no provedor de PIX.

🛡️ Dicas de Implementação

✅ FAÇA:

Sempre envie o amount em centavos para evitar erros de precisão decimal.
Valide se o usuário possui saldo ou permissões adequadas antes de chamar o endpoint.
Verifique a titularidade antes do pagamento para evitar estornos automáticos (em contas Cripto).

❌ NÃO FAÇA:

Enviar valores negativos, nulos ou strings no campo amount.
Reutilizar o mesmo pixKey após a expiração.

Suporte Técnico

Para dúvidas sobre reconciliação ou falhas de expiração, entre em contato com suporte@etherglobalassets.com.br informando o uuid da transação.

Excluindo chaves PIX

Realizando um saque PIX para uma chave fixa