const response = await fetch(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
{
headers: {
'Authorization': 'APIKEY your-api-key'
}
}
);
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
headers={'Authorization': 'APIKEY your-api-key'}
)
print(response.json())
{
"DestinationType": "HostName",
"DestinationData": "gateway.example.com",
"Quota": 10,
"Usage": 3
}
Empty response body.
Authentication failed: the API key, session token or access token is missing or was not accepted.
See "Authentication and Permission Failures" on the Error Handling page.
CVV Management
Get CVV Retention Policy for Specific Destination
Retrieve the CVV retention policy for a single destination, including its usage count.
GET
/
api
/
payments
/
paycard
/
{cardToken}
/
cvv
/
Restriction
/
{DestinationType}
/
{DestinationData}
const response = await fetch(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
{
headers: {
'Authorization': 'APIKEY your-api-key'
}
}
);
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
headers={'Authorization': 'APIKEY your-api-key'}
)
print(response.json())
{
"DestinationType": "HostName",
"DestinationData": "gateway.example.com",
"Quota": 10,
"Usage": 3
}
Empty response body.
Authentication failed: the API key, session token or access token is missing or was not accepted.
See "Authentication and Permission Failures" on the Error Handling page.
Returns the retention policy for a single destination on this token, including how many times the CVV has been sent there.
CVV Retention Policy Guide
Control how long CVV data is retained and who can use it
These
cvv/Restriction endpoints manage what the documentation calls the CVV retention policy and what the PCI Booking portal calls CVV Store Rules. All three names refer to the same feature.Error Responses
| Code | HTTP Status | Condition |
|---|---|---|
| none | 401 | API key is missing or invalid. The response body is empty. |
-1003 | 401 | Authenticated user does not have ForceCVVRetentionPolicy permission. |
-1003 | 401 | Token does not belong to the authenticated user. |
-125 | 400 | The token does not have a CVV stored. |
-160 | 404 | The specified destination does not exist in the token’s retention policy. |
-150 | 500 | An internal system error occurred while retrieving the destination. |
Parameter Constraints
- DestinationType: Must be a valid destination type. Accepted values:
HostName,Owner,OtherMerchant,SFTP,OtherUser,Upg,IpAddress,GeneralProperty,OtpCardView,Any. - DestinationData: The format depends on the
DestinationType(e.g. a valid hostname, IP address, or user ID).
Parameters
Authentication
API key only. This endpoint does not accept access tokens or session tokens.string
required
Your API key prefixed with
APIKEY. Example: APIKEY your-api-key. The x-pcibooking-api-key header is also accepted. See the Authentication guide.Path Parameters
string
required
The token ID as returned by one of the tokenization methods.
string
required
One of:
HostName, Owner, OtherMerchant, SFTP, OtherUser. See destination types.string
required
The target identifier for this destination type (e.g. hostname, user ID, IP address).
const response = await fetch(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
{
headers: {
'Authorization': 'APIKEY your-api-key'
}
}
);
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://service.pcibooking.net/api/payments/paycard/2821a46d80e14d1b96a7f18f1b81926d/cvv/Restriction/HostName/gateway.example.com',
headers={'Authorization': 'APIKEY your-api-key'}
)
print(response.json())
Response
{
"DestinationType": "HostName",
"DestinationData": "gateway.example.com",
"Quota": 10,
"Usage": 3
}
Empty response body.
Authentication failed: the API key, session token or access token is missing or was not accepted.
See "Authentication and Permission Failures" on the Error Handling page.