Lista completa de eventos de webhook relacionados a cobranças, com descrições e exemplos de payload.
| Evento | Descrição |
|---|---|
charge.pending | Cobrança criada e aguardando pagamento |
charge.authorized | Pagamento autorizado pela adquirente |
charge.captured | Pagamento capturado com sucesso |
charge.partially_refunded | Estorno parcial realizado |
charge.refunded | Estorno total realizado |
charge.voided | Cobrança cancelada antes da captura |
charge.failed | Pagamento recusado ou falhou |
charge.expired | Cobrança expirou sem pagamento (PIX, boleto ou sessão Apple Pay) |
charge.chargeback | Contestação (chargeback) recebida |
charge.pendingDisparado quando uma cobrança é criada com método de pagamento assíncrono (PIX, boleto ou carteira digital hospedada) e aguarda o pagamento do cliente.
charge.authorizedDisparado quando o pagamento com cartão é autorizado pela adquirente, antes da captura.
charge.capturedDisparado quando o pagamento é capturado com sucesso. Para PIX, boleto e carteiras digitais, isso ocorre quando o pagamento é confirmado. Para cartão, quando a captura é processada.
charge.partially_refundedDisparado quando um estorno parcial é realizado (valor menor que o total da cobrança).
charge.refundedDisparado quando um estorno total é realizado.
charge.voidedDisparado quando uma cobrança autorizada é cancelada antes da captura.
charge.failedDisparado quando o pagamento é recusado pela adquirente ou ocorre um erro no processamento.
charge.expiredDisparado quando uma cobrança com PIX, boleto ou sessão Apple Pay expira sem pagamento. Para Apple Pay, o evento é emitido depois que a expiração for confirmada.
charge.chargebackDisparado quando uma contestação (chargeback) é registrada pela bandeira do cartão.
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"event": "charge.captured",
"charge": {
"id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
"external_id": "ext-abc-123",
"merchant_id": "m1e2r3c4-h5a6-7890-ntid-000000000001",
"payment_link_id": null,
"status": "captured",
"amount": 10000,
"shipping_amount": 0,
"total_amount": 10000,
"currency": "BRL",
"payment_method": "credit_card",
"installments": 1,
"payment_fields": {
"payment_method": "credit_card",
"brand": "visa",
"last_four_digits": "1234",
"first_six_digits": "411111",
"holder_name": "JOAO SILVA"
},
"customer": {
"name": "Joao Silva",
"email": "joao@exemplo.com",
"tax_id": "12345678900",
"phone": "11999999999",
"type": "individual"
},
"metadata": {
"order_id": "ABC-123"
},
"captured_at": "2026-02-24T10:00:00.000Z",
"refunded_at": null,
"error_message": null,
"created_at": "2026-02-24T09:55:00.000Z",
"updated_at": "2026-02-24T10:00:00.000Z"
},
"occurred_at": "2026-02-24T10:00:00.000Z"
}charge| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único da cobrança |
external_id | string | null | ID externo na adquirente |
merchant_id | string | ID do merchant proprietário |
payment_link_id | string | null | ID do link de pagamento que originou a cobrança (se aplicável) |
status | string | Status atual da cobrança |
amount | number | Valor da cobrança em centavos |
shipping_amount | number | Valor do frete em centavos |
total_amount | number | Valor total em centavos (amount + shipping) |
currency | string | Moeda (ex: BRL) |
payment_method | string | Método de pagamento (credit_card, debit_card, pix, boleto ou apple_pay; google_pay permanece reservado) |
installments | number | Número de parcelas |
payment_fields | object | null | Dados específicos do método de pagamento |
customer | object | null | Dados do cliente |
metadata | object | null | Metadados customizados |
captured_at | string | null | Data/hora da captura (ISO 8601) |
refunded_at | string | null | Data/hora do estorno (ISO 8601) |
error_message | string | null | Mensagem de erro (se falhou) |
created_at | string | Data/hora da criação (ISO 8601) |
updated_at | string | Data/hora da última atualização (ISO 8601) |