Payload

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

paymentTransactionIdstring

The refunded payment transaction ID.

invoiceIdstring | null

The invoice the payment collected, or null for payments without an invoice.

invoiceNumberstring | null

The human-readable invoice number, if available.

customerIdstring | null

The customer ID, when the payment is linked to an invoice. Returns your externalId if you provided one when creating the customer, otherwise returns the Commet publicId.

subscriptionIdstring | null

The subscription ID, if the invoice is linked to a subscription.

refundAmountnumber

The refunded amount in cents (100 = $1.00).

currencystring

The refund currency code.

{
  "event": "payment.refunded",
  "timestamp": "2026-04-28T16:40:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "paymentTransactionId": "ptx_q7r8s9",
    "invoiceId": "inv_n4o5p6",
    "invoiceNumber": "INV-0043",
    "customerId": "user_123",
    "subscriptionId": "sub_1a2b3c4d",
    "refundAmount": 9900,
    "currency": "usd"
  }
}

Cuándo se dispara

Cuando se emite un reembolso para un pago — total o parcial — y el proveedor de pagos lo confirma. Un reembolso total de un recibo de suscripción también cancela la suscripción de inmediato (subscription.canceled se dispara con motivo refund); un reembolso parcial deja la suscripción intacta.

refundAmount es el monto reembolsado en centavos (100 = $1.00). Los campos del recibo son null para pagos que no estaban asociados a un recibo.

Úsalo para reflejar el reembolso en tu propia contabilidad o para notificar al cliente a través de tus canales.