PayZu PaymentsReferência de códigos

Erros da API


Nesta páginaFormatoComo decidirErros sem código

Trate cada erro pelo code. Ele não muda de sentido; a message pode mudar. Todos os códigos, com o status HTTP e a mensagem de cada um, estão no Catálogo de erros.

Uma recusa do emissor não é erro HTTP.

Ela vem com sucesso e creditCardPayment.status diferente de 2. Veja Status da transação.

Formato

409 de regra de negócio
{
  "statusCode": 409,
  "error": "Conflict",
  "message": "Já existe um estorno em andamento para esta cobrança",
  "code": "PZ402"
}
400 de validação
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "A solicitação possui erros de validação",
  "code": "PZ001",
  "details": [
    { "field": "creditCardPayment.card.expiration", "message": "A data deve estar no formato MM/YYYY" }
  ]
}
CampoTipoDescrição
statusCodenumberStatus HTTP, repetido no corpo.
errorstringNome do status HTTP, como Bad Request, Conflict ou Unprocessable Entity.
messagestringDescrição do erro, em português. Pode mudar; não compare o texto.
codestringCódigo do erro: PZ mais três dígitos. A centena diz o assunto. Ausente nos erros sem código.
detailsarray ou objectEm PZ001, lista de { field, message }, com field no caminho do campo, como customer.identity ou cart[0].unitPrice. Em PZ202 e PZ203, objeto com a recusa original do cartão. Ausente nos demais.
requestIdstringSó em 5xx (PZ109, PZ901 e PZ999): identificador para informar ao suporte.

Como decidir

  1. Decida pelo code.
  2. Em PZ001, details traz os campos recusados, cada um com field e message.
  3. Nos erros 5xx, a resposta traz requestId; informe-o ao suporte.

Erros sem código

Os erros de autenticação, de cotação e do servidor HTTP ainda saem sem code. Decida pelo status e pela mensagem.

  • Corpo recusado pelo servidor HTTP: corpo que não é JSON válido, corpo vazio com Content-Type: application/json, corpo grande demais ou Content-Type não aceito respondem 400, 413 ou 415 com o texto do servidor HTTP, em inglês.
  • Rotas sem corpo: não envie Content-Type: application/json, como no estorno.
HTTPMensagem
400Basic token não definido.
400grant_type não informado
400grant type não suportado
401Unauthorized
401Não foi possível verificar o certificado.
401Certificado não pertence ao usuário autenticado.
401Token inválido ou expirado.
403Não foi possível concluir sua solicitação
422Cannot get currency rate