Pular para o conteúdo principal
O Localpayment permite que você retire fundos da sua conta Localpayment e os deposite em sua própria conta bancária externa por meio da integração da API e da interface do Business Portal. Este guia abrange todo o fluxo de trabalho de transferência eletrônica para liquidação de fundos, detalhando o fluxo de autorização, a implementação da API e o acompanhamento do status.
Wire Out vs. PayoutUma Wire Out é uma liquidação/saque: os fundos são transferidos da sua conta Localpayment para a sua própria conta bancária externa, nunca para terceiros.Um Payout é um desembolso para um destinatário final (normalmente seu cliente). Se você precisar enviar fundos para um terceiro, use o endpoint Create Payout.

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 de Wire Out:

  • Saldo disponível suficiente em sua conta Localpayment. Consulte-o no Relatório de Balanço ou estime os fundos futuros com o Relatório de Saldo Projetado.
  • Função de usuário com permissões suficientes para autorização de Wire Out (consulte a documentação sobre funções e permissões).
  • Dados bancários externos (código SWIFT, número da conta, informações do beneficiário).

Guia de Implementação

A Localpayment oferece dois métodos para processar transferências bancárias: integração via API para processamento automatizado e Business Portal para operações manuais.

Processamento de Wire Out via API

Inicie transações de Wire Out programaticamente por meio da API REST para fluxos de liquidação automatizados e integração de sistemas.

Processamento de Transferências Bancárias no Business Portal

Processe manualmente instruções de Wire Out por meio do Business Portal da Localpayment, com uma interface visual e orientação passo a passo.

Etapa 1: Processar Wire Out via API

Para iniciar uma transação de Wire Out via API, envie uma solicitação POST para o endpoint Wire Out.

Parâmetros-chave da solicitação

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

Exemplo de solicitação

curl
Veja todos os parâmetros disponíveis na solicitação.

Etapa 2: Lidar com a resposta

Resposta bem-sucedida

Uma transferência eletrônica (Wire Out) iniciada com sucesso retorna os detalhes da transação com o status inicial:

Campos de resposta principais

Resposta de erro

Quando uma solicitação Wire Out falha, você recebe informações detalhadas sobre o erro:

Etapa 3: Rastrear o Status do Wire Out

Após iniciar uma operação de Wire Out, monitore 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 de Status Comuns do Wire Out

Notificações de ConclusãoVocê receberá notificações por e-mail quando as transações atingirem os status Completed ou Rejected, independentemente de terem sido iniciadas via API ou Business Portal. Para transações de Wire Out em cripto (USDC/USDT), o callback de webhook Completed também inclui o hash da transação na blockchain (campo hash) para que você possa verificar o pagamento de forma independente em um explorador de blocos. Este campo não se aplica a Wire Out em moeda fiduciária — consulte Webhooks para obter um exemplo completo da carga útil.

Processamento de Transferências Bancárias no Business Portal

As transferências eletrônicas também podem ser processadas através da interface do Business Portal da Localpayment. Este método oferece um fluxo de trabalho visual para gerenciar transferências de fundos e é particularmente útil para:
  • Liquidações pontuais** que não exigem automação de API.
  • Supervisão administrativa** com fluxos de trabalho de autorização visual.
  • Transferências rápidas de fundos sem recursos para o desenvolvimento.
Para obter instruções detalhadas sobre como processar transações de Transferência Eletrônica de Fundos (Wire Out) através do Business Portal, incluindo orientações passo a passo e tutoriais da interface, consulte o Guia de Transferência Eletrônica de Fundos do Business Portal .

Testando sua integração

Cenários de teste

Verifique se sua integração lida com esses cenários:
  1. Wire Out bem-sucedido: Processo de transferência com parâmetros válidos e saldo suficiente.
  2. Fundos insuficientes: Tentativa de transferência que excede o saldo da conta.
  3. Dados bancários inválidos: teste com códigos SWIFT ou números de conta incorretos.
  4. Fluxo de trabalho de autorização: Verificar o status de autorização pendente e o processo de aprovação.

Próximos passos

Ver o estado da transação

Verifique o status atual das transações de Wire Out usando a API de Status da Transação.

Configurar webhooks

Configure webhooks para receber notificações em tempo real sobre o status do Wire Out.
Última modificação em 10 de novembro de 2026