Pular para o conteúdo principal
O Localpayment permite processar reembolsos para pagamentos de contas virtuais, possibilitando a devolução de fundos aos clientes tanto por meio da integração da API quanto da interface do Business Portal. Este guia aborda o fluxo de trabalho completo de reembolso para transações de contas virtuais usando o método de reembolso direto.

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 contas virtuais: 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 contas virtuais

Todos os reembolsos de contas virtuais são processados como Reembolsos Diretos, o que significa que você só precisa do externalId da transação original. O sistema encaminha automaticamente os fundos de volta para a conta do pagador original, sem exigir informações adicionais de beneficiário.
ImportanteApenas reembolsos integrais são permitidos para transações em contas virtuais. Reembolsos parciais não são suportados.

Requisitos específicos de cada país

Os reembolsos de contas virtuais têm requisitos e limitações específicos, que variam de acordo com o país e o método de pagamento. Abaixo, estão as principais considerações específicas de cada país:
  • Banco Azteca: Atualmente, não há reembolsos disponíveis para pagamentos processados ​​pelo Banco Azteca no México.
  • SPEI/TEF: Todos os reembolsos de pagamentos feitos via SPEI ou TEF são processados ​​através da rede SPEI.

Etapa 1: Processar reembolso via API

Para reembolsar um pagamento de conta virtual 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 contas virtuais 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áriaTodos 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

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 10 de novembro de 2026