Get CVV Retention Policy for Specific Destination

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())

{
    "CvvDestinationUsage": 3,
    "DestinationType": "HostName",
    "DestinationData": "gateway.example.com",
    "Quota": 10
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

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())

{
    "CvvDestinationUsage": 3,
    "DestinationType": "HostName",
    "DestinationData": "gateway.example.com",
    "Quota": 10
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

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

Error Responses

Code	HTTP Status	Condition
`-1003`	`401`	API key is missing or invalid.
`-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

Headers

Authorization

string

required

Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Path Parameters

cardToken

string

required

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

DestinationType

string

required

One of: HostName, Owner, OtherMerchant, SFTP, OtherUser. See destination types.

DestinationData

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

{
    "CvvDestinationUsage": 3,
    "DestinationType": "HostName",
    "DestinationData": "gateway.example.com",
    "Quota": 10
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

Get CVV Retention Policy Delete CVV Retention Policy

Start Here

Authentication & General

Capture Cards

Manage Tokens

Use Tokens

Additional Functions

Payments Library

Get CVV Retention Policy for Specific Destination

CVV Retention Policy Guide

Error Responses

Parameter Constraints

Parameters

Headers

Path Parameters

Response

CVV Retention Policy Guide

​Error Responses

​Parameter Constraints

​Parameters

​Headers

​Path Parameters

​Response

Error Responses

Parameter Constraints

Parameters

Headers

Path Parameters

Response