Visão Geral da API - Help Center

Este guia fornece uma introdução às APIs da WEpayments, incluindo endpoints disponíveis, métodos de autenticação e informações de ambiente para desenvolvedores que integram com a plataforma.

O que você pode fazer com as APIs da WEpayments?

As APIs da WEpayments permitem que você integre seu sistema diretamente com nossa plataforma de pagamentos, automatizando operações sem necessidade de acesso manual ao Dashboard.

Operação	O que você pode fazer
Payin (recebimento)	Criar cobranças via PIX, boleto e cartão de crédito; consultar status de cobranças; solicitar estornos
Payout (envio)	Criar pagamentos individuais ou em massa; consultar status de pagamentos; validar dados de beneficiários
Extratos & Relatórios	Consultar informações de saldo; baixar extratos de transações; conciliar operações
KYC & Compliance	Enviar documentos; verificar status de conformidade; solicitar Limites Smart User
Data Collect	Gerar links de auto-onboarding para beneficiários; validar chaves PIX
Settlements	Solicitar saques; transferir saldo entre carteiras

Visão geral da autenticação da API

As APIs da WEpayments utilizam chaves de API para autenticação.

Aspecto	Detalhes
Método de autenticação	Chave de API (bearer token)
Geração da chave	Pelo Dashboard (Configurações > Controle de Acesso)
Whitelist de IP	Obrigatório – somente IPs autorizados podem utilizar a chave
Autenticação de dois fatores	Obrigatório para gerar e excluir chaves de API

💡 As chaves de API são geradas por usuário. Cada chave herda as permissões atribuídas àquele usuário.

Ambientes de API

Ambiente	Finalidade	URL Base
Sandbox	Testes e desenvolvimento	Entre em contato com o suporte para obter a URL do sandbox
Produção	Operações reais	Fornecida durante o onboarding

💡 Recomendamos testar todas as integrações no ambiente sandbox antes de ir para produção.

Endpoints de API disponíveis (visão geral)

Categoria	Exemplos de endpoints
Payin	Criar cobrança, consultar status de cobrança, cancelar cobrança, solicitar estorno
Payout	Criar pagamento, consultar status de pagamento, validar beneficiário
Data Collect	Criar solicitação de coleta, consultar status, validar chave PIX
Extratos	Consultar saldo, consultar extrato, baixar relatórios
Compliance	Enviar documentos KYC, verificar status de solicitação
Settlements	Criar liquidação, consultar status de liquidação

💡 Para a documentação completa da API, incluindo exemplos de requisição/resposta e códigos de erro, consulte nossa Documentação da API (documento separado).

Limites de requisição

Limite	Descrição
Requisições por segundo	Entre em contato com o suporte para obter os limites específicos do seu contrato
Operações em massa	Pagamentos em massa são suportados com limites adequados

Boas práticas para integração via API

Prática	Por que ajuda
Use um usuário dedicado para API	Crie um usuário específico para integração via API, não compartilhado com usuários humanos
Armazene as chaves de API com segurança	As chaves são exibidas apenas uma vez – guarde-as em um cofre seguro
Adicione ao whitelist apenas os IPs necessários	Minimiza riscos de segurança
Teste no sandbox primeiro	Valide a integração antes de ir para produção
Trate erros de forma adequada	Implemente lógica de retry para falhas transitórias
Monitore o uso da API	Acompanhe o uso para evitar atingir os limites

Tratamento de erros

Status HTTP	Descrição	O que fazer
200	Sucesso	Processar a resposta normalmente
400	Requisição inválida	Verificar os parâmetros da requisição
401	Não autorizado	Verificar a chave de API e o whitelist de IP
403	Proibido	Verificar as permissões do usuário
404	Não encontrado	Verificar a URL do endpoint
429	Muitas requisições	Implementar rate limiting / backoff
500	Erro do servidor	Tentar novamente com backoff exponencial

Suporte e recursos

Recurso	Onde encontrar
Documentação da API	Fornecida durante o onboarding / mediante solicitação
Ambiente sandbox	Entre em contato com o suporte para obter acesso
Suporte técnico	cs@wepayments.com.br ou chat do Dashboard

​O que você pode fazer com as APIs da WEpayments?

​Visão geral da autenticação da API

​Ambientes de API

​Endpoints de API disponíveis (visão geral)

​Limites de requisição

​Boas práticas para integração via API

​Tratamento de erros

​Suporte e recursos