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

Este endpoint permite criar um PIX dinâmico para depósito. O tempo de expiração do PIX dinâmico é de 1 hora.

Obs.: O pagamento deve ser feito por uma conta bancária com o mesmo CPF ou CNPJ do usuário.

📍 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": 1000
}

Explicação dos campos:

Campo	Tipo	Obrigatório	Descrição
amount	number	✅	Valor da transação em centavos. Exemplo: 1 real = 100 centavos

📌 Exemplo com curl

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

✅ Dica: Substitua <token> pelo seu JWT de autenticação válido e amount pelo valor desejado em centavos.

✅ Resposta esperada (HTTP 201 - Created)

{
  "uuid": "0000028f6a9047c2b05e1bda00000000",
  "qrCodeId": "11111a51-e67e-41a2-b1e1-b79ecb9c1111",
  "pixKey": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/b3a6b4dd-6ec6-4efe-90f8-697d7d2c0b725204000053039865802BR5919ETHER GLOBAL ASSETS6009SAO PAULO62070503***6304D032",
  "pixKeyType": "QRCODE",
  "amount": 1000,
  "description": null,
  "userId": "22222ace-14fe-47e1-ba1a-cc38006b2222",
  "tenantId": "33333333-a09f-4d5b-bf8d-333333333333",
  "status": "PENDING",
  "expireAt": "2025-08-11T19:09:26.220Z",
  "type": "DEPOSIT",
  "providerReferenceId": "FOUR_ALL",
  "e2e": "",
  "executedAt": null,
  "provider": null,
  "senderInfo": null,
  "receiverInfo": null,
  "feeBatchId": null,
  "feeDistributionCompletedAt": null,
  "feeDistributionMetadata": null
}

Explicação da resposta:

Campo	Tipo	Descrição
uuid	string	Identificador único da transação
qrCodeId	string	ID do QR Code gerado
pixKey	string	Chave PIX completa (QR Code)
pixKeyType	string	Tipo da chave PIX (QRCODE)
amount	number	Valor da transação em centavos
description	string/null	Descrição da transação
userId	string	ID do usuário
tenantId	string	ID do tenant
status	string	Status da transação (PENDING)
expireAt	string	Data/hora de expiração
type	string	Tipo da transação (DEPOSIT)
providerReferenceId	string	Referência do provedor
e2e	string	End-to-end ID
executedAt	string/null	Data/hora de execução
provider	string/null	Provedor do PIX
senderInfo	object/null	Informações do remetente
receiverInfo	object/null	Informações do destinatário

⚠️ Possíveis erros

Código	Erro	Causa comum
400	Bad Request	Valor inválido ou campo obrigatório faltando
401	Unauthorized	Token inválido ou ausente
500	Internal Server Error	Erro interno do serviço

🎯 Como usar o PIX gerado

Após receber a resposta, você pode:

Exibir o QR Code: Use o campo pixKey para gerar um QR Code
Compartilhar o PIX: O usuário pode pagar escaneando o QR Code
Monitorar o status: Verifique o campo status para acompanhar o pagamento
Verificar expiração: Use o campo expireAt para saber quando expira

⏰ Tempo de expiração

Duração: 1 hora
Campo: expireAt na resposta
Status: Após expirar, o PIX fica inválido

🛡️ Dicas importantes

✅ FAÇA:

Use valores em centavos (ex: R$ 10,00 = 1000 centavos)
Verifique se o CPF/CNPJ da conta bancária é o mesmo do usuário
Monitore o status da transação

❌ NÃO FAÇA:

Usar valores negativos ou zero
Tentar pagar com conta de CPF/CNPJ diferente
Ignorar o tempo de expiração

🆘 Problemas comuns

“Estou recebendo erro 400!”

Verifique se o valor está em centavos
Confirme se o campo amount está presente

“O PIX não está sendo pago!”

Verifique se o CPF/CNPJ da conta bancária é o mesmo do usuário
Confirme se o PIX não expirou

“Erro 401!”

Verifique se o token de autenticação é válido
Faça uma nova autenticação se necessário

📞 Suporte

Se nada funcionar:

Verifique os valores em centavos
Confirme a autenticação está válida
Entre em contato com nossa equipe de suporte

Mais Informações sobre esse endpoint:

Acesse aqui