circle-dollarPedido com Pré-captura

Este caso de uso descreve como um vendedor cria um pedido com cartão de crédito utilizando pré-captura, ou seja, o valor é apenas autorizado no cartão do comprador e capturado posteriormente, conforme


Atores

  • Vendedor (Seller): Sistema integrador

  • Comprador (Buyer): Pessoa que realizará o pagamento

  • Barte API: Responsável pela autorização, captura e pós-pagamento


Pré-condições

  • O vendedor possui um Token de API válido

  • O Buyer é obrigatório e deve ser criado previamente

  • O pagamento será realizado via Cartão de Crédito

  • O pedido será criado com pré-captura (capture = false)


Fluxo Principal

1. Autenticação na API

Todas as requisições devem conter o Token de API no header:

📌 Referência: Obtendo o Token de API


2. Criar um Comprador (Buyer) — Obrigatório

O Buyer representa o pagador e é obrigatório para a criação de pedidos.

Objetivo

  • Identificar corretamente o comprador

  • Suportar antifraude, conciliação e pós-pagamento

Resultado esperado

  • A API retorna o uuid do Buyer

📌 Esse uuid será utilizado obrigatoriamente na criação do pedido.

📌 Referência: Criando um Comprador


3. Criar um Pedido com Pré-captura

Com o Buyer criado, o vendedor cria o pedido configurado para pré-captura.

Configuração importante

  • capture = false → o valor será somente autorizado

  • Nenhum valor é debitado neste momento

O que acontece

  • O cartão é validado

  • O valor é autorizado pelo emissor

  • Uma charge é criada com status PRE_AUTHORIZED

Resultado esperado

  • Pedido criado com sucesso

  • Uma ou mais charges associadas

  • Status da charge: PRE_AUTHORIZED

📌 O uuid da charge será necessário para capturar ou cancelar a autorização.

📌 Referência: Pedido com Pré-captura


Fluxos Alternativos

4. Capturar Cobrança (Charge)

Após a pré-autorização, o vendedor decide capturar o valor.

Quando usar

  • Produto enviado

  • Serviço prestado

  • Confirmação manual ou automática do vendedor

Regras importantes

  • A captura ocorre sempre no nível da charge

  • Uma order pode conter mais de uma charge

  • Se a charge não for capturada em até 6 dias, ela será cancelada automaticamente

Resultado esperado

  • Status da charge passa para PAID

  • O valor é efetivamente debitado do cartão

📌 Referência: 2. Capturar cobrança (Charge)


5. Cancelar Pré-captura

Permite cancelar uma cobrança antes da captura, sem gerar estorno.

Quando usar

  • A venda não será concluída

  • O status da charge ainda é PRE_AUTHORIZED

Importante

  • Este endpoint não deve ser usado após a captura

  • Não há estorno, pois o valor ainda não foi debitado

Resultado esperado

  • A autorização é cancelada

  • O valor é liberado no cartão do comprador

📌 Referência: 3. Cancelar pré-captura


Fluxos Pós-Captura

Após a captura (PAID), entram os fluxos padrão de pós-pagamento.


6.1 Estorno Total

Realiza o estorno completo do valor capturado.

📌 Referência: Estorno Total de um Pedido


6.2 Estorno Parcial

Realiza o estorno de parte do valor capturado.

📌 Referência: Estorno Cobrança (Parcial)


Pós-condições

Ao final deste caso de uso, o vendedor consegue:

  • Autenticar-se na API

  • Criar obrigatoriamente um Buyer

  • Criar um pedido com cartão de crédito e pré-captura

  • Capturar ou cancelar a cobrança conforme decisão de negócio

  • Realizar estornos após a captura, quando necessário


Observações Importantes

  • Buyer é obrigatório

  • Pré-captura não debita o valor

  • Cancelamento de pré-captura não é estorno

  • A captura sempre ocorre no nível da charge

Last updated

Was this helpful?