PayZu CellApoio
Erros
Toda resposta de erro vem com Content-Type: application/json e os mesmos campos.
Formato do corpo
400 de validação
{
"statusCode": 400,
"error": "Bad Request",
"message": "Corpo ou parâmetro fora do formato.",
"code": "PZC001",
"details": [
{
"field": "document",
"message": "Campo obrigatório."
}
]
}| Campo | Tipo | Descrição |
|---|---|---|
statusCode | integer | O mesmo status HTTP da resposta. |
error | string | Nome do status HTTP em inglês. |
message | string | Motivo em texto, para exibir ou registrar. |
code | string | Código estável do erro, como PZC001. |
details | array | Campos ou itens recusados, quando o erro aponta quais. Cada item traz field, o campo do corpo ou o parâmetro, e message. |
requestId | string | Id da requisição, só nos erros 5xx. É o que o suporte pede. |
Na validação, details traz um item por campo ou parâmetro recusado.
O id da requisição
Toda resposta, com ou sem erro, traz o cabeçalho request-id, com um identificador que a API gera para a chamada.
Cabeçalhos da resposta
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
request-id: 7d4d5f8e-3b2a-4c1e-9f6a-2b8c1d0e5a71- Valor enviado por você: a API ignora o
request-idque vier na requisição. - Erros
5xx: o mesmo valor volta emrequestId, no corpo. - Suporte: é por esse valor que o suporte acha a chamada. Registre-o do seu lado.
Status HTTP
| HTTP | O que significa |
|---|---|
400 | Requisição mal formada: falta campo, o tipo está errado, o parâmetro ou o Content-Type não é aceito. |
401 | Credencial ausente ou inválida. |
403 | A credencial vale, mas não alcança este recurso ou esta operação. |
404 | O recurso não existe, ou é de outro integrador ou do outro ambiente. |
409 | Conflito: o recurso já existe, está em outro estado ou tem outra operação em andamento. |
413 | O corpo passa do tamanho permitido. |
422 | A requisição está bem formada, mas uma regra de negócio recusou. |
429 | Limite de chamadas por minuto excedido. |
5xx | Falha do nosso lado ou de quem a API consulta. |
Corpo ou parâmetro fora do formato é 400, não 422. O 422 fica para a recusa de regra, como o CPF que não passa na validação do dígito ou a operação que o provedor de pagamento ou a operadora recusou.
Decida pelo código
- Código: trate pelo
code.erroremessagesão textos para leitura. - Status: o status HTTP agrupa, e o
codeidentifica. Dois erros com o mesmo status têm códigos diferentes. - Mensagem: o mesmo código pode vir com um
messagemais específico que o do catálogo. - Assunto: o código tem três dígitos depois de
PZC, e a centena diz o assunto.
| Centena | Assunto |
|---|---|
PZC0xx | Requisição, autenticação e acesso |
PZC1xx | Titular |
PZC2xx | Linha e chip |
PZC3xx | Pagamento |
PZC9xx | Operadora e erro interno |
Códigos mais comuns
| Código | HTTP | Mensagem |
|---|---|---|
PZC001 | 400 | Corpo ou parâmetro fora do formato. |
PZC010 | 401 | Credencial ausente ou inválida. |
PZC012 | 403 | IP de origem fora da lista da chave. |
PZC013 | 403 | A chave não tem acesso a esta operação. |
PZC020 | 404 | Recurso não encontrado. |
PZC005 | 429 | Limite de chamadas por minuto excedido. |
A lista inteira, com todas as mensagens, está no Catálogo de erros.