Digital Rights Revocation Details

You can revoke a Digital Rights key associated product. 

You can create a custom integration to: 

  • Revoke a key if a product is returned
  • The order is refunded or canceled
  • There is a chargeback, fraud, or some other failure in payment or order authorization
Event
Type
Revocation Service Request
Webhook

Revocation Service Request

The Digital Right Revocation Service is a real-time, request/response-based process used to revoke one external digital right. The service revokes a key that has already been delivered to the shopper. A key revocation integration sends a request to revoke or take back a key (serial number of unlock code) that was distributed when a product was purchased. A revocation can happen for many reasons including a refund, return, or fraud.

Key Revocation

Notification–Global Commerce generates a Revocation Service Request and sends the request to your endpoint.

Required Response to Notification–Your endpoint must synchronously respond with a Revocation Service Response.

Digital Rights Revocation Request Example

<?xml version="1.0" encoding="UTF-8"?>
<ns1:RevocationServiceRequest xmlns:ns1="http://integration.digitalriver.com/RevocationService">
 <orderInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:OrderInfo">
  <orderID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">123456789</orderID>
  <externalReferenceID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
  <siteID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">siteID</siteID>
  
  <userKey xmlns:ns2="http://integration.digitalriver.com/Common/1.0" xsi:type="ns2:UserKey">
   <userID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">213456789</userID>
   <externalReferenceID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">312456789</externalReferenceID>
   <companyID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">412356789</companyID>
   <loginID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">email@example.com</loginID>
   <siteID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">siteID</siteID>
  </userKey>
  <paymentInfo xmlns:ns3="http://integration.digitalriver.com/commonRequisition/1.0" xsi:type="ns3:PaymentInformationInfo">
    <accountID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <authorizationID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">512346789</authorizationID>
    <cardType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">CardType</cardType>
    <customerEmail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">email2@example.com</customerEmail>
    <cardNumber xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">6123456789</cardNumber>
    <cardExpirationMonth xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">01</cardExpirationMonth>
    <cardExpirationYear xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">2080</cardExpirationYear>
    <customerPO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <ccIssueCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <ccIssueMonth xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <ccIssueYear xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <securityIndicator xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <routingNumber xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <vatNumber xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
    <customerLastName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">LastName</customerLastName>
    <customerFirstName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">FirstName</customerFirstName>
    <paymentAmount xmlns:ns4="http://integration.digitalriver.com/Common/1.0" xsi:type="ns4:MoneyInfo">
     <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
     <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">11.11</amount>
    </paymentAmount>
    <paymentMethodName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">paymentMethod</paymentMethodName>
    <billingAddress xmlns:ns5="http://integration.digitalriver.com/Common/1.0" xsi:type="ns5:AddressInfo">
     <addressID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">712345689</addressID>
     <city xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">City</city>
     <countryA2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <country xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">US</country>
     <countryName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">United States</countryName>
     <line1 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">123 Example Street</line1>
     <line2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <line3 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <locationCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <name1 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">FirstName</name1>
     <name2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">LastName</name2>
     <phoneNumber xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">(123) 456-7890</phoneNumber>
     <postalCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">12345</postalCode>
     <state xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <email xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">email3@example.com</email>
     <faxPhone xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <companyName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">companyName</companyName>
     <phoneNumber2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <countyName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
     <extendedAttributes xsi:type="ns5:ExtendedAttributesInfoArray"/>
    </billingAddress>
    <extendedAttributes xmlns:ns6="http://integration.digitalriver.com/Common/1.0" xsi:type="ns6:ExtendedAttributesInfoArray">
     <item xsi:type="ns6:ExtendedAttributesInfo">
      <name xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">extendedAttributeName</name>
      <value xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">value</value>
      <valueDataType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">string</valueDataType>
     </item>
    </extendedAttributes>
   </paymentInfo>
  <extendedAttributes xmlns:ns7="http://integration.digitalriver.com/Common/1.0" xsi:type="ns7:ExtendedAttributesInfoArray">
   <item xsi:type="ns7:ExtendedAttributesInfo">
    <name xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">extendedAttributeName</name>
    <value xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">value</value>
    <valueDataType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">string</valueDataType>
   </item>
  </extendedAttributes>
 </orderInfo>
 <lineItemInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:LineItemInfo">
  <lineItemID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">812345679</lineItemID>
  <productInfo xsi:type="ns1:ProductInfo">
   
   <productKey xmlns:ns8="http://integration.digitalriver.com/Common/1.0" xsi:type="ns8:ProductKey">
    <productID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">912345678</productID>
    <externalReferenceID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">012345678</externalReferenceID>
    <companyID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">102345678</companyID>
    <locale xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string" xsi:nil="true"/>
   </productKey>
   <digitalRight xsi:type="ns1:DigitalRightInfo">
    <key xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">key</key>
    <keyType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">KEY_TYPE</keyType>
    <lineItemQuantityID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:int">1</lineItemQuantityID>
    
   </digitalRight>
   <productAttributes xmlns:ns9="http://integration.digitalriver.com/Common/1.0" xsi:type="ns9:ExtendedAttributesInfoArray">
    <item xsi:type="ns9:ExtendedAttributesInfo">
     <name xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">ExtendedAttributeName</name>
     <value xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">value</value>
     <valueDataType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">string</valueDataType>
    </item>
   </productAttributes>
  </productInfo>
  
  <extendedAttributes xmlns:ns11="http://integration.digitalriver.com/Common/1.0" xsi:type="ns11:ExtendedAttributesInfoArray"/>
 </lineItemInfo>
 <revocationReason xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">Return-Product</revocationReason>
 <revocationInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:RevocationInfo">
  <disputeInfo xsi:type="ns1:DisputeRevocationInfo" xsi:nil="true"/>
  <suppressionInfo xsi:type="ns1:SuppressionRevocationInfo" xsi:nil="true"/>
  <returnInfo xsi:type="ns1:ReturnRevocationInfo">
   <returnID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">2013456789</returnID>
   <returnLineItemID xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">301245789</returnLineItemID>
   <returnDate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:dateTime">2014-09-14T12:00:32.212Z</returnDate>
   <returnReason xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">RETURN_REASON</returnReason>
   <returnTotalAmount xmlns:ns12="http://integration.digitalriver.com/Common/1.0" xsi:type="ns12:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">11.11</amount>
   </returnTotalAmount>
   <returnSubtotalAmount xmlns:ns13="http://integration.digitalriver.com/Common/1.0" xsi:type="ns13:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">11.11</amount>
   </returnSubtotalAmount>
   <returnTaxAmount xmlns:ns14="http://integration.digitalriver.com/Common/1.0" xsi:type="ns14:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">0.00</amount>
   </returnTaxAmount>
   
   
   <returnFeesAmount xmlns:ns17="http://integration.digitalriver.com/Common/1.0" xsi:type="ns17:MoneyInfo" xsi:nil="true"/>
   <returnShippingAmount xmlns:ns18="http://integration.digitalriver.com/Common/1.0" xsi:type="ns18:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">0.00</amount>
   </returnShippingAmount>
   <returnLineItemTotalAmount xmlns:ns19="http://integration.digitalriver.com/Common/1.0" xsi:type="ns19:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">11.11</amount>
   </returnLineItemTotalAmount>
   <returnLineItemSubtotalAmount xmlns:ns20="http://integration.digitalriver.com/Common/1.0" xsi:type="ns20:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">11.11</amount>
   </returnLineItemSubtotalAmount>
   <returnLineItemTaxAmount xmlns:ns21="http://integration.digitalriver.com/Common/1.0" xsi:type="ns21:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">0.00</amount>
   </returnLineItemTaxAmount>
   
   
   <returnLineItemShippingAmount xmlns:ns24="http://integration.digitalriver.com/Common/1.0" xsi:type="ns24:MoneyInfo">
    <currencyCode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:string">USD</currencyCode>
    <amount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:decimal">0.00</amount>
   </returnLineItemShippingAmount>
   <returnLineItemQuantity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:int">1</returnLineItemQuantity>
   <satisfaction xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="xsd:boolean">false</satisfaction>
   
  </returnInfo>
 </revocationInfo>
</ns1:RevocationServiceRequest>

Successful Digital Rights Revocation Response Example

<RevocationServiceResponse>
    <successful>success</successful>
    <isAutoRetriable>false</isAutoRetriable>
    <responseCode>1234</responseCode>
    <responseType>responseType</responseType>
    <responseMessage>SUCCESS</responseMessage>
</RevocationServiceResponse>

Unsuccessful Digital Rights Revocation Response Example

<RevocationServiceResponse>
    <successful>false</successful>
    <isAutoRetriable>false</isAutoRetriable>
    <responseCode>5020</responseCode>
    <responseType>DATA_VALIDATION_ERROR</responseType>
    <responseMessage>The order ID 123456789 is not a valid order ID</responseMessage>
</RevocationServiceResponse>

Revocation Reason Table

Revocation Reason
Description
Dispute-Lineitem
The Line Item that contains the Digital Right is under dispute
Dispute-Amount
A non-Line-Item-specific amount on the requisition is under dispute (for example, the client disputes $30.00 because they were unhappy with something)
Fraud-Suppression
The requisition containing the Digital Right was suppressed
Return-Product
The DigitalRight was returned
Return-Satisfaction
Tthe Line Item containing the Digital Right underwent a satisfaction refund (the product was not returned)
Declined-Settlement
The Settlement Payment Transaction was declined
PreLoad-Cancel
Tthe preload Line Item was canceled and has not been released