Disable stored details

When you terminate your shopper's subscription, you need to disable the recurring contract to prevent charging this shopper with the previously stored payment details.

Request

To disable stored details, send a request to the /disable endpoint. In this request specify the merchant account, shopper reference, and the contract type (either ONECLICK or RECURRING). You can also specify the reference of a particular recurring detail to disable, or skip this parameter to disable all recurring details for the specified shopper.

For information on all available fields, refer to the DisableRequest topic.

The example below illustrates how to disable a one-click recurring detail. Submit this request to the https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable endpoint.

{
   "merchantAccount":"TestMerchant",
   "shopperReference":"test12345621217",
   "recurringDetailReference":"8313147988756818",
   "contract":"ONECLICK"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:disable xmlns:ns1="http://recurring.services.adyen.com">
      <ns1:request>
        <ns1:merchantAccount>TestMerchant</ns1:merchantAccount>
        <ns1:shopperReference>test12345621217</ns1:shopperReference>
        <ns1:recurringDetailReference>8313147988756818</ns1:recurringDetailReference>
        <ns1:contract>ONECLICK</ns1:contract>
      </ns1:request>
    </ns1:disable>
  </soap:Body> 
</soap:Envelope>
curl https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable \
 -d merchantAccount=TestMerchant \
 -d shopperReference=test12345621217 \
 -d recurringDetailReference=8314897374042210 \
 -d contract=ONECLICK

The following example shows how to disable all the details of a recurring contract. Submit this request to the https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable endpoint.

{
   "merchantAccount":"TestMerchant",
   "shopperReference":"test12345621217",
   "recurringDetailReference":"8313147988756818"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:disable xmlns:ns1="http://recurring.services.adyen.com">
      <ns1:request>
        <ns1:merchantAccount>TestMerchant</ns1:merchantAccount>
        <ns1:shopperReference>test12345621217</ns1:shopperReference>
        <ns1:recurringDetailReference>8313147988756818</ns1:recurringDetailReference>
      </ns1:request>
    </ns1:disable>
  </soap:Body> 
</soap:Envelope>
curl https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable \
 -d merchantAccount=TestMerchant \
 -d shopperReference=test12345621217 \
 -d recurringDetailReference=8314897374042210

Response

The response to the /disable endpoint contains only a response field of a string type.

Possible values:

  • [detail-successfully-disabled] - when a single detail is disabled.
  • [all-details-successfully-disabled] - when all the details are disabled.

For information on all available fields, refer to the DisableResult topic.

The following examples shows the response in case all recurring details are successfully disabled:

{
   "response":"[all-details-successfully-disabled]"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:disableResponse xmlns:ns1="http://recurring.services.adyen.com">
      <ns1:result>
        <ns1:response>[all-details-successfully-disabled]</ns1:response>
      </ns1:result>
    </ns1:disableResponse>
  </soap:Body> 
</soap:Envelope>