Pular para o conteúdo principal
O Localpayment permite processar reembolsos de pagamentos com cartão, possibilitando a devolução de fundos para os cartões de crédito ou débito dos clientes por meio da integração de API e da interface do Business Portal. Este guia abrange o fluxo de trabalho completo de reembolso para transações com cartão.

Antes de começar

Certifique-se de ter:

Credenciais da API

Credenciais de API e token de acesso válidos para autenticação.

Configuração da conta

Configuração adequada da conta para o país de destino e verificação da empresa.

Lista branca de IPs

Adicione os endereços IP do seu servidor à lista de permissões para acesso à API.

Endpoint do webhook

Configure um URL de webhook para receber notificações de pagamento.

Requisitos adicionais para reembolso:

  • Você precisa ter saldo suficiente em sua conta Localpayment para cobrir o valor do reembolso.
  • Função de usuário com permissões de reembolso (consulte a documentação de Funções de Usuário).
  • A transação original deve estar com o status Completed.
  • O externalId da transação de pagamento original.

Guia de Implementação

A Localpayment oferece dois métodos para processar reembolsos de cartão: integração de API para processamento automatizado e Business Portal para operações manuais.

Processamento de reembolso via API

Processe reembolsos programaticamente através da API REST para fluxos de trabalho automatizados e integração com seus sistemas.

Processamento de reembolsos no Business Portal

Processe reembolsos manualmente através do Business Portal Localpayment com uma interface amigável.

Reembolsos diretos para pagamentos com cartão

Para transações com cartão, os reembolsos são processados como Reembolsos Diretos, o que significa que você só precisa do externalId da transação original. Não são necessários dados adicionais de beneficiário ou bancários, pois os fundos são devolvidos ao cartão original usado no pagamento.

Etapa 1: Processar reembolso via API

Para reembolsar um pagamento com cartão via API, envie uma solicitação PATCH para o endpoint de Reembolso.

Parâmetros-chave da solicitação

A solicitação requer vários parâmetros-chave:

Exemplo de solicitação

Abaixo segue um exemplo de uso do curl:
curl
Veja todos os parâmetros disponíveis na solicitação.

Etapa 2: Lidar com a resposta

Resposta bem-sucedida

Detalhes da confirmação de reembolso processado com sucesso:

Campos de resposta principais

Resposta de erro

Quando um pedido de reembolso falha, você receberá as seguintes informações de erro:

Cenários de erro comuns


Reembolsos do Business Portal

Os reembolsos de cartão também podem ser processados ​​através da interface do Business Portal da Localpayment. Este método oferece um fluxo de trabalho visual para gerenciar reembolsos e é particularmente útil para:
  • Reembolsos ocasionais que não exigem automação por API.
  • Supervisão administrativa onde são necessários fluxos de trabalho de aprovação.
  • Processamento rápido de reembolsos sem necessidade de recursos de desenvolvimento.
Para obter instruções detalhadas sobre como processar reembolsos através do Business Portal, incluindo orientações passo a passo e tutoriais da interface, consulte o Guia de Reembolsos do Business Portal.
Aprovação necessária:Todos os reembolsos iniciados pelo Business Portal da Localpayment exigem aprovação através do fluxo de autorização designado. Certifique-se de ter as permissões de usuário necessárias antes de tentar efetuar reembolsos pelo Business Portal.

Etapa 3: Acompanhe o status do reembolso

Após iniciar um reembolso, acompanhe o seu progresso através destes métodos:

Webhooks (Recomendado)

Receba notificações em tempo real quando o status da transação mudar. Ideal para ambientes de produção.

Endpoint da API de Status

Consultar o status da transação programaticamente. Útil para consultar ou recuperar notificações de webhook perdidas.

Visualização do Business Portal

Interface visual para monitoramento de transações. Ideal para supervisão manual e análise detalhada de transações.

Códigos comuns de status de reembolso

Os reembolsos não são instantâneos para o cliente. O valor reembolsado pode levar vários dias para aparecer na fatura do cartão do cliente depois que você solicita o reembolso. O prazo exato depende do provedor de pagamentos e do emissor do cartão.
Referência completaConsulte todos os códigos de status em nossa Documentação de Status da Transação.

Testando sua integração

Cenários de teste

Verifique se sua integração lida com esses cenários:
  1. Reembolso bem-sucedido: Processe o reembolso com um externalId válido e fundos suficientes.
  2. Fundos insuficientes: Tentativa de reembolso devido ao saldo insuficiente na conta.
  3. Transação inválida: Tente reembolsar um externalId inexistente.
  4. Reembolso duplicado: Tentativa de reembolsar uma transação que já foi reembolsada.
  5. Validação de permissões: Teste com usuários que possuem diferentes níveis de permissão.

Próximos passos

Ver o estado da transação

Consulte o status atual de transações e reembolsos usando a API de Status da Transação.

Configurar webhooks

Configure webhooks para receber notificações em tempo real sobre as mudanças de status do reembolso.

Analisar funções de usuário

Gerencie as permissões e funções dos usuários para os recursos de processamento de reembolsos.
Última modificação em 20 de novembro de 2026