We also explain how you can:<\/p>\n
- \n
- Send a payment link<\/a> when the Auto Rescue process ends unsuccessfully.<\/li>\n
- Cancel the Auto Rescue process<\/a> for a payment.<\/li>\n
- Test how your integration handles Auto Rescue updates<\/a>.<\/li>\n
- Reconcile retry attempts in Adyen-generated reports<\/a>.<\/li>\n<\/ul>\n
How it works<\/h2>\n
![\"\"](\"\/user\/pages\/docs\/02.online-payments\/23.auto-rescue\/01.cards\/autorescue-cards.svg?decoding=auto&fetchpriority=auto\")
<\/p>\nStep 1: Enable Auto Rescue<\/h2>\n
You can enable Auto Rescue at either:<\/p>\n
- \n
- Account level<\/a>: Auto Rescue is used on all eligible payments.<\/li>\n
- Transaction level<\/a>: You choose when Auto Rescue can be used for a payment, using the
autoRescue<\/code> flag.<\/li>\n<\/ul>\nEnable at account level<\/h3>\n
To enable Auto Rescue for all payments, contact our Support Team<\/a> or your Adyen Account Manager.<\/p>\n
When enabled, Auto Rescue works for payments that have:<\/p>\n
- \n
- The
shopperInteraction<\/code> ContAuth<\/strong>.<\/li>\n- A
value<\/code> greater than 0<\/strong>.<\/li>\n<\/ul>\n\nIf you enable Auto Rescue at account level, a rescue window of one calendar month is used. If you prefer to use another rescue window you need to enable Auto Rescue at the transaction level<\/a>.<\/p>\n<\/div>\n
You receive updates to the Auto Rescue process<\/a> in webhook events.<\/p>\n
Enable at transaction level<\/h3>\n
To enable Auto Rescue on a transaction level, you need to:<\/p>\n
- \n
- Contact our Support Team<\/a> or your Adyen Account Manager to configure this for you.<\/li>\n
- Add the
autoRescue<\/code> flag to your payment request to enable Auto Rescue for that transaction.<\/li>\n- In the payment request, provide a unique
merchantOrderReference<\/code>. This should represent a specific billing cycle or subscription, and will appear in any Auto Rescue updates<\/a> or reports<\/a>.<\/li>\n<\/ol>\n\nWith
merchantOrderReference<\/code> you can connect any Auto Rescue retry attempts to a payment request.<\/p>\n<\/div>\nTo enable Auto Rescue for a transaction:<\/p>\n
- \n
- \n
Make a payment request, and additionally specify:<\/p>\n
- \n
- shopperInteraction<\/a>: ContAuth<\/strong><\/li>\n
autoRescue<\/code>:\u00a0true<\/strong><\/li>\nmaxDaysToRescue<\/code>: The rescue window, in days. You can specify between\u00a01<\/strong>\u00a0and\u00a048<\/strong> days. We recommend using a rescue window of one calendar month (30<\/strong> days).<\/li>\n- reference<\/a>: Your unique reference for this\u00a0payment request.<\/li>\n
- merchantOrderReference<\/a>: Your unique order reference. For example, a concatenation of a unique shopper reference and the transaction date.<\/li>\n<\/ul>\n
The example below shows how to enable Auto Rescue for a shopper-not-present payment submitted to the \/payments<\/a> endpoint. If this payment is Refused<\/strong>, Auto Rescue will automatically retry this payment for a maximum of 40<\/strong> days.<\/p>\n
\n<\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n <\/a><\/p>\n
- \n
- \n
You receive a payment response. If the payment is refused, this contains:<\/p>\n
- \n
- \n
resultCode<\/code>:\u00a0Refused<\/strong><\/p>\n<\/li>\n- \n
refusalReason<\/code>: The reason the payment was refused. For more information, see Refusal reasons<\/a>.<\/p>\n<\/li>\n- \n
retry.rescueScheduled<\/code>:\u00a0Indicates whether Auto Rescue will try to rescue the payment:<\/p>\n- \n
- true<\/strong>: Auto Rescue will<\/em> try to rescue the payment. You receive updates on the rescue process<\/a> in webhook events.<\/li>\n
- false<\/strong>: Auto Rescue will not<\/em> try to rescue the payment. This happens when a payment cannot be rescued. For example, because of account closure or fraud.<\/li>\n<\/ul>\n<\/li>\n
- \n
retry.rescueReference<\/code>: Unique Auto Rescue reference for this payment.
\nYou can use this to cancel the Auto Rescue process<\/a> if, for example, the shopper provides you with a new payment details, or cancels their subscription.<\/p>\n<\/li>\n<\/ul>\nThe example response below is for a payment that was Refused<\/strong>. In this response,
retry.rescueScheduled<\/code> is set to true<\/strong>, indicating that Auto Rescue will<\/em> attempt to rescue this payment.<\/p>\n\n<\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n You receive updates to the Auto Rescue process<\/a> in webhook events.<\/p>\n
Step 2: Receive Auto Rescue updates<\/h2>\n
To update you on the Auto Rescue process, we send you webhook events<\/a>. We send you a webhook event when:<\/p>\n
- \n
- A retry attempt was made, and it was:\n
- \n
- Successful<\/a>.<\/li>\n
- Unsuccessful<\/a>.<\/li>\n<\/ul><\/li>\n
- The rescue process ended<\/a>, either because the payment was rescued, or the Auto Rescue process was unsuccessful.<\/li>\n<\/ul>\n
\nBefore using Auto Rescue for live payments, we recommend that you test how your integration handles these webhook events<\/a>.<\/p>\n<\/div>\n
Retry attempt successful<\/h3>\n
If a retry attempt is successful, you receive a webhook event with:<\/p>\n
- \n
eventCode<\/code>: AUTHORISATION<\/strong><\/li>\neventDate<\/code>: The date of the retry attempt.<\/li>\nsuccess<\/code>: true<\/strong><\/li>\npspReference<\/code>: Adyen's unique reference for the successful retry attempt.<\/li>\nmerchantOrderReference<\/code>: Unique order reference that you provided in the payment request<\/a>.<\/li>\n<\/ul>\nThe example below is for a retry attempt that was successful.<\/p>\n
\n<\/code-sample>\n<\/div>\n You can view how much revenue has been recovered with Auto Rescue in your Customer Area<\/a>, under Reports<\/strong>. Search for the RevenueAccelerate<\/strong> report.<\/p>\n
\nIf you use manual capture, you need to capture<\/a> each rescued payment to transfer it to your account.<\/p>\n<\/div>\n
Retry attempt unsuccessful<\/h3>\n
If a retry attempt is unsuccessful, you receive a webhook event with:<\/p>\n
- \n
eventCode<\/code>:\u00a0AUTHORISATION<\/strong><\/li>\neventDate<\/code>: The date of the retry attempt.<\/li>\nsuccess<\/code>: false<\/strong><\/li>\nmerchantOrderReference<\/code>:\u00a0Unique order reference that you provided in the payment request<\/a>.<\/li>\nretry.rescueScheduled<\/code>: Indicates whether Auto Rescue will attempt the payment again:\n- \n
- true<\/strong>:\u00a0Another retry attempt has been scheduled.\u00a0<\/li>\n
- false<\/strong>: We are unable to schedule another retry attempt<\/a>.
\nThis usually happens when you have reached the maximum number of retries.<\/li>\n<\/ul><\/li>\n<\/ul>\nThe example below is for a retry attempt that was unsuccessful (
success<\/code> is false<\/strong>). Another retry attempt has been scheduled (retry.rescueScheduled<\/code> is true<\/strong>).<\/p>\n\n<\/code-sample>\n<\/div>\n Rescue process ended<\/h3>\n
When the Auto Rescue process ends we send you a webhook event with:<\/p>\n
- \n
eventCode<\/code>:\u00a0AUTORESCUE<\/strong>.<\/li>\neventDate<\/code>: The date that the rescue process started.<\/li>\nsuccess<\/code>: Indicates whether the rescue process was successful:\n- \n
- true<\/strong>: The rescue process was successful.<\/li>\n
- false<\/strong>: The rescue process was unsuccessful.<\/li>\n<\/ul><\/li>\n
merchantOrderReference<\/code>: Unique order reference you provided in the payment request.<\/li>\nreason<\/code>: If the rescue process was unsuccessful, this indicates why the payment could not be rescued:\n- \n
retryWindowHasElapsed<\/code>: The rescue window expired.<\/li>\nmaxRetryAttemptsReached<\/code>: The maximum number of retry attempts was made.<\/li>\nfraudDecline<\/code>: The retry was rejected due to fraud.<\/li>\ninternalError<\/code>: An internal error occurred while retrying the payment.<\/li>\n<\/ul><\/li>\n<\/ul>\nThe example below is a webhook event indicating that a payment could not be rescued. This is because the maximum number of retries has been reached (
reason<\/code> is maxRetryAttemptsReached<\/strong>).<\/p>\n\n<\/code-sample>\n<\/div>\n Send a payment link<\/h2>\n
In case the Auto Rescue process ended unsuccessfully, you can optionally use Pay by Link<\/a> to send the shopper a payment link so they can still proceed with the payment, for example, using other payment method.<\/p>\n
To activate Pay by Link for Auto Rescue, contact our Support Team<\/a>.<\/p>\n
After we activate the feature, you will receive additional data fields in the Auto Rescue process end webhook:<\/p>\n
- \n
- paymentLink.url<\/a> \u2014 The URL where the shopper can complete the payment. Valid for 5 days.<\/li>\n
- paymentLink.expiresAt<\/a> \u2014 The date when the payment link expires, in ISO 8601<\/a> format. For example,
2019-11-23T12:25:28Z<\/code> or2020-05-27T20:25:28+08:00<\/code>.<\/li>\n<\/ul>\n\n<\/code-sample>\n<\/div>\n When the shopper has paid with Pay by Link, you receive an AUTHORISATION<\/a> webhook event with:<\/p>\n
- \n
shopperReference<\/code>: The payment details used by the shopper.<\/li>\nstoredPaymentMethodId<\/code>: The token you can use for the next subscription renewal. For more information, refer to Tokenization<\/a>.<\/li>\n<\/ul>\nCancel Auto Rescue<\/h2>\n
While a payment is in the Auto Rescue process, your shopper may provide you with a new payment method, or cancel their subscription. In these scenarios, you should cancel the Auto Rescue process for the refused payment.<\/p>\n
To cancel the Auto Rescue process:<\/p>\n
- \n
- \n
Make a\u00a0\/cancel<\/a>\u00a0request, specifying:\u00a0<\/p>\n
- \n
originalReference<\/code>: TherescueReference<\/code> that you received in the payment response<\/a>.<\/li>\ncancellationType<\/code>: autoRescue<\/strong><\/li>\n<\/ul>\nThe following example shows how to cancel the Auto Rescue process for a payment with a
rescueReference<\/code> of 865497581465325B<\/strong>.<\/p>\n\n<\/code-sample>\n<\/div>\n<\/li>\n - \n
- paymentLink.expiresAt<\/a> \u2014 The date when the payment link expires, in ISO 8601<\/a> format. For example,
- false<\/strong>: The rescue process was unsuccessful.<\/li>\n<\/ul><\/li>\n
- false<\/strong>: We are unable to schedule another retry attempt<\/a>.
- Unsuccessful<\/a>.<\/li>\n<\/ul><\/li>\n
- Successful<\/a>.<\/li>\n
- false<\/strong>: Auto Rescue will not<\/em> try to rescue the payment. This happens when a payment cannot be rescued. For example, because of account closure or fraud.<\/li>\n<\/ul>\n<\/li>\n
- \n
- \n
- shopperInteraction<\/a>: ContAuth<\/strong><\/li>\n
- Add the
- A
- Transaction level<\/a>: You choose when Auto Rescue can be used for a payment, using the
- Cancel the Auto Rescue process<\/a> for a payment.<\/li>\n