Set CVV Retention Policy

put

https://service.pcibooking.net/api/payments/paycard/{cardToken}/cvv/Restriction

This method allows you to set the CVV retention for a token.
This method supports submitting the request with a body in both JSON (default) and XML formats.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Below are several examples of the message body used for setting the CVV retention policy.
The first example shows how to use each one of the destinationTypes in XML format.
The second example shows the minimal request body in XML format.
The third example shows the minimal request body in JSON format.

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

<?xml version="1.0"?>
<CardCvvRetentionPolicy>
    <CvvEndRetentionDate>2020-05-11T11:37:54</CvvEndRetentionDate>
    <CvvRetentionPolicyList>
    </CvvRetentionPolicyList>
</CardCvvRetentionPolicy>

{
  "CvvEndRetentionDate": "2020-12-12 12:32:45",
  "CvvRetentionPolicyList": []
}

Path Params

cardToken

string

required

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

Body Params

CvvEndRetentionDate

string

required

The CVV retention period end date and time. The format is YYYY-MM-DD HH:MM:SS.
Validation: end date is not more than 48 months from token creation date and time.

CvvRetentionPolicyList

array of objects

An array of destination whitelists. You can set up to 50 different destinations. For each destination, you can set the type of destination it is and the number of times the card, including the CVV, can be sent to this destination.
Read more on possible values for destination type and destination Data

CvvRetentionPolicyList

DeleteCardUponCVVCleanup

boolean

Defaults to false

Indicates whether the full card details should be deleted when the CVV retention period is over.
If field is not present in the request, default is False.

Headers

Authorization

string

required

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

Content-Type

string

Defaults to application/json

The body of this request is, by default, in JSON format. You can provide the Content-Type header and specify the value as application/xml in order to submit the request body in a XML format.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

423423