PayZu PaymentsReferência de códigos
Erros da API
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" }
]
}| Campo | Tipo | Descrição |
|---|---|---|
statusCode | number | Status HTTP, repetido no corpo. |
error | string | Nome do status HTTP, como Bad Request, Conflict ou Unprocessable Entity. |
message | string | Descrição do erro, em português. Pode mudar; não compare o texto. |
code | string | Código do erro: PZ mais três dígitos. A centena diz o assunto. Ausente nos erros sem código. |
details | array ou object | Em 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. |
requestId | string | Só em 5xx (PZ109, PZ901 e PZ999): identificador para informar ao suporte. |
Como decidir
- Decida pelo
code. - Em
PZ001,detailstraz os campos recusados, cada um comfieldemessage. - 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 ouContent-Typenão aceito respondem400,413ou415com o texto do servidor HTTP, em inglês. - Rotas sem corpo: não envie
Content-Type: application/json, como no estorno.
| HTTP | Mensagem |
|---|---|
| 400 | Basic token não definido. |
| 400 | grant_type não informado |
| 400 | grant type não suportado |
| 401 | Unauthorized |
| 401 | Não foi possível verificar o certificado. |
| 401 | Certificado não pertence ao usuário autenticado. |
| 401 | Token inválido ou expirado. |
| 403 | Não foi possível concluir sua solicitação |
| 422 | Cannot get currency rate |