Get CVV Retention Policy

This method allows you to retrieve the CVV Retention Policy for a token and see your progress within the restrictions.
This method supports providing the response in both JSON (default) and XML formats.

We recommend that you first review the guide for this method.

The response body will be the same structure of the request body to Set CVV Retention Policy. There will be an additional field called CvvDestinationUsage to indicate, per destination, how many times the CVV has been relayed to that destination already.

Below is a full example of the XML body that is returned when retrieving the CVV restriction policy. This example demonstrates all of the destinationTypes.

<?xml version="1.0"?>
<CvvRetentionPolicy>
    <CvvEndRetentionDate>2018-01-19T11:58:00</CvvEndRetentionDate>
    <CvvRetentionPolicyList>
        <CvvRetentionPolicyDestinationUsage>
            <DestinationType>HostName</DestinationType>
            <DestinationData>httpbin.org</DestinationData>
            <Quota>10</Quota>
            <Usage>0</Usage>
        </CvvRetentionPolicyDestinationUsage>
        <CvvRetentionPolicyDestinationUsage>
            <DestinationType>Owner</DestinationType>
            <DestinationData />
            <Quota>23</Quota>
            <Usage>0</Usage>
        </CvvRetentionPolicyDestinationUsage>
        <CvvRetentionPolicyDestinationUsage>
            <DestinationType>OtherMerchant</DestinationType>
            <DestinationData>RoeeExcel9</DestinationData>
            <Quota>30</Quota>
            <Usage>0</Usage>
        </CvvRetentionPolicyDestinationUsage>
        <CvvRetentionPolicyDestinationUsage>
            <DestinationType>SFTP</DestinationType>
            <DestinationData>127.0.0.1</DestinationData>
            <Quota>43</Quota>
            <Usage>0</Usage>
        </CvvRetentionPolicyDestinationUsage>
        <CvvRetentionPolicyDestinationUsage>
            <DestinationType>OtherUser</DestinationType>
            <DestinationData>RoeeBlat</DestinationData>
            <Quota>50</Quota>
            <Usage>0</Usage>
        </CvvRetentionPolicyDestinationUsage>
    </CvvRetentionPolicyList>
</CvvRetentionPolicy>
Path Params
string
required

The token ID as returned by one of the tokenization methods.

Headers
string
required

The authorization mechanism for this method is with the API key in the format of APIKEY {value}.
For example, APIKEY bd3ce883352e42539a2b7644f72e6311.

string
Defaults to application/json

The response of this method is, by default, in JSON format. You can provide the Accept header and specify the value as application/xml in order to receive the response in a XML format.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json