- Business Portal Localpayment: Interface amigável para gerenciamento manual de transações.
- Integração de API: Acesso programático para processamento automatizado de payouts.
Antes de começar
Certifique-se de ter:- Credenciais de API válidas (token de acesso).
- Informações completas sobre o beneficiário.
- Configuração adequada da conta para o país de destino.
- Compreensão dos requisitos específicos de cada país (consulte Requisitos por País abaixo).
Etapa 1: Inicializar a transação de payout
Para criar um payout por transferência bancária, envie uma solicitaçãoPOST ao endpoint Create a Payout com paymentMethod.type definido como "BankTransfer".
Endpoint
Cabeçalhos obrigatórios
Parâmetros-chave da solicitação
A solicitação requer vários objetos-chave:Exemplo de solicitação (Argentina)
curl
Etapa 2: Lidar com a resposta
Resposta bem-sucedida
Uma resposta bem-sucedida inclui informações detalhadas sobre a transação e identificadores de rastreamento:Campos de resposta principais
Resposta de erro
Quando uma solicitação falhar, você receberá informações detalhadas sobre o erro:Etapa 3: Rastrear o status da transação
Após efetuar um payout, 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 de status comuns
Referência completaConsulte todos os códigos de status em nossa Documentação de Status da Transação.
Etapa 4: Aprovação da transação
Para maior segurança, certas transações exigem a aprovação de duas pessoas:- Iniciador: Envia o pedido de payout.
- Aprovador: Analisa e confirma a transação.
Nota de segurançaOs requisitos de aprovação ajudam a prevenir transações não autorizadas e a garantir a conformidade com as regulamentações locais.
Requisitos específicos de cada país
Os detalhes de implementação variam de país para país. Qualquer país não mencionado explicitamente segue o procedimento padrão sem requisitos especiais. Consulte esses requisitos antes da integração:- Brasil
- Chile
- Colômbia
- República Dominicana
- México
- Peru
Requisitos especiais:
beneficiary.bank.branché obrigatório quando você envia o payout com um número de conta (beneficiary.bank.account.number). Isso se aplica tanto a transferências TED quanto Pix feitas para uma conta. Se você o omitir, o payout é rejeitado com o erro 300 (beneficiary.bank.branchmust not be null) e o erro 701 (Invalid bank branch code).code: Obrigatório. O código da agência no formato exigido pelo banco.name: Opcional. O nome completo da agência bancária.
- Quando você envia o payout com uma chave Pix (
beneficiary.bank.account.alias),beneficiary.bank.branché opcional. merchant.addressé obrigatório e deve incluircountry.country: Obrigatório. O código de país ISO de 3 letras do endereço do comerciante (por exemplo,BRA).- Os demais campos de
merchant.addresssão opcionais.
- O destinatário deve possuir uma chave Pix registrada.
-
Você deve informar essa chave na propriedade
beneficiary.bank.account.alias. Observação: as propriedades beneficiary.bank.account.type e beneficiary.bank.account.number devem ser excluídas da solicitação.
- CPF (Registro de Contribuinte Individual)
- CNPJ (Cadastro Nacional de Pessoa Jurídica)
- Número de celular
- Endereço de email
- Chave aleatória: um código único de 32 caracteres gerado pelo Banco Central. Essa opção permite que os destinatários recebam pagamentos sem compartilhar informações pessoais.
Testando sua integração
Ambiente de Sandbox
Utilize o ambiente de teste para realizar os procedimentos:Cenários de teste
Verifique se sua integração lida com esses cenários:- Transação bem-sucedida: Fluxo de payout padrão
- Erros de validação: conta bancária inválida, campos ausentes
- Atrasos no processamento: transações que levam tempo para serem processadas.
- Transações com falha: Fundos insuficientes, beneficiários bloqueados
- Atualizações de status: gerenciamento de webhooks e consulta de status.
Recursos e próximos passos
Maximize o sucesso da sua integração com estes recursos essenciais.Integração de Webhook
Configure notificações em tempo real para atualizações do status das transações.
Relatórios do Business Portal
Acesse análises detalhadas, ferramentas de geração de relatórios e recursos de conciliação.
Monitoramento de transações
Aprenda a consultar o status das transações e a implementar um rastreamento abrangente.
Referência da API
Documentação completa dos endpoints com exemplos interativos.
Dica profissionalSempre teste seu fluxo de trabalho em nosso ambiente de sandbox antes de implantá-lo em produção. Isso garante que o tratamento de erros, o processamento de webhooks e o rastreamento de status funcionem corretamente em todos os cenários.
Precisar de ajuda?Entre em contato com nossa equipe de suporte caso encontre algum problema ou precise de ajuda com a integração.

