Pular para o conteúdo principal

SDKs & Libraries

Acelere sua integração usando SDKs oficiais para TypeScript, Python, Go, PHP, Java, Kotlin, C#, Ruby e React Native. Essas bibliotecas simplificam requisições à API, autenticação e tratamento de erros, permitindo que você se concentre em criar ótimas experiências de pagamento.

​
URLs do Ambiente

Saiba mais sobre Modo de Teste vs Modo ao Vivo.

​
Gerenciamento de Chaves da API e Autenticação

1

Access API Keys

Navegue até Developer → API Keys no seu painel para gerenciar suas chaves.
2

Generate a New Key

Selecione Add API Key, forneça um nome descritivo e configure o acesso de escrita:
  • Habilitar acesso de escrita (marcado): Permissões completas de leitura e escrita para todas as operações da API
  • Habilitar acesso de escrita (desmarcado): Acesso somente leitura - pode apenas buscar dados (pagamentos, assinaturas, clientes, produtos). Não pode criar ou modificar recursos.
Desmarque “Enable write access” para integrações do painel, ferramentas de analytics e qualquer sistema que precise apenas visualizar dados sem fazer alterações.
3

Store Your Key Securely

Copie a chave gerada imediatamente e garanta que ela esteja armazenada com segurança.
4

Authenticate Your API Requests

Use suas chaves de API para autenticar todas as requisições. Aplique o seguinte formato de autorização:
Authorization: Bearer YOUR_API_KEY
Nunca exponha suas chaves de API secretas em código do lado do cliente ou repositórios públicos.

​
Formato de Resposta

{
  "id": "pay_1234567890",
  "status": "completed",
  "amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

​
Limites de Taxa

Nossa API usa um sistema de limitação de taxa com janelas duplas e proteção contra picos. Os limites são aplicados com base no seu método de autenticação e nível de negócio.

​
Limites Padrão (Nível 0)

JanelaLimite
Por Segundo (Pico)40 solicitações
Por Minuto (Sustentado)240 solicitações

​
Níveis de Negócio

Limites de taxa mais altos estão disponíveis para empresas com necessidades de API aumentadas:
NívelPico (por segundo)Sustentado (por minuto)
Nível 0 (Padrão)40240
Nível 11001.000
Nível 25005.000
Entre em contato com o suporte para atualizar seu negócio para um nível de limite de taxa superior.

​
Solicitações Não Autenticadas

Solicitações sem cabeçalhos de autenticação válidos são limitadas por endereço IP:
JanelaLimite
Por Segundo (Pico)20 solicitações
Por Minuto (Sustentado)100 solicitações

​
Cabeçalhos de Limite de Taxa

Monitore seu uso com estes cabeçalhos de resposta:
  • X-RateLimit-Limit - Máximo de solicitações permitidas
  • X-RateLimit-Remaining - Solicitações restantes na janela atual
  • X-RateLimit-Reset - Momento em que o limite de taxa é redefinido
Quando você excede os limites de taxa, a API retorna uma resposta 429 Too Many Requests. Implemente backoff exponencial na sua lógica de retentativas.

​
Tratamento de Erros

Para gerenciar erros efetivamente, consulte as seções Códigos de Erro e Falhas de Transação para orientações detalhadas.

Error Codes

Aprofunde-se em detalhes completos de erros e suas resoluções.

Transaction Failures

Obtenha insights sobre problemas comuns de transações e suas soluções.

​
Webhooks

Receba notificações em tempo real sobre eventos de pagamento. Veja nosso Guia de Webhooks para instruções de configuração.

Webhook Guide

Configure webhooks para notificações em tempo real e tratamento de eventos.