Visão Geral (PIX IN)

Siga os passos abaixo para criar transações PIX IN via API

A API Transaction permite processar pagamentos PIX de forma simples e segura. Com uma única requisição, você recebe um QR Code PIX e toda a infraestrutura necessária para gerenciar o ciclo de vida da transação.

Como funciona:

• Base URL: https://transaction.cashtime.com.br

• Método: POST

• Endpoint: /transaction

• Autenticação:

  • Bearer token no header Authorization

• Notificações: Configure uma URL HTTPS em webhookUrl para receber atualizações de sobre o status da transação

Recursos Principais

1. Multi-tenancy

   • Isolamento completo por tenant
   • Configurações específicas por tenant
   • Gerenciamento independente de transações

2. Segurança

   • Autenticação via Bearer token
   • Controle granular de permissões
   • Validação de permissões/autorizações e capacidades

3. Flexibilidade

   • Suporte a produtos físicos e digitais
   • Metadados customizáveis

Fluxo Básico

1. Solicitar Transação

   POST /transaction
   Authorization: Bearer <seu-token>

2. Resposta

    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "550e8400-e29b-41d4-a716-446655440000",
      "amount": 1000,
      "status": "PIX_QRCODE_GENERATED",
      "pix": {
        "uri": "00020126580014br.gov.bcb.pix0136123e4567-e89b-12d3-a456-426614174000",
        "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
        "expirationDate": "2025-10-31T14:18:03.090Z"
      }
    }

3. Acompanhar Status

   • Via webhook (recomendado)
   • Via consulta GET /transaction/{id}

Estados da Transação

• PENDING: Transação criada, processando
• PIX_QRCODE_GENERATED: QR Code gerado, aguardando pagamento
• PAID: Pagamento confirmado
• INFRACTION: Estorno ou Infração do pagamento

Boas Práticas

1. Sempre configure um webhook

   • URL HTTPS válida
   • Endpoint preparado para receber notificações
   • Tratamento de retry em caso de falhas

2. Valide os dados do cliente

   • CPF/CNPJ válidos
   • E-mail em formato correto
   • Telefone no formato brasileiro

3. Produtos Físicos

   • Configure isInfoProduct: false
   • Forneça endereço completo
   • Valide o CEP

4. Produtos Digitais

   • Configure isInfoProduct: true
   • Endereço é opcional
   • Ideal para serviços e conteúdo digital

5. Tratamento de Erros

   • Implemente retry para falhas temporárias
   • Monitore as métricas de erro
   • Mantenha logs detalhados

Próximos Passos

1. Criar sua primeira transação PIX
2. Configurar webhooks para notificações
3. Implementar tratamento de erros
4. Consultar detalhes de uma transação

Para mais detalhes sobre cada endpoint e exemplos completos, consulte nossa documentação específica de endpoints.