Skip to main content
Cobranças positivas precisam satisfazer o mínimo do plano efetivo e do método. Um valor insuficiente retorna amount_too_small antes do processamento e não autoriza repetição automática. Veja mínimos e tratamento do erro.
Cria uma tentativa de pagamento para uma invoice open vinculada a uma subscription. A resposta retorna a invoice completa já apontando para o payment_intent criado. O resultado final da cobrança chega pelos eventos payment.intent.* e invoice.*. Use este endpoint para cobrança server-to-server de invoices de assinatura. Para uma invoice avulsa, compartilhe hosted_invoice_url; a página hospedada cria a tentativa de pagamento a partir do método escolhido pelo cliente. Se o cliente já pagou por fora, envie paid_out_of_band: true para registrar o pagamento sem cobrá-lo. Veja pagamento recebido fora da Chargefy.
string
obrigatório
ID da invoice (inv_*).
string
Payment method salvo (pm_*) para esta tentativa. Quando omitido, a Chargefy resolve o método na ordem: default_payment_method da invoice, default_payment_method da subscription, e default_payment_method do customer. Não pode ser combinado com paid_out_of_band.
boolean
padrão:"false"
Quando true, marca a invoice como paga sem cobrar o cliente. Use quando o valor foi recebido fora da Chargefy. Veja pagamento recebido fora da Chargefy.
Quando uma tentativa desta invoice já levou uma recusa definitiva — um motivo marcado como “não repita com o mesmo cartão” no catálogo de recusas — recobrar com o mesmo cartão é recusado com 402, devolvendo o code da recusa original (card_declined quando a tentativa bloqueante não registrou um código). Envie outro payment_method ou cadastre um novo método para o customer; com um cartão diferente a tentativa segue normalmente.

Pagamento recebido fora da Chargefy

Quando o cliente paga por fora, como em dinheiro em espécie ou por transferência direta para a conta da sua organização, envie paid_out_of_band: true. A invoice passa a paid sem nenhuma cobrança ao cliente. Isso vale para qualquer invoice open, inclusive avulsa. O que acontece:
  • A invoice fica paid, com paid_out_of_band: true, amount_paid igual a amount_due e amount_remaining zerado. Multa e juros por atraso não são calculados: o valor combinado fora da Chargefy é assunto entre você e o cliente.
  • O payment_intent da invoice é cancelado com cancellation_reason: "automatic", e as retentativas e lembretes agendados param.
  • Se a invoice pertence a uma subscription past_due ou unpaid, a subscription volta a active, igual a uma invoice paga pela Chargefy.
  • Os eventos invoice.paid, payment.intent.canceled e, quando o status muda, subscription.updated são entregues normalmente.
  • Nenhuma transação, taxa ou repasse é gerado. O valor não entra no seu saldo na Chargefy.
Se uma tentativa de pagamento da invoice ainda está em processamento, a chamada retorna 409: essa tentativa ainda pode ser concluída, e marcar a invoice por fora cobraria o cliente duas vezes. Aguarde o resultado pelos eventos payment.intent.* e tente de novo se a tentativa falhar.