const response = await fetch('https://service.pcibooking.net/api/cardrequest/duplicate', {
method: 'POST',
headers: {
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
SenderID: 'myhotel',
OriginCardUri: 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
DestinationType: 'email',
Destination: 'guest@example.com',
RecipientName: 'Jane Smith',
RequestTTL: 12,
Language: 'en',
SenderReference: 'booking-12345',
Description: 'CVV for reservation #12345',
Amount: 250.00,
Currency: 'USD',
Success: 'https://yoursite.com/success',
Failure: 'https://yoursite.com/failure'
})
});
const requestUri = response.headers.get('Location');
console.log('Request URI:', requestUri);
import requests
response = requests.post(
'https://service.pcibooking.net/api/cardrequest/duplicate',
headers={
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
json={
'SenderID': 'myhotel',
'OriginCardUri': 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
'DestinationType': 'email',
'Destination': 'guest@example.com',
'RecipientName': 'Jane Smith',
'RequestTTL': 12,
'Language': 'en',
'SenderReference': 'booking-12345',
'Description': 'CVV for reservation #12345',
'Amount': 250.00,
'Currency': 'USD',
'Success': 'https://yoursite.com/success',
'Failure': 'https://yoursite.com/failure'
}
)
request_uri = response.headers.get('Location')
print('Request URI:', request_uri)
Empty response body. The Location header contains the request URI:
Location: https://service.pcibooking.net/api/payments/paycard/CardForm/xLoat3F385vvFRbgI2usOeuXKXQoB8kv
{
"code": -179,
"message": "Bad input parameter",
"moreInfo": "Bad input data",
"errorList": [
"Bad json format"
]
}
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.
Card By Link
Send CVV Capture Link
Send a Card By Link request via email or SMS with a link to a secure CVV capture form.
POST
/
api
/
cardrequest
/
duplicate
const response = await fetch('https://service.pcibooking.net/api/cardrequest/duplicate', {
method: 'POST',
headers: {
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
SenderID: 'myhotel',
OriginCardUri: 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
DestinationType: 'email',
Destination: 'guest@example.com',
RecipientName: 'Jane Smith',
RequestTTL: 12,
Language: 'en',
SenderReference: 'booking-12345',
Description: 'CVV for reservation #12345',
Amount: 250.00,
Currency: 'USD',
Success: 'https://yoursite.com/success',
Failure: 'https://yoursite.com/failure'
})
});
const requestUri = response.headers.get('Location');
console.log('Request URI:', requestUri);
import requests
response = requests.post(
'https://service.pcibooking.net/api/cardrequest/duplicate',
headers={
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
json={
'SenderID': 'myhotel',
'OriginCardUri': 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
'DestinationType': 'email',
'Destination': 'guest@example.com',
'RecipientName': 'Jane Smith',
'RequestTTL': 12,
'Language': 'en',
'SenderReference': 'booking-12345',
'Description': 'CVV for reservation #12345',
'Amount': 250.00,
'Currency': 'USD',
'Success': 'https://yoursite.com/success',
'Failure': 'https://yoursite.com/failure'
}
)
request_uri = response.headers.get('Location')
print('Request URI:', request_uri)
Empty response body. The Location header contains the request URI:
Location: https://service.pcibooking.net/api/payments/paycard/CardForm/xLoat3F385vvFRbgI2usOeuXKXQoB8kv
{
"code": -179,
"message": "Bad input parameter",
"moreInfo": "Bad input data",
"errorList": [
"Bad json format"
]
}
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 Capture Guide
Collect CVV from cardholders via hosted forms
This operation duplicates the original token. Once the cardholder enters the CVV, PCI Booking creates a new token with the original card details plus the captured CVV. The original token remains unchanged. Delete it if no longer needed, otherwise it will continue to incur monthly storage fees.
Error Responses
| Code | HTTP Status | Condition |
|---|---|---|
| -179 | 400 | Validation error: missing required fields, invalid field format, or malformed JSON body. |
| none | 401 | Missing or invalid API key in the Authorization header. The response body is empty. |
| -1003 | 401 | SenderID does not match the identity associated with the API key. |
| -150 | 500 | Internal system error while creating the CVV request. |
Parameter Constraints
| Parameter | Constraint |
|---|---|
RequestTTL | Integer, range 1 to 72 (hours). |
Destination | Required. Max 255 characters. |
RecipientName | Required. Max 70 characters. |
SenderReference | Max 50 characters. |
Description | Max 50 characters. |
CustomHeaderText | Max 1000 characters. |
CustomFooterText | Max 1000 characters. |
CustomerSupportPhone | Max 20 characters. |
CustomerSupportEmail | Max 50 characters. |
CustomerSupportLink | Max 255 characters. Must be a valid URL. |
CustomerSupportLinkText | Max 100 characters. |
LogoTitle | Max 100 characters. |
SiteTitle | Max 40 characters. |
Parameters
Authentication
API key only. This endpoint does not accept access tokens or session tokens.Your API key prefixed with
APIKEY. Example: APIKEY your-api-key. The x-pcibooking-api-key header is also accepted. See the Authentication guide.Request Configuration
The form’s language in ISO 639-1 (2-letter) format. See supported languages. If an unsupported language is received, English will be displayed. Languages can be added through the user’s control panel.
The CSS resource name. Follow the guide on managing stylesheets. If not provided, PCI Booking will apply the default CSS.
The region where the new token is stored when the cardholder submits the form. One of:
US, IN, AU, JP, CA, IE, GB, BR. If omitted, the new token is stored in the same region as the original token. See Card Storage Regions.Delivery
The destination email address or phone number. Phone numbers should be formatted as international dial numbers:
Country code + area code + phone number.Transaction Details
The transaction amount, also displayed in the 3DS challenge screen. Required if
Currency is provided. If omitted, authentication uses 0 EUR.The transaction currency in ISO 4217 (3-letter) format, also displayed in the 3DS challenge screen. Required if
Amount is provided. An invalid value returns error code -179 (HTTP 400). If omitted, authentication uses 0 EUR.3D Secure
- The 3DS challenge window has a 5 minute timeout. If the cardholder does not respond in time, authentication is rejected.
- Do not use
merchantNameunless you have configured your 3DS merchant information. To use PCI Booking’s merchant, setThreeDStoTrueand leavemerchantNameblank (Visa and Mastercard only). An unregisteredmerchantNamedoes not return an error - PCI Booking silently falls back to its default merchant and the cardholder sees PCI Booking’s name. UnavailThreeDSAuthdefaults toAccept. If 3DS can’t complete for any reason, the card is still tokenized - silently, without 3DS data. If you later charge that token through a PSP that requires 3DS, the charge will be rejected. Set this toRejectif every token in your flow must have 3DS data.
Whether to perform 3D Secure authentication after the cardholder enters the CVV.
What to do if there is a technical problem with the 3DS process. Accept - ignore 3DS and proceed with creating the new token. Reject - do not continue or tokenize; the card owner will be directed to the failure page URL.
The merchant to use for 3D Secure authentication. Must match a merchant name registered in your 3DS merchant setup.
Cardholder’s email address for 3D Secure authentication. Must be in a valid email format, e.g. joe@bloggs.com.
Cardholder’s telephone number for 3D Secure authentication. May only contain digits [0-9], e.g.: 00353112223344.
Branding
CustomerSupportLink, CustomerSupportLinkText, CustomerSupportEmail, and CustomerSupportPhone can also be set in your account settings. Values provided in the request override the account defaults.URLs in the request body (e.g.
ClientLogoURL, Success, Failure) should not be URL-encoded, since they are sent in JSON, not as query parameters.URL to the logo displayed in the Card By Link email and landing page. Submit with a null value to hide the logo. If not supplied, the logo from your Booker profile in the portal is used. Images must be publicly accessible via HTTPS URL. Supported image formats: png, gif, bmp, jpeg, jpg.
The title of the logo. If not provided, the booker name from the portal is used. Submit with a null value to hide the logo title. Max 100 characters.
URL to the favicon displayed in the Card By Link landing page. If not supplied, the browser default favicon is used. Images must be publicly accessible via HTTPS URL in ico or png format, size 16x16 or 32x32.
Text displayed in the header of the message to the recipient. Max 1000 characters. If
RecipientName, Amount, and Currency placeholders are not listed in the CustomHeaderText or in the portal customizations but are provided in the request parameters, they will still be displayed in the email.Text displayed in the footer of the message to the recipient. Max 1000 characters. If
CustomerSupportEmail and CustomerSupportPhone placeholders are not listed in the CustomFooterText or in the portal customizations but are provided in the request parameters, they will still be displayed in the email.URL for customer support displayed in the email and landing page. Max 255 characters. Required if
CustomerSupportLinkText is provided.Display name for the customer support URL in the email and landing page. Max 100 characters. Required if
CustomerSupportLink is provided.Redirect URLs
URL where a successful response will be redirected to. Only the
{cardToken} placeholder is resolved by this form - see CVV capture success URLs.URL where a failed response will be redirected to. See setting up success/failure redirection pages.
const response = await fetch('https://service.pcibooking.net/api/cardrequest/duplicate', {
method: 'POST',
headers: {
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
SenderID: 'myhotel',
OriginCardUri: 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
DestinationType: 'email',
Destination: 'guest@example.com',
RecipientName: 'Jane Smith',
RequestTTL: 12,
Language: 'en',
SenderReference: 'booking-12345',
Description: 'CVV for reservation #12345',
Amount: 250.00,
Currency: 'USD',
Success: 'https://yoursite.com/success',
Failure: 'https://yoursite.com/failure'
})
});
const requestUri = response.headers.get('Location');
console.log('Request URI:', requestUri);
import requests
response = requests.post(
'https://service.pcibooking.net/api/cardrequest/duplicate',
headers={
'Authorization': 'APIKEY your-api-key',
'Content-Type': 'application/json'
},
json={
'SenderID': 'myhotel',
'OriginCardUri': 'https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6',
'DestinationType': 'email',
'Destination': 'guest@example.com',
'RecipientName': 'Jane Smith',
'RequestTTL': 12,
'Language': 'en',
'SenderReference': 'booking-12345',
'Description': 'CVV for reservation #12345',
'Amount': 250.00,
'Currency': 'USD',
'Success': 'https://yoursite.com/success',
'Failure': 'https://yoursite.com/failure'
}
)
request_uri = response.headers.get('Location')
print('Request URI:', request_uri)
Response
201 - Empty body. ALocation header is returned with the URI for this card request. Use this URI to retrieve the request status or delete the request.
Remember to set the CVV Retention Policy on the new token once the CVV is captured.
Empty response body. The Location header contains the request URI:
Location: https://service.pcibooking.net/api/payments/paycard/CardForm/xLoat3F385vvFRbgI2usOeuXKXQoB8kv
{
"code": -179,
"message": "Bad input parameter",
"moreInfo": "Bad input data",
"errorList": [
"Bad json format"
]
}
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.

