V2
Confirmação de Pagamento – API
Endpoint
**/v2/paid/{billing_number}**Quando usar este endpoint?
Identificação da Cobrança
billing_number ou integration_identifier informado na URL:/v2/paid/123456Corpo da Requisição (JSON)
Campos Aceitos
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
paid_amount | number | Não | Valor efetivamente pago. Caso não informado, será utilizado o valor original da cobrança. |
discount_amount | number | Não | Valor de desconto concedido, se houver. |
paid_at | string | Não | Data do pagamento no formato ISO (YYYY-MM-DD). Se não informado, será usada a data atual. |
Exemplo de Body
{
"paid_amount": 1500,
"discount_amount": 100,
"paid_at": "2025-01-12"
}Como funciona o processamento
1.
2.
3.
4.
5.
Respostas Possíveis
✅ 200 – Sucesso
{
"message": "Billing successfully paid."
}❌ 404 – Cobrança não encontrada
{
"message": "Billing not found."
}❌ 409 – Cobrança não pode ser alterada
{
"message": "Billing can not be modified.",
"metadata": {
"status": "paid"
}
}❌ 400 – Erro ao registrar pagamento
{
"message": "Billing not set as paid, try again in a few moments"
}❌ 500 – Erro interno
{
"message": "Problems updating billing. Try again in a few moments."
}Exemplo Completo de Requisição