Pular para o conteúdo principal
Esta seção detalha os formatos de resposta da API, os códigos de status HTTP e uma referência completa de todos os códigos de status e erro de transação usados pela API Localpayment. Dominar esses padrões e códigos de resposta é essencial para criar integrações robustas, rastrear com precisão os ciclos de vida das transações, lidar com diversos cenários e fornecer feedback claro ao usuário. As respostas da API Localpayment fornecem indicadores claros dos resultados das solicitações por meio de códigos de status HTTP e objetos de status estruturados. Embora as estruturas de resposta possam variar de acordo com o endpoint, elas sempre incluem informações essenciais para o processamento adequado.

Códigos de status HTTP

Códigos de status HTTP padrão que indicam sucesso ou falha na solicitação.

Objetos de status

Informações detalhadas sobre o status dos resultados das transações.

Tratamento de erros claro

Informações de erro estruturadas para depuração e resolução.

Códigos de status HTTP

A API utiliza códigos de status HTTP padrão para indicar os resultados das solicitações no nível do protocolo. Esses códigos fornecem a primeira indicação de se a sua solicitação foi bem-sucedida.

Códigos de sucesso (2xx)

Erros do cliente (4xx)

Erros do servidor (5xx)


Objeto de status

O objeto status fornece informações detalhadas e específicas do Localpayment sobre os resultados das transações e está incluído na maioria das respostas da API que envolvem operações financeiras.

Estrutura do Objeto de Status

Campos do objeto de status


Padrões de resposta comuns

Resposta de pagamento bem-sucedido

Padrão de resposta de erro


Guia de Status e Erros de Transações

Selecione um tipo de transação específico abaixo para obter uma lista detalhada de seus status e códigos de erro.

Payin

Códigos de status e erro para recebimento de fundos via Virtual Accounts, Columns cols= e APMs.

Payout

Códigos de status e erro para o envio de fundos aos beneficiários.

Reembolso

Códigos de status e erro para devolução de fundos a um cliente.

Estorno

Códigos de status e erro para transações contestadas e estornos forçados.

Devolução

Códigos de status e erro para pagamentos devolvidos e liquidações não realizadas.

Recall

Códigos de status e erro para estornos e reversões de pagamentos.

Crédito

Códigos de status e erro para transações e ajustes de crédito.

Débito

Códigos de status e erro para transações de débito e deduções de fundos.

Assinaturas

Códigos de status e erro para faturamento recorrente e ciclos de assinatura.

Câmbio de Moedas

Códigos de status e erro para transações cambiais.

Wire In

Códigos de status e erro para transferências bancárias recebidas.

Wire Out

Status e códigos de erro para transferências bancárias de saída.

Despesas

Códigos de status e erro para deduções de taxas e transações de despesas.

Taxa recorrente

Códigos de status e erro para cobranças de taxas periódicas.

Guia de Webhooks

Aprenda como receber atualizações de status em tempo real.

Tratamento de erros

Guia para lidar com transações falhas

Suporte

Obtenha ajuda com problemas de status específicos
Dica profissionalImplemente um sistema de registro abrangente que capture tanto os códigos de status quanto os códigos de erro com seus respectivos registros de data e hora. Isso cria trilhas de auditoria claras para atender aos requisitos de conformidade e torna a depuração de problemas significativamente mais rápida. Inclua a resposta de erro completa nos registros, e não apenas o código de erro.

Última modificação em 10 de novembro de 2026