Cobrança

Como a Pagar.me v5 modela cobranças a partir de pedidos e assinaturas.

Documentação legada do Pagar.me v5

Esta página descreve um conceito da Pagar.me v5 (versão clássica). Para projetos novos, explore o API Catalog.

A cobrança é sempre a base de um pagamento. Ela é gerada a partir de pedidos ou assinaturas.

1. Cobranças relacionadas a um pedido

Quando um pedido é gerado, automaticamente uma ou mais cobranças são geradas a partir dele.

Exemplo: Quando criado um pedido com um item no valor de R$ 500,00, será criada uma cobrança de R$ 500,00 referente a este pedido.

No caso de multimeios, poderiam ser criadas duas cobranças de R$ 250,00 referentes ao pedido — uma para cada cartão.

2. Cobranças relacionadas a uma assinatura

Ao final de cada ciclo de uma assinatura, é gerada uma cobrança para o assinante.

Exemplo: Ao final do ciclo da assinatura de uma operadora de celular, é gerada uma fatura contendo as informações de consumo do cliente (200 minutos e 3 GB da franquia de internet) no valor de R$ 200,00. A partir dessa fatura, é gerada uma cobrança no valor de R$ 200,00.

Funcionalidades relacionadas à cobrança

  • Alterar o cartão de crédito ou meio de pagamento de uma cobrança não autorizada
  • Pré-autorizar
  • Capturar
  • Cancelar
  • Retentar automaticamente
  • Retentar offline

Status de uma cobrança

StatusDescrição
authorized_pending_captureAutorizada pendente de captura
not_authorizedNão autorizada
capturedCapturada
partial_captureCapturada parcialmente
waiting_captureAguardando captura
refundedEstornada
voidedCancelada
partial_refundedEstornada parcialmente
partial_voidCancelada parcialmente
error_on_voidingErro no cancelamento
error_on_refundingErro no estorno
waiting_cancellationAguardando cancelamento
with_errorCom erro
failedFalha
chargedbackChargeback
Migração para a API Unificada

Na API Unificada Stone, os status foram simplificados para pending · authorized · paid · failed · refunded. Veja POST /v1/charges para a referência completa.


Jornada: Cobrar um cliente
Etapa 2 de 22