Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Decline Recovery

Enable or disable retries for a single transaction

Allows the merchant to enable or disable retries for a single transaction when that transaction is declined. For more information, see the Decline recovery overview.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.<br/><br/>Include at least the retry ID in the body of the request.

<div style="display:none;">

Request parameters

  • id
  • isEnabledForRecovery

Response parameters

  • id
  • isEnabledForRecovery
  • success
</div>
put/recovery/v3/enable

Request body

idinteger required

The retry ID. To get the retry ID, send a GET request to the View recovery status endpoint.

isEnabledForRecoveryboolean

Set to true to enable recovery for the transaction. Set to false to disable recovery for the transaction.

Example request

{
  "id": 4755455
}

Response

OK

idinteger

The retry ID.

isEnabledForRecoveryboolean

Shows true if recovery is enabled for the transaction. Shows false if recovery is not enabled for the transaction.

successboolean

Shows true if the API request was sent successfully. Shows false if the request was not successful. Note that this does not mean that the transaction was successfully enabled or disabled for decline recovery.

Example response

{
  "id": 4755455
}