Pular para o conteúdo principal
Formato de erro A API do Pix JD responde a uma requisição que falhou com application/problem+json. O esquema Detail desta referência de API descreve esse corpo, que segue a RFC 9457.
Definições de campo
  • code – Código de erro de domínio estável e legível por máquina, limitado ao serviço que o emite. Nesta API, ele tem a forma PIX-NNNN.
  • title – Um resumo curto e legível do tipo de problema. Recomenda-se que esse valor não mude entre ocorrências do erro.
  • detail – Uma explicação legível específica para esta ocorrência do problema.
  • status – O código de status HTTP.
  • type – Um URI que identifica o erro no catálogo de erros da Lerian, construído como https://errors.lerian.studio/v1/<code>.
  • instance – Uma referência de URI que identifica a ocorrência específica do problema.
  • errors – Uma lista opcional de detalhes por campo. Cada entrada traz o location que falhou, uma message e o value daquele local.
  • upstream – Um membro de extensão da RFC 9457. Ele traz o código e a mensagem relatados por um provedor terceiro por trás de um proxy, e fica ausente a menos que o serviço tenha exposto um.
Como ler estas tabelas Cada linha começa com o status HTTP que a resposta carrega. Em seguida, nomeia a condição. A última coluna traz o texto detail que o serviço envia por padrão. Quando o serviço monta esse texto a partir da requisição que falhou, a linha indica isso. A partir do status 500, a resposta carrega texto fixo, não a causa bruta. A coluna detail mostra se um código envia internal error ou uma frase que o serviço escreveu para ele.

Requisições e regras de negócio do serviço Pix


Esses códigos vêm do próprio serviço Pix. Eles cobrem validação de requisição, gestão de chaves Pix, reivindicação de chaves, ordens de pagamento, devoluções, QR codes, participantes indiretos, créditos recebidos e créditos em espera.

Validação de requisição e acesso

Chaves Pix

Reivindicações de chave Pix

Transações e pagamentos

Devoluções e reembolsos

Participantes e contas

QR codes

Entidades, templates e conciliação

Fraude, conformidade e regulação

Falhas de serviço e dependência

Configuração do tenant

O status, não a família, diz se vale a pena tentar de novo. Um 409 nesta seção significa uma lacuna de provisionamento. O serviço sabe que o valor está ausente. Apenas um operador pode fornecê-lo, e repetir a requisição não pode mudar isso.Um 503 é o irmão ilegível da mesma condição. O serviço não sabe que a configuração está ausente, porque a leitura em si não foi concluída. A resposta nomeia a dependência com falha, e uma nova tentativa pode ter sucesso.Os pares são PIX-0092/PIX-0121 contra PIX-0051, PIX-0106 contra PIX-0122, e PIX-0107 contra PIX-0123.

Participantes indiretos

Créditos recebidos

Créditos em espera

Esses códigos vêm das ações do operador sobre um Pix recebido que espera: Creditar um Pix recebido em espera e Devolver ao pagador um Pix recebido em espera.

Trilho Pix e diretório de chaves


Esses códigos vêm da infraestrutura Pix conectada. O serviço traduz uma falha do trilho em um destes códigos antes de responder. Quem chama a API decide o fluxo com base no valor PIX-NNNN, não no vocabulário próprio do trilho.

Validação de requisição e autenticação

Chaves Pix

Reivindicações de chave Pix

Transações e pagamentos

Devoluções

Participantes e contas

QR codes

Disponibilidade do trilho

Fraude, conformidade e regulação

Falhas originadas fora do trilho Pix


Uma requisição Pix também pode falhar porque outro serviço da plataforma a recusou. Três faixas de código carregam essas recusas: registros de clientes, autorização e o ledger do Midaz. No webhook de cash-in de entrada (POST /v1/webhooks/cash-ins), uma indisponibilidade do CRM, do Access Manager ou do Midaz responde 500 em vez de 503 ou 504. O code é o código da dependência, por exemplo PIX-3007, e o detail nomeia a dependência.

Registros de clientes

Autorização

Ledger

Entrega de notificação


Os fluxos de posse de chave Pix enviam um código de uso único por e-mail ou por SMS. Estes códigos relatam uma falha nessa etapa de entrega.

Entrega por e-mail

Entrega por SMS

Motivos de rejeição de reembolso do MED


Uma requisição de reembolso do MED que este participante analisa e rejeita carrega um motivo de rejeição numerado. O domínio usa os valores 0, 1, 3 e 4.

Códigos de motivo de devolução Pix


Um Pix devolvido carrega um motivo de devolução próprio do Bacen, separado dos códigos PIX-NNNN acima. Esta referência de API documenta os valores permitidos no campo que os carrega. Esse campo é codigoDevolucao em um crédito recebido. Na visualização de status do crédito de reembolso, é refundCode. Em uma requisição de reembolso, é code.