To start using Success+, add
retry_if_possible:true to all of your create payment, subscription and instalment schedule requests.
This will mean that any eligible payments will be intelligently retried.
Note that a merchant’s payments will only be eligible if they have enabled Success+ in the GoCardless dashboard.
There are a number of criteria which determine whether a payment will be retried. Some of these are dynamic: i.e. when our model
looks for a date to retry, it may consider that there is no appropriate date. This means you cannot predict which payments will
be intelligently retried. Instead, you can use the
will_attempt_retry flag which is on the
payment:failed event. If this flag
is set to
true, then the payment will be intelligently retried. If not, then it is safe for you to retry the payment.
payment:failed event with
will_attempt_retry:true, we will send a
When you receive this event, you should call
get payment to get the updated payment, including the new
You can treat this exactly the same as a manual user-triggered
retry - the payment will be re-attempted on the new
and will go through the normal payment flow. If you already support payment retries, there should be very limited work involved
Sometimes, there may be a situation where a merchant wants to cancel a payment, but it is already in a
submitted state. In this case,
we recommend you call
update payment with
retry_if_possible:false. This means that, while the initial payment will still continue,
it will not be automatically retried.
Merchants should be directed to the GoCardless dashboard, to the link https://manage.gocardless.com/success-plus. This will allow them to enable and configure Success+.
- Show the merchant how many times a payment has been retried (by keeping an attempt count)
- Show the merchant the charge date of the current payment
- Show the merchant how to get to the GoCardless dashboard to enable and configure Success+
- Don’t show a ‘Retry’ button when a payment is going to be intelligently retried - this action will fail in GoCardless and confuse the merchant.
Visit the API Reference for Success+ here.