Cancel retries when using the Decline Recovery service

Merchants can enable or disable retries for one or more transactions by using Nexio's Decline recovery service when a transaction is declined. Transactions that are scheduled for a retry can be canceled through the Enable or disable retries for a single transaction endpoint, Enable or disable retries for multiple transactions endpoint, or through the Nexio Dashboard in the Decline Recovery report.

Using these tools to cancel transaction retries can be helpful for merchants who want to cancel further retries before reaching a maximum retry limit.

Canceling transaction retries can also be helpful when a customer cancels a subscription while their payment is scheduled for a retry. The merchant can disable retries for that subscription transaction to avoid paying future refunds.

Cancel a retry for a single transaction using the "Enable or disable retries for a single transaction" endpoint

To cancel a retry for a single transaction, send a PUT request to the Enable or disable retries for a single transaction endpoint. Include the following parameters in your request:

  • id - The retry ID. This is a specific ID type that can only be obtained by sending a GET request to the View recovery status endpoint. You will need to obtain the retry ID before canceling retries through this endpoint. Set the value of this parameter to the ID obtained through the View recovery status endpoint.
  • isEnabledForRecovery - Set the value of this parameter to "false" in your request.

Your request will look as follows:

Example Request
curl --request PUT \
--url https://api.nexiopaysandbox.com/recovery/v3/enable \
--header 'Authorization: Basic anNtaXRoQG5leC5pbzpTYWdpbmF3MTEh' \
--header 'Content-Type: application/json' \
--data '{
          "id": 4753537,
          "isEnabledForRecovery": false
        }'

Having sent the request to the Nexio API, a response is received. If the request was successful, the success parameter in the response shows "true" and the response appears as follows:

Example Response
{
  "id": 4753537,
  "isEnabledForRecovery": false,
  "success": true
}

For more information on using this endpoint to cancel transaction retries, view the Enable or disable retries for a single transaction endpoint in the API reference.

Cancel retries for multiple transactions through the "Enable or disable retries for multiple transactions" endpoint

Using this endpoint allows you to cancel retries for multiple declined transactions in a single request to the Nexio API. To cancel retries for multiple transactions, send a PUT request to the Enable or disable retries for multiple transactions endpoint.

Your request to the Enable or disable retries for multiple transactions endpoint will consist of a "retries" object containing the following parameters:

  • id - The retry ID. This is a specific ID type that can only be obtained by sending a GET request to the View recovery status endpoint. You will need to obtain the retry ID before canceling retries through this endpoint. Set the value of this parameter to the ID obtained through the View recovery status endpoint for every transaction included in your request.
  • isEnabledForRecovery- Set the value of this parameter to "false" for every transaction included in your request.

You will iterate these parameters inside the "retries" object for each transaction you are wanting to cancel a retry for.

Your request will look as follows:

Example Request
curl --request PUT \
--url https://api.nexiopaysandbox.com/recovery/v3/bulkEnable \
--header 'Authorization: Basic anNtaXRoQG5leC5pbzpTYWdpbmF3MTEh' \
--header 'Content-Type: application/json' \
--data '{
           "retries": [
             {
               "id": 4753555,
               "isEnabledForRecovery": false
             },
             {
               "id": 4753556,
               "isEnabledForRecovery": false
             }
         ]
       }'

After the request has been sent, a response is received from the Nexio API. The success parameter on each transaction added in the request will show "true" in the response if your request was successful for that transaction.

The response will appear as follows:

Example Response
{
  "retries": [
    {
      "id": 4753555,
      "isEnabledForRecovery": false,
      "success": true
    },
    {
      "id": 4753556,
      "isEnabledForRecovery": false,
      "success": true
    }
  ]
}

View the Enable or disable retries for multiple transactions endpoint in the API reference for more information on using this endpoint to cancel transaction retries.

Cancel retries for one or more transactions through the Nexio Dashboard using the Decline Recovery report

For instructions on how to cancel a retry for one or more transactions through the Nexio Dashboard using the Decline Recovery report, view this article.

Updated 8 months ago