Skip to main content

Endpoint

Autenticação

Este endpoint requer autenticação usando Basic Auth. Concatene sua chave secreta e pública no formato sk_xxxx:pk_yyyy e codifique em Base64.

Response

Campos da Resposta

Detalhes dos Campos

Status da Empresa

O campo status pode ter os seguintes valores:
  • active: Empresa ativa e operacional
  • pending: Processo de integração em andamento
  • suspended: Operações temporariamente suspensas
  • inactive: Conta inativa

Métodos de Pagamento

O objeto paymentMethods indica quais métodos de pagamento estão habilitados para sua empresa:
Para solicitar a ativação de novos métodos de pagamento, entre em contato com nosso suporte.

Limites Operacionais

O objeto limits contém informações sobre os limites de transação:
Os valores são expressos em centavos. Transações com valores fora desses limites serão recusadas automaticamente.

Configuração de Webhooks

O objeto configuration.webhook contém a URL para notificações e os eventos configurados:
Os eventos possíveis são:
  • transaction.approved: Transação aprovada
  • transaction.refused: Transação recusada
  • transaction.refunded: Transação estornada
  • transaction.chargedback: Transação com chargeback
  • transaction.canceled: Transação cancelada

Configuração de Liquidação

O objeto settlement contém informações sobre como os valores são liquidados para sua empresa:
  • schedule: Prazo de liquidação (D+1, D+2, D+30, etc.)
  • automaticTransfer: Se a transferência é automática ou manual

Casos de Uso

Verificar Configuração

É recomendável verificar periodicamente as configurações da sua empresa para garantir que tudo está correto:

Verificar Limites de Transação

Consulte os limites antes de processar transações de alto valor:

Boas Práticas

  1. Verifique periodicamente as configurações da sua empresa
  2. Configure um webhook global para receber notificações de transações
  3. Mantenha os dados bancários atualizados para evitar problemas na liquidação
  4. Fique atento aos limites de valor mínimo e máximo por transação
  5. Verifique regularmente quais métodos de pagamento estão habilitados
Alterações em dados bancários, razão social ou documentos podem exigir verificação adicional e podem levar até 2 dias úteis para serem processadas.