Regenerar o boleto de um pagamento

curl -X POST "https://api.chargefy.io/v1/payment-intents/pi_JgEJanPt14Dbs46f/regenerate_boleto" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "pi_JgEJanPt14Dbs46f",
  "object": "payment_intent",
  "...": "outros campos do DTO",
  "amount": 14990,
  "currency": "brl",
  "latest_charge": "ch_YFvU8E5yMkDgQ74c",
  "next_action": {
    "boleto_display_details": {
      "barcode": "23791966600000149903381286008296100211202300",
      "expires_at": "2026-06-01",
      "hosted_voucher_url": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf",
      "number": "23793.38128 60082.961002 11202.300008 1 96660000014990",
      "pdf": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf"
    },
    "type": "boleto_display_details"
  },
  "payment_method_types": [
    "boleto"
  ],
  "status": "pending"
}

{
  "error": {
    "code": "resource_state_conflict",
    "message": "Cannot regenerate a boleto in status succeeded",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "regenerate_boleto only applies to boleto payment intents",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "rate_limit",
    "message": "Boleto regenerated too recently; try again later",
    "type": "rate_limit_error"
  }
}

{
  "error": {
    "code": "payment_result_unconfirmed",
    "message": "The payment result is not confirmed yet. Do not submit the operation again.",
    "type": "api_error"
  }
}

Emite um boleto novo depois que a tentativa anterior terminou — mesma PI, mesmo client_secret, novo latest_charge, novo next_action.boleto_display_details. Quando um boleto vence sem pagamento, o intent volta a requires_payment_method — a tentativa acabou, o intent não — e esta ação inicia a próxima tentativa. Um boleto ainda ativo não é reemitido, porque o cancelamento bancário é assíncrono e os dois documentos poderiam ficar pagáveis ao mesmo tempo.

Restrições

O payment_intent precisa ter payment_method: "boleto" e estar em status: "requires_payment_method" — o estado em que um boleto vencido deixa o intent. Intents que terminaram em failed ou canceled também são aceitos e voltam ao fluxo com o boleto novo.
1 reemissão por hora por Payment Intent. Chamadas mais frequentes retornam 429.
Sem limite total de reemissões — pode chamar quantas vezes precisar, respeitando o limite de frequência.

Parâmetros de caminho

string

required

ID do payment intent (pi_*).

Attributes

string

Nova data de vencimento no formato YYYY-MM-DD. Default: hoje + 3 dias.

curl -X POST "https://api.chargefy.io/v1/payment-intents/pi_JgEJanPt14Dbs46f/regenerate_boleto" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

Retorna o payment_intent atualizado com o novo next_action. O campo regenerated_at é atualizado para o momento da chamada.

{
  "id": "pi_JgEJanPt14Dbs46f",
  "object": "payment_intent",
  "...": "outros campos do DTO",
  "amount": 14990,
  "currency": "brl",
  "latest_charge": "ch_YFvU8E5yMkDgQ74c",
  "next_action": {
    "boleto_display_details": {
      "barcode": "23791966600000149903381286008296100211202300",
      "expires_at": "2026-06-01",
      "hosted_voucher_url": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf",
      "number": "23793.38128 60082.961002 11202.300008 1 96660000014990",
      "pdf": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf"
    },
    "type": "boleto_display_details"
  },
  "payment_method_types": [
    "boleto"
  ],
  "status": "pending"
}

{
  "error": {
    "code": "resource_state_conflict",
    "message": "Cannot regenerate a boleto in status succeeded",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "regenerate_boleto only applies to boleto payment intents",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "rate_limit",
    "message": "Boleto regenerated too recently; try again later",
    "type": "rate_limit_error"
  }
}

{
  "error": {
    "code": "payment_result_unconfirmed",
    "message": "The payment result is not confirmed yet. Do not submit the operation again.",
    "type": "api_error"
  }
}

Efeitos colaterais

A tentativa anterior já é terminal antes da reemissão; a ação nunca mantém dois boletos potencialmente pagáveis.
A expiração automática agendada do boleto antigo é cancelada e uma nova é agendada para o novo expires_at.
Eventos emitidos: charge.updated (nova charge) + payment.intent.updated.

Erros comuns

Status	`code`	Quando ocorre
`409`	`resource_state_conflict`	PI ainda tem um boleto ativo, já foi pago, ou ainda está em `requires_*`.
`422`	`invalid_request`	PI não é boleto, ou customer/buyer ausente.
`429`	`rate_limit`	Chamada feita menos de 1h depois da última reemissão.
`400`–`409`	código específico da falha	A emissão foi recusada de forma definitiva; a resposta usa o código estável correspondente da tabela de erros.
`502`	`payment_result_unconfirmed`	A solicitação pode ter sido recebida, mas a resposta se perdeu. Não repita a operação; consulte o Payment Intent e aguarde os webhooks.
`503`	`processing_error`	O provedor devolveu uma falha ainda não classificada. Ela é registrada e exibida, nunca tratada como sucesso.

Fluxo de boleto

Emissão, vencimento, expiração e eventos.

Objeto Payment Intent

Campos de next_action.boleto_display_details e timestamps.

curl -X POST "https://api.chargefy.io/v1/payment-intents/pi_JgEJanPt14Dbs46f/regenerate_boleto" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "pi_JgEJanPt14Dbs46f",
  "object": "payment_intent",
  "...": "outros campos do DTO",
  "amount": 14990,
  "currency": "brl",
  "latest_charge": "ch_YFvU8E5yMkDgQ74c",
  "next_action": {
    "boleto_display_details": {
      "barcode": "23791966600000149903381286008296100211202300",
      "expires_at": "2026-06-01",
      "hosted_voucher_url": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf",
      "number": "23793.38128 60082.961002 11202.300008 1 96660000014990",
      "pdf": "https://billing.chargefy.io/boletos/pi_t34FAxE3ZUBq5i78.pdf"
    },
    "type": "boleto_display_details"
  },
  "payment_method_types": [
    "boleto"
  ],
  "status": "pending"
}

{
  "error": {
    "code": "resource_state_conflict",
    "message": "Cannot regenerate a boleto in status succeeded",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "regenerate_boleto only applies to boleto payment intents",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "rate_limit",
    "message": "Boleto regenerated too recently; try again later",
    "type": "rate_limit_error"
  }
}

{
  "error": {
    "code": "payment_result_unconfirmed",
    "message": "The payment result is not confirmed yet. Do not submit the operation again.",
    "type": "api_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Regenerar o boleto de um pagamento

Restrições

Parâmetros de caminho

Attributes

Resposta

Efeitos colaterais

Erros comuns

Fluxo de boleto

Objeto Payment Intent

​Restrições

​Parâmetros de caminho

​Attributes

​Resposta

​Efeitos colaterais

​Erros comuns

Fluxo de boleto

Objeto Payment Intent

Restrições

Parâmetros de caminho

Attributes

Resposta

Efeitos colaterais

Erros comuns