Link de Pagamento Pontual
Este caso de uso descreve como um vendedor cria um link de pagamento único (pontual) para cobrança de um valor específico, que pode ser pago uma única vez pelo comprador.
Atores
Vendedor (Seller): Sistema integrador
Comprador (Buyer): Pessoa que realizará o pagamento
Barte API: Responsável pela criação do link e processamento do pagamento
Pré-condições
O vendedor possui um Token de API válido
O pagamento será realizado via Link de Pagamento
O Buyer é opcional neste fluxo
Fluxo Principal
1. Obter o Token de API
Antes de realizar qualquer chamada, é necessário obter o Token de API.
Todas as requisições devem conter o header:
X-Token-Api: YOUR_API_KEY📌 Referência: Obtendo o Token de API
2. Criar um Comprador (Buyer) — Opcional
O vendedor pode criar previamente um Buyer para associá-lo ao link de pagamento.
Quando usar esta etapa
O vendedor já possui os dados do comprador
Deseja facilitar o checkout
Precisa de maior controle de conciliação ou antifraude
Quando não usar
O link será enviado de forma aberta (WhatsApp, e-mail, redes sociais)
O comprador informará seus dados diretamente no checkout
📌 Importante Caso o Buyer não seja criado, os dados do comprador serão coletados diretamente no checkout do link de pagamento.
📌 Referência: Criando um Comprador
3. Criar o Link de Pagamento
O vendedor cria um link de pagamento pontual.
O que acontece
Um link único é gerado
O link pode ser compartilhado com o comprador
Nenhum pagamento ocorre neste momento
📌 Caso um uuidBuyer seja informado:
O checkout pode vir pré-preenchido
O pagamento será associado diretamente ao Buyer informado
📌 Caso não seja informado:
O comprador deverá preencher seus dados no checkout
📌 Referência: Link de Pagamento Pontual
4. Pagamento pelo Comprador
O comprador acessa o link de pagamento e realiza o pagamento.
O que acontece
O comprador informa seus dados (caso não existam)
O pagamento é processado
Uma order e uma ou mais charges são criadas
Resultado esperado:
Pedido criado com sucesso
Status da charge conforme método de pagamento (PAID, PENDING, FAILED, etc.)
Pós-condições
Ao final deste caso de uso, o vendedor consegue:
Criar um link de pagamento pontual
Opcionalmente associar um Buyer
Permitir que o comprador pague via checkout hospedado
Acompanhar o status do pedido e da cobrança
Realizar ações pós-pagamento (estorno, conciliação, suporte)
Observações Importantes
O Buyer é opcional no link de pagamento
Caso não informado, os dados do comprador serão coletados no checkout
O link pode ser reutilizado ou expirado conforme configuração
A cobrança sempre ocorre no nível da charge
Last updated
Was this helpful?