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 5 minutos.

Obs.: O pagamento deve ser feito por uma conta bancária com o mesmo CPF ou CNPJ do usuário, caso seja conta Cripto. Em contas do tipo Pagamento, você pode receber de qualquer CPF ou CNPJ.

📍 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
}

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": 500
  }'

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

✅ Resposta esperada (HTTP 201 - Created)

{
  "uuid": "u1u2i3d4-v5a6-7890-abcd-ef1234567890",
  "qrCodeId": "q1r2c3o4-d5e6-7890-f1g2-h3i4j5k6l7m8",
  "pixKey": "00020126870014BR.GOV.BCB.PIX013675db6455-4e87-4b7f-9f3d-d11470209a270225u1u2i3d4v5a67890abcdef123456789052040000530398654045.005802BR5924ETHER EXCHANGE E BANKING6009SAO PAULO62290525u1u2i3d4v5a67890abcdef123456789063045AB8",
  "pixKeyType": "QRCODE",
  "amount": 500,
  "description": null,
  "userId": "u1s2e3r4-i5d6-7f8g-9h0i-j1k2l3m4n5o6",
  "tenantId": "t1e2n3a4-n5t6-7i8d-9j0k-l1m2n3o4p5q6",
  "status": "PENDING",
  "expireAt": "2026-01-14T17:04:33.665Z",
  "type": "DEPOSIT",
  "providerReferenceId": "CORPX",
  "receiverAccountType": "CRYPTO",
  "e2e": "",
  "executedAt": null,
  "provider": null,
  "senderInfo": null,
  "receiverInfo": null,
  "feeBatchId": null,
  "feeDistributionCompletedAt": null,
  "feeDistributionMetadata": null,
  "idempotencyKey": null,
  "requestPayload": null,
  "responsePayload": null,
  "traceId": null,
  "nextReconciliationAt": null,
  "lastStatusCheckAt": null,
  "fee": null,
  "netAmount": null,
  "id": "trans-123-456-789",
  "createdAt": "2026-01-14T16:54:33.669Z",
  "updatedAt": "2026-01-14T16:54:33.669Z",
  "statusHistory": [],
  "reconciliationAttempts": 0,
  "autoRefundTriggered": false,
  "totalFeeAmount": 1
}

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 atual (Ex: PENDING, CONFIRMED)
`expireAt`	string	Data/hora de expiração (ISO 8601)
`type`	string	Tipo da transação (DEPOSIT)
`providerReferenceId`	string	Referência do provedor
`receiverAccountType`	string	Tipo de conta de recebimento (Ex: CRYPTO)
`e2e`	string	ID End-to-End da transação PIX
`executedAt`	string/null	Data/hora de execução
`provider`	string/null	Provedor de pagamento
`senderInfo`	object/null	Dados do remetente (após confirmação)
`receiverInfo`	object/null	Dados do destinatário
`feeBatchId`	string/null	ID do lote de taxas
`feeDistributionCompletedAt`	string/null	Data de conclusão da distribuição de taxas
`feeDistributionMetadata`	object/null	Metadados de taxas
`idempotencyKey`	string/null	Chave de idempotência da requisição
`id`	string	ID interno da transação no sistema
`createdAt`	string	Data de criação do registro
`updatedAt`	string	Data da última atualização
`totalFeeAmount`	number	Valor total de taxas aplicadas em centavos

⚠️ 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: 5 minutos
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