Erros
Formato das respostas de erro e o que cada código significa.
Erros voltam com status HTTP e um corpo JSON:
{
"code": "PGPL0001",
"message": "The link you are trying to access was not found"
}| Campo | Descrição |
|---|---|
code | Código estável. Use ele, não a message, na sua lógica. |
message | Texto em inglês para logs. Pode mudar. |
cause | Detalhe técnico, quando houver. |
details | Campos extras de alguns erros. |
Status HTTP
| Status | Significado | Retentar? |
|---|---|---|
400 | Corpo ou parâmetro inválido. | Não, corrija a requisição. |
401 | Credenciais ausentes ou inválidas. | Não. |
403 | Sem escopo para a rota. | Não. |
404 | Recurso não existe. | Não. |
409 | Conflito de estado (ex. estorno repetido). | Não. |
422 | Requisição válida que não pôde ser processada. | Depende do código. |
5xx | Falha do nosso lado. | Sim, com backoff e a mesma X-Idempotency-Key. |
Códigos
| Código | Mensagem | O que fazer |
|---|---|---|
0X400 | Corpo não pôde ser lido | Confira o Content-Type: application/json e o JSON. |
0X4001 | Campos obrigatórios ausentes | details lista cada campo com problema. |
0X4002 | Campo obrigatório ausente | Envie o campo indicado. |
0X500 | Erro inesperado | Retente; se persistir, fale com o suporte com o horário da chamada. |
PGPL0001 | Link não encontrado | Confira o id. |
PGPL0002 | Conta bloqueada | Fale com o suporte. |
PGPL0003 | Link de uso único já usado | Crie outro link. |
PGPL0004 | Pagamento não encontrado | Confira o ID do pagamento. |
PGPL0005 | Já existe pagamento pendente no link | Aguarde o pendente terminar ou expirar. |
PGPL0006 | Cartão bloqueado | O pagador deve usar outro cartão. |
PGPL0007 | Cartão sem suporte a 3DS | O pagador deve usar outro cartão. |
PGPL0008 | Link expirado | Crie outro link. |
PGPL0009 | Tópico de webhook inválido | Use um dos tópicos. |
PGPL0010 | Resposta de webhook inválida | — |
PGPL0011 | Status de pagamento inválido | Use um valor da lista em status. |
PGPL0012 | Moeda inválida | Use BRL ou USD. |
PGPL0013 | Pagando o próprio link | Use outra conta para pagar. |
PGPL0014 | Método de pagamento não permitido no link | Veja available_methods do link. |
PGPL0015 | Webhook já cadastrado | Use o existente em GET /webhook. |
PGPL0016 | Limite de webhooks atingido | Exclua um webhook antes. |
PGPL0017 | Pagamento não permitido | Fale com o suporte. |
PGPL0018 | Link com pagamentos pendentes | Aguarde antes de excluir. |
PGPL0019 | Pagamento não concluído | Só pagamentos done têm essa operação. |
PGPL0020 | Documento inválido | Envie CPF/CNPJ válido, só dígitos. |
PGPL0021 | E-mail inválido | Corrija o e-mail. |
PGPL0022 | Status de link inválido | Use um valor da lista em status. |
PGPL0023 | Pagamento não estornável | Só pagamentos done são estornados. |
PGPL0024 | Subconta deve solicitar estorno | Use POST /refund-request/{id}. |
PGPL0025 | Método não aceita estorno | Devolva o valor por outro meio. |
PGPL0026 | Prazo de estorno excedido | Devolva o valor por outro meio. |
PGPL0027 | Pagamento já estornado | Nada a fazer (409). |
PGPL0028 | Saldo insuficiente para o estorno | Adicione saldo e tente de novo. |
PGPL0029 | Já existe solicitação de estorno | Aguarde a análise (409). |
PGPL0030 | Evento de webhook não encontrado | Confira os IDs. |
PGPL0031 | Evento não pode ser reenviado | Só eventos done ou failed. |