Visão Geral - Cartão de Crédito

​

API de Cartão de Crédito FireBanking

​

Início Rápido

​

1. Obtenha suas Chaves de API

• Chave de API: Para operações padrão de pagamento
• Credenciais de Webhook: Para receber notificações de pagamento
• Token Interno: Para integrações sistema-a-sistema (se aplicável)

​

2. Faça seu Primeiro Pagamento

curl -X POST "https://api-gateway.firebanking.com.br/credit-card/v1/payment" \
  -H "x-api-key: SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "purchaseValue": 1.23,
    "installments": 1,
    "externalId": "ext-payment-123",
    "purchaseTitle": "Compra de Produto",
    "description": "Descrição da compra",
    "payment": {
      "chargeType": "FEE_TO_CUSTOMER",
      "capture": true,
      "card": {
        "name": "João da Silva",
        "number": "5186882549895601",
        "expiration": "12/2025",
        "securityCode": "220"
      }
    },
    "buyer": {
      "name": "João da Silva",
      "document": "25201246010",
      "email": "[email protected]",
      "phone": "11999999999",
      "countryCode": "+55",
      "address": {
        "country": "BR",
        "state": "SP",
        "city": "São Paulo",
        "district": "Centro",
        "street": "Rua das Flores",
        "zipCode": "01000000",
        "number": "123",
        "complement": "Apto 45"
      }
    },
    "additionalInfo": {
      "customerIp": "192.168.1.100"
    },
    "callbackUrl": "https://example.com/webhook/callback"
  }'

​

Métodos de Autenticação

​

Autenticação x-api-key

x-api-key: SUA_CHAVE_DE_API

​

Conceitos Fundamentais

​

Valores Monetários

• R$ 100,00 = 100
• R$ 25,50 = 25.50

​

Tipos de Cobrança

• FEE_TO_CUSTOMER: Taxa cobrada do cliente
• FEE_TO_SELLER: Taxa cobrada do vendedor

​

Fluxo de Pagamento

1. Criar Pagamento com dados do cartão ou token
2. Capturar (se pré-autorizado) ou processar imediatamente
3. Monitorar via webhooks para atualizações de status
4. Estornar ou gerenciar conforme necessário

​

Recursos da API

​

Processamento de Pagamentos

• Pagamentos com cartão de crédito com captura imediata ou atrasada
• Tokenização de cartão para pagamentos recorrentes seguros
• Pagamentos parcelados com termos flexíveis
• Fluxos de pré-autorização e captura

​

Gestão de Assinaturas

• Cobrança recorrente com múltiplas frequências
• Gestão de planos e atualizações de cobrança
• Gerenciamento do ciclo de vida da assinatura
• Retry automático para pagamentos falhados

​

Segurança e Conformidade

• Conformidade PCI DSS com tokenização de cartão
• Transmissão e armazenamento de dados criptografados
• Prevenção à fraude com pontuação de risco
• Conformidade com regulamentações brasileiras (LGPD)

​

Ferramentas de Integração

• Webhooks abrangentes para notificações em tempo real
• API RESTful com requisições/respostas JSON
• Especificação OpenAPI para integração fácil
• SDKs e bibliotecas (em breve)

​

Limites de Taxa

• Endpoints de pagamento: 60 requisições/minuto
• Saldo da conta: 60 requisições/minuto
• Endpoints de webhook: 120 requisições/minuto
• APIs internas: Limites customizados por integração

​

Tratamento de Erros

{
  "error": 400,
  "message": "Parâmetros de requisição inválidos",
  "details": {
    "field": "purchaseValue",
    "code": "INVALID_AMOUNT"
  }
}

• 200: Sucesso
• 400: Requisição Inválida (parâmetros inválidos)
• 401: Não Autorizado (credenciais inválidas)
• 403: Proibido (permissões insuficientes)
• 404: Não Encontrado (recurso não existe)
• 500: Erro Interno do Servidor

​

Ambientes

​

Cartões para Testes

{
  "holderName": "JOSE DAS NEVES TEST",
  "number": "5383638854408981",
  "cvv": 220,
  "expiration": "12/2024"
}

​

Obtendo Ajuda