Glossário
Status de transação (status)
| Status | Descrição |
|---|---|
PENDING | Transação criada, aguardando pagamento ou processamento |
COMPLETED | Transação concluída com sucesso |
CANCELED | Transação cancelada (erro ou solicitação manual) |
REFUNDED | Valor reembolsado ao pagador |
EXPIRED | Prazo de pagamento expirou, transação não foi concluída |
Tipos de transação (type)
| Valor | O que é |
|---|---|
DEPOSIT | Entrada de dinheiro (Pix in, estorno recebido) |
WITHDRAW | Saída de dinheiro (Pix, TED, QR, dados, interna) |
Tipos de chave Pix (pixType)
| Tipo | Descrição | Formato |
|---|---|---|
cpf | 11 dígitos numéricos sem formatação | 12345678901 |
cnpj | 14 dígitos numéricos sem formatação | 12345678901234 |
phone | Formato internacional com DDI (55) | 5511987654321 |
email | Endereço de email válido | usuario@dominio.com.br |
evp | UUID gerado pelo Banco Central | 123e4567-e89b-12d3-a456-426655440000 |
Infrações (MED)
Campos do objeto infraction
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da infração |
protocol | string | Protocolo do registro da infração |
type | InfractionType | Tipo de infração |
status | InfractionStatus | Status atual |
reportedBy | ReportedType | Origem da denúncia |
reportDetails | string | Detalhes da denúncia |
analysisResult | AnalysisResult | Resultado da análise (null enquanto pendente) |
analysisDetails | string | null | Detalhes da análise |
transactionEndToEndId | string | EndToEnd ID da transação Pix relacionada |
transactionId | string | ID da transação no sistema PayZu |
creationDate | string | Quando o registro foi criado |
lastModificationDate | string | Última atualização |
dueDate | string | null | Prazo limite para análise |
InfractionType
| Valor | Descrição |
|---|---|
REFUND_REQUEST | Solicitação de devolução de valores de uma transação Pix |
FRAUD | Transação relacionada a atividade fraudulenta |
REFUND_CANCELLED | Cancelamento de uma solicitação de devolução previamente registrada |
ReportedType
| Valor | Descrição |
|---|---|
DEBITED_PARTICIPANT | Quem enviou os recursos (pagador) registrou a infração |
CREDITED_PARTICIPANT | Quem recebeu os recursos (recebedor) registrou a infração |
AnalysisResult
| Valor | Descrição |
|---|---|
AGREED | Infração procede, devolução será processada |
DISAGREED | Infração não procede, sem devolução |
Códigos HTTP
| Código | O que significa |
|---|---|
200 | Sucesso |
201 | Recurso criado |
400 | Payload inválido |
401 | Token ausente, inválido ou revogado |
403 | Token válido mas sem permissão |
404 | Recurso não encontrado |
409 | Conflito (idempotência, recurso em estado inválido) |
422 | Validação semântica falhou |
429 | Rate limit atingido |
5xx | Erro do servidor PayZu (retry com backoff) |
Campos comuns
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da transação na PayZu |
clientReference | string | Identificador externo que você passa, volta em todo callback |
amount | number | Valor em reais (BRL), nunca centavos |
callbackUrl | string | URL pra receber webhooks de mudança de status |
endToEndId | string | EndToEnd ID do Pix (Bacen). Formato E + 32 chars |
requestId | string | ID único da chamada PayZu. Aparece em todo erro, envie ao suporte |
Webhooks
A API Conta Digital envia notificações via POST para o callbackUrl informado na criação de cobrança ou saque, sempre que o status da transação muda. Inclui retry com backoff de até 72 tentativas.
Para IAs (LLMs)
Toda a documentação da Conta Digital PayZu disponível em formato consumível por modelos de linguagem. Copie o conteúdo direto, baixe o dump completo, ou use as URLs específicas por página. Funciona com ChatGPT, Claude, Gemini, Cursor, Copilot, etc.