Skip to main content

paymentContext

El motivo original del cobro y cómo se inició este intento. La recuperación nunca reemplaza el motivo original. El contexto puede ser null si no se capturó, incluso en reintentos de facturas históricas.

reason

stringEl motivo original, que se conserva entre intentos de pago.

paymentLinkId

string | nullEl ID público del enlace de pago, o null si el cobro no se originó en uno. Es independiente del motivo y de la forma de recuperación.

recovery

object | nullEs null cuando el cobro no recupera una suscripción. payment_recovery identifica la recuperación manual de una suscripción vencida, la vuelta después de una cancelación por impago o el reintento de una reanudación fallida. Reintentar el checkout inicial o un pago único no es recuperación. dunning_retry identifica un reintento automático de cobro, no de entrega del webhook.

recovery.attempt

integerLa posición del reintento de cobro en el calendario de dunning, empezando en 1. El rechazo original no es un reintento. Sólo aparece en dunning_retry.

recovery.maxAttempts

integerEl total de reintentos automáticos aplicable al cobro cuando empezó el intento. No representa los reintentos restantes. Sólo aparece en dunning_retry.
El intento original de cobro, antes de la recuperación.
Primer intento
El cliente recupera una suscripción con un pago vencido. El motivo original del cobro se conserva.
Recuperación manual
El segundo reintento automático de un cobro por reanudación, de cuatro permitidos. El motivo sigue siendo subscription_resume.
Reintentos de dunning
No se capturó el contexto del cobro. No deduzcas el motivo original a partir del estado actual de la suscripción.
Sin contexto

Cuerpo

application/json
id
string
requerido
event
string
requerido
Allowed value: "payment.failed"
timestamp
string
requerido
organizationId
string
requerido
mode
enum<string>
requerido
Opciones disponibles:
live,
sandbox
apiVersion
string
requerido
data
object
requerido

Respuesta

200

Return any 2xx status code to acknowledge receipt of the event.