Skip to main content

Visão Geral (PIX OUT)

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

A API Transaction permite processar saques de forma simples e segura. Com uma única requisição, você envia fundos via PIX da sua conta para o cliente ou parceiro 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: /withdraw

  • Autenticação:

    • Bearer token no header Authorization

  • Notificações: Configure uma URL HTTPS em webhookUrl para receber atualizações de sobre o status do saque

Recursos Principais​

  1. Multi-tenancy

    • Isolamento completo por tenant
    • Configurações específicas por tenant
    • Gerenciamento independente do saque

  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 Saque

    POST /withdraw
    Authorization: Bearer <seu-token>

  2. Resposta

     {
       "id": "550e8400-e29b-41d4-a716-446655440000",
       "externalCode": "SAQUE-123",
       "amount": 1000,
       "status": "PENDING"
     }

  3. Acompanhar Status

    • Via webhook (recomendado)

Estados do saque​

  • PENDING: Saque criada (validando ou aguardando aprovação)
  • PROCESSING: Saque em processando
  • PROCESSED: Envio de fundos confirmado
  • CANCELED: Saque cancelado
  • REFUNDED: Estorno do saque
  • REJECTED: Saque rejeitado pela gateway

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. 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 transferência PIX
  2. Configurar webhooks para notificações
  3. Implementar tratamento de erros

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