Events
payment.received
Fired when a payment settles successfully, including initial charges, renewals and recovery attempts
paymentContext
The original reason for a charge and how this attempt was initiated. Recovery never replaces the original reason. Context can be null when it was not captured, including retries of historical invoices.Fields and payment reasons
Fields and payment reasons
reason
stringThe original reason, preserved across payment attempts.paymentLinkId
string | nullThe public payment link ID, or null when the charge did not originate from a payment link. This is independent of the reason and recovery method.recovery
object | nullNull when the charge does not recover a subscription. payment_recovery identifies a manually recovered overdue subscription, a return after cancellation for non-payment, or a retry of a failed subscription resume. Initial checkout and one-time payment retries are not recovery. dunning_retry identifies an automatic charge retry, not a webhook delivery retry.recovery.attempt
integerThe charge retry position in the dunning schedule, starting at 1. The original failed charge is not a retry. Present only for dunning_retry.recovery.maxAttempts
integerThe total automatic retries applicable to this charge when the attempt began. It is not the number of retries remaining. Present only for dunning_retry.Initial attempt
Initial attempt
The original charge attempt, before recovery.
Initial attempt
Manual recovery
Manual recovery
The customer recovers an overdue subscription. The original charge reason is preserved.
Manual recovery
Dunning retries
Dunning retries
The second automatic retry of a subscription resume charge, out of four allowed retries. The reason remains subscription_resume.
Dunning retries
No context
No context
The charge context was not captured. Do not infer the original reason from the subscription’s current state.
No context
paymentMethod identifies the method used for this charge, independently of provider. It is null when the payment attempt has no known method, and does not change when the customer updates their saved method later.
subPaymentMethod is the source of funds reported for this charge, such as account_money or credit_card within Mercado Pago. It is null when unavailable or unknown.Body
application/json
Response
200
Return any 2xx status code to acknowledge receipt of the event.