# PCI Booking API > PCI Booking (PCI Shield) is a PCI DSS Level 1 certified tokenization and payment processing service for the travel and hospitality industry. It enables businesses to capture, store, and use payment card data without handling sensitive card information directly. ## Guides - Start Here - [Introduction](https://developers.pcibooking.net/start-here/introduction): PCI Booking tokenization platform. Capture, store, and process payment cards while keeping card data off your servers. - [Quickstart](https://developers.pcibooking.net/start-here/quickstart): Tokenize a card and process a payment in minutes using PCI Booking's hosted card form and Universal Payment Gateway - [Live Demos](https://developers.pcibooking.net/start-here/live-demos): Working demo pages that show PCI Booking flows end to end: the card entry form with 3D Secure and a charge, and the Payments Library. ## Guides - Getting Started - [Create an Account](https://developers.pcibooking.net/getting-started/create-account): Set up sandbox and production accounts with PCI Booking. Learn what is included, how onboarding works, and how to start integrating. - [Authentication](https://developers.pcibooking.net/getting-started/authentication): PCI Booking API authentication methods: API key, access token, and temporary session token with code samples - [Download SSL Certificate](https://developers.pcibooking.net/getting-started/download-ssl-certificate): Download PCI Booking's SSL certificate to generate Access Tokens. Step-by-step for Chrome, Firefox, Edge, and Safari. - [Testing & Going Live](https://developers.pcibooking.net/getting-started/testing-and-going-live): Test your PCI Booking integration in sandbox mode with test cards for standard and 3D Secure flows. Go-live checklist for production. - [Moving Configuration to Production](https://developers.pcibooking.net/getting-started/moving-to-production): What carries over from your sandbox account to your production account, what you import through the portal, and what you set up again. ## Guides - Concepts - [How PCI Booking Works](https://developers.pcibooking.net/concepts/how-pci-booking-works): How PCI Booking keeps card data out of your systems and reduces your PCI DSS scope. Card capture, token storage, and payment processing without handling card data. - [Tokenization Explained](https://developers.pcibooking.net/concepts/tokenization-explained): What is payment card tokenization? How tokens replace sensitive card data, how detokenization works, and how long tokens are stored. - [Working with Third Parties](https://developers.pcibooking.net/concepts/working-with-third-parties): The ways to work with a partner on a card you hold: share the token, transfer it, duplicate it and transfer the copy, relay the card, or show it. When to use each, the CVV policy and billing implications, and the flow. - [PCI Scope and Compliance](https://developers.pcibooking.net/concepts/pci-scope-and-compliance): How integrating PCI Booking affects your PCI DSS scope, which SAQ applies to you, and which compliance documents you can request from us. ## Guides - [For Online Travel Agencies](https://developers.pcibooking.net/guides/for-otas): Learn how OTAs use PCI Booking to capture traveler card data, relay tokens to hotels, charge via payment gateways, and stay PCI DSS compliant. - [For Payment Service Providers](https://developers.pcibooking.net/guides/for-payment-providers): Learn how PSPs integrate with PCI Booking's API, Payments Library, Apple Pay and Google Pay support, gateway credentials management, and data blocks. - [Receiving Cards from Booking.com](https://developers.pcibooking.net/guides/partners/booking-com): How a Booking.com connectivity partner pulls reservations through PCI Booking so that guest cards and virtual cards arrive as tokens, and what to do with the tokens afterwards. - [Receiving Cards from Channex](https://developers.pcibooking.net/guides/partners/channex): How a PMS, booking engine or vacation rental platform takes guest cards from Channex as PCI Booking tokens, and what to do with the tokens afterwards. ## Guides - Capture Cards - [Capture Cards Overview](https://developers.pcibooking.net/capture-cards/overview): All ways to tokenize cards with PCI Booking: hosted form, email/SMS link, JavaScript library, file upload, API migration, and response interception - [Hosted Card Entry Form](https://developers.pcibooking.net/capture-cards/hosted-card-entry-form): Embed a PCI-compliant hosted card entry form via iframe or standalone page. URL parameters and API sessions with 3D Secure. - [PostMessage Notifications](https://developers.pcibooking.net/capture-cards/postmessage-notifications): Control and receive events from the PCI Booking card entry iframe using postMessage. Form submission, validation, resizing. - [Card By Link](https://developers.pcibooking.net/capture-cards/card-by-link): Send cardholders a secure link via email or SMS to enter card details. PCI Booking tokenizes so no card data touches your systems. - [Payments Library](https://developers.pcibooking.net/capture-cards/payments-library): Render secure card forms and payment buttons with PCI Booking's client-side JavaScript library. Apple Pay, Google Pay, 3D Secure. - [Tokenization on Response](https://developers.pcibooking.net/capture-cards/tokenization-on-response): Route outbound HTTP requests through PCI Booking to extract and tokenize card data from third-party responses. - [Tokenization on Request (Gateway)](https://developers.pcibooking.net/capture-cards/tokenization-on-request): Intercept inbound HTTP requests containing card data. PCI Booking tokenizes card numbers and forwards sanitized requests. - [Universal Tokenization Profiles](https://developers.pcibooking.net/capture-cards/universal-tokenization): Use pre-built parsing profiles for common integrations. Tokenize responses without custom configuration. - [File Transfer Tokenization](https://developers.pcibooking.net/capture-cards/file-transfer-tokenization): Tokenize card numbers in file transfers. PCI Booking acts as a secure SFTP/FTPS proxy, replacing card data with tokens. - [CVV Capture Form](https://developers.pcibooking.net/capture-cards/cvv-capture): Collect CVV codes securely using a PCI Booking hosted form. Works with existing card tokens, supports 3D Secure. - [Duplicate a Token](https://developers.pcibooking.net/capture-cards/duplicate-token): Create a new token from a card you already hold, optionally adding a CVV. Covers when to duplicate, the CVV, the CVV retention policy and cleaning up the original token. - [CVV Retention Policy](https://developers.pcibooking.net/capture-cards/cvv-retention-policy): Configure how long CVV data is retained and how many times it can be used. PCI DSS enforcement with per-token policies. - [Store a Card (Direct API)](https://developers.pcibooking.net/capture-cards/store-card-migration): Migrate existing card data to PCI Booking tokens using the Store Paycard API. For PCI DSS-compliant environments. - [Virtual Card Issuance](https://developers.pcibooking.net/capture-cards/virtual-cards): Request a virtual card from a connected issuing provider and automatically tokenize it in PCI Booking. ## Guides - Payments Library - [Payments Library Overview](https://developers.pcibooking.net/payments-library/overview): Integrate PCI Booking's JavaScript library for card capture, Apple Pay, Google Pay, PayPal, BankPay, and UPI in your checkout page - [Payments Library Setup](https://developers.pcibooking.net/payments-library/setup): Install and initialize PCI Booking's JavaScript Payments Library. Script loading, configuration, and first render. - [Supported Payment Methods](https://developers.pcibooking.net/payments-library/supported-methods): Payment methods available through the Payments Library: card entry, Apple Pay, Google Pay, PayPal, BankPay, UPI. - [Library Reference](https://developers.pcibooking.net/payments-library/reference): JavaScript API reference for PCI Booking's Payments Library. Methods, events, configuration options, and callbacks. ## Guides - Manage Tokens - [Manage Tokens Overview](https://developers.pcibooking.net/manage-tokens/overview): Query, update, duplicate, and manage PCI Booking card tokens. Covers expiration, CVV retention, 3DS data, customer and property associations. - [Query & Retrieve Tokens](https://developers.pcibooking.net/manage-tokens/query-retrieve): Search stored tokens by card type, expiration, or customer. Retrieve card details or metadata without exposing sensitive data. - [Update Card Data](https://developers.pcibooking.net/manage-tokens/update-card-data): Update expiration dates and creator references on stored card tokens without re-tokenizing. - [Delete Tokens](https://developers.pcibooking.net/manage-tokens/delete-tokens): Permanently delete stored payment card tokens and all associated data. This action cannot be undone. - [CVV Management](https://developers.pcibooking.net/manage-tokens/cvv-management): Manage CVV storage, retention policies, and re-capture for stored card tokens. PCI DSS compliant. - [3DS Auth Management](https://developers.pcibooking.net/manage-tokens/3ds-auth-management): Store, retrieve, and delete 3D Secure authentication data for payment tokens. CAVV, ECI, and transaction IDs. - [Third-Party Permissions](https://developers.pcibooking.net/manage-tokens/third-party-permissions): Share card tokens with other PCI Booking customers. An associated customer can use the token as if it were their own, and can share it onward. ## Guides - Use Tokens - [Use Tokens Overview](https://developers.pcibooking.net/use-tokens/overview): Use PCI Booking tokens to charge, authorize, refund, display cards, replace tokens in API requests, and transfer files, all without handling card data - [UPG vs Token Replacement](https://developers.pcibooking.net/use-tokens/upg-vs-token-replacement): Two ways to send stored card data to a PSP: the Universal Payment Gateway and Token Replacement. How they differ and when to use each. - [Risk Assessment](https://developers.pcibooking.net/use-tokens/risk-assessment): Assess fraud risk on a stored card token using payer details, billing address, and device metadata. Returns a risk score. - [Universal Payment Gateway (UPG)](https://developers.pcibooking.net/use-tokens/universal-payment-gateway): Process payments through any supported PSP with a single API. PCI Booking's UPG handles card data and gateway routing. - [Charge](https://developers.pcibooking.net/use-tokens/charge): One-step charge via PCI Booking's Universal Payment Gateway. Tokenize once, charge any PSP without handling card data. - [Authorize & Capture](https://developers.pcibooking.net/use-tokens/authorize-capture): Pre-authorize a card token and capture later. Two-step payment flow via PCI Booking's Universal Payment Gateway. - [Refunds & Voids](https://developers.pcibooking.net/use-tokens/refunds-voids): Process refunds and void transactions on payments made through PCI Booking's Universal Payment Gateway. - [Fallback Payment Gateways](https://developers.pcibooking.net/use-tokens/fallback-gateways): Retry a declined charge automatically with other payment gateway accounts, in the order you choose. - [Gateway-Specific Guidance](https://developers.pcibooking.net/use-tokens/gateway-guidance): PSP-specific notes for processing payments through PCI Booking. Required fields, quirks, and configuration for each gateway. - [Token Replacement in Request](https://developers.pcibooking.net/use-tokens/token-replacement-in-request): Send an HTTP request through PCI Booking and have real card data inserted before it is forwarded to the destination. - [Token Replacement Placeholders](https://developers.pcibooking.net/use-tokens/token-replacement-placeholders): The placeholders PCI Booking replaces with card data in Token Replacement in Request, and how to use them in JSON, XML, form data and plain text. - [Token Replacement in Response](https://developers.pcibooking.net/use-tokens/token-replacement-in-response): Your API responds with tokens and PCI Booking inserts the real card data before the response reaches the third party that called you. - [File Transfer Token Replacement](https://developers.pcibooking.net/use-tokens/file-transfer-token-replacement): Replace tokens with card data in SFTP/FTPS file transfers. PCI Booking acts as secure proxy for batch file processing. - [Token Replacement (API)](https://developers.pcibooking.net/use-tokens/token-replacement-api): Retrieve full card details for a token directly via API. Returns raw card data to your system, with PCI DSS scope implications. - [Card Display](https://developers.pcibooking.net/use-tokens/card-display): Display stored card details to authorized users via a secure hosted form. Hotels can view guest card data without PCI scope. - [Card Display with OTP](https://developers.pcibooking.net/use-tokens/card-display-otp): Send a one-time password link to view stored card details. Secure card display for hotel staff and partners. ## Guides - Account Configuration - [Manage Users and API Keys](https://developers.pcibooking.net/account-setup/manage-users): Create users, set roles, generate API keys, and manage access control for your PCI Booking account. - [PSP Credentials](https://developers.pcibooking.net/account-setup/gateway-credentials): Store payment gateway credentials in PCI Booking to process payments via the Universal Payment Gateway. - [Payments Library Credentials](https://developers.pcibooking.net/account-setup/payments-library-credentials): Store payment method credentials (Apple Pay, Google Pay, PayPal, BankPay, UPI) for use with PCI Booking's Payments Library. - [Apple Pay Setup](https://developers.pcibooking.net/account-setup/applepay-setup): Configure Apple Pay with PCI Booking. Certificate generation, merchant ID registration, and domain verification. - [Google Pay Setup](https://developers.pcibooking.net/account-setup/googlepay-setup): Configure Google Pay with PCI Booking. Merchant ID setup and integration options. - [PayPal Setup](https://developers.pcibooking.net/account-setup/paypal-setup): Configure PayPal payments in PCI Booking. API credentials, webhook setup, and testing. - [BankPay Setup](https://developers.pcibooking.net/account-setup/bankpay-setup): Configure BankPay (open banking) payments in PCI Booking. Account setup and testing. - [UPI Setup](https://developers.pcibooking.net/account-setup/upi-setup): Configure UPI payments in PCI Booking for Indian payment processing. - [Security Settings](https://developers.pcibooking.net/account-setup/security-settings): Configure IP restrictions, callback URL whitelisting, and card display permissions in your PCI Booking account - [3DS Merchant Setup](https://developers.pcibooking.net/account-setup/3ds-merchant-setup): Which merchant details PCI Booking uses for 3D Secure, and how to provide your own. - [Client Certificates](https://developers.pcibooking.net/account-setup/client-certificates): Upload client certificates for mutual TLS authentication when PCI Booking connects to your payment gateway. - [Booker Settings](https://developers.pcibooking.net/account-setup/booker-settings): Account-level settings in the PCI Booking portal: brand name, logo, contact and billing information - [Custom Translations](https://developers.pcibooking.net/account-setup/custom-translations): Translate PCI Booking hosted card forms into any language. Override default labels, placeholders, and error messages. - [General Customization](https://developers.pcibooking.net/account-setup/general-customization): Configure shared branding for all PCI Booking emails: logo, support contacts, sender address, button colors, signature and footer. - [Email Templates](https://developers.pcibooking.net/account-setup/email-templates): Customize every email PCI Booking sends on your behalf: card requests, user invitations, password resets, suspension notices and more. - [Card By Link Templates](https://developers.pcibooking.net/account-setup/card-by-link-templates): Customize email and SMS templates for Card by Link requests. Branding, language, and content configuration. - [White Label Email Domain](https://developers.pcibooking.net/account-setup/white-label-email): Send Card by Link emails from your own domain. DKIM and SPF configuration for branded email delivery. - [Stylesheets](https://developers.pcibooking.net/account-setup/stylesheets): Customize the look and feel of PCI Booking's hosted card forms and card display pages with your own CSS - [Success and Failure URLs](https://developers.pcibooking.net/account-setup/success-and-failure-urls): Configure redirect URLs for hosted card entry form completion and error scenarios. - [Target Profiles](https://developers.pcibooking.net/account-setup/target-profiles): Configure target profiles with content filters to define how PCI Booking tokenizes and detokenizes card data in API requests and responses - [Content Filters](https://developers.pcibooking.net/account-setup/content-filters): Define XML, JSON, form-encoded, and query string content filters that tell PCI Booking where card data fields are in your messages ## Guides - Additional Functions - [Network Tokenization](https://developers.pcibooking.net/additional-functions/network-tokenization): Replace stored card numbers with network-issued tokens from Mastercard and American Express, kept up to date by PCI Booking. - [Data Blocks](https://developers.pcibooking.net/additional-functions/data-blocks): Store, retrieve, and manage arbitrary data securely using PCI Booking's Data Block service. - [Contact Verification](https://developers.pcibooking.net/additional-functions/contact-verification): Verify that a contact's email and phone number are valid and reachable using OTP. ## Guides - Reference - [API Conventions](https://developers.pcibooking.net/reference/api-conventions): Base URL, content types, authentication headers, error format, and pagination for PCI Booking's REST API. - [Supported Card Types](https://developers.pcibooking.net/reference/card-types): Complete list of card types PCI Booking identifies and tokenizes: Visa, Mastercard, Amex, JCB, Diners, and more. - [Card Validation Errors](https://developers.pcibooking.net/reference/card-validation-errors): Error codes returned when card entry validation fails. Invalid number, expiration, CVV, and Luhn check failures. - [Card Data XML Structure](https://developers.pcibooking.net/reference/card-data-xml-structure): XML schema for card data elements used in token replacement and card display requests. Field definitions and examples. - [File Transfer Formats](https://developers.pcibooking.net/reference/file-transfer-formats): The filter values for SFTP/FTPS tokenization and token replacement, and the file format each one handles. - [Gateway Request Headers](https://developers.pcibooking.net/reference/gateway-request-headers): HTTP headers PCI Booking adds to proxied gateway requests. Trace IDs, original IP forwarding, and custom headers. - [Versioning and Rate Limits](https://developers.pcibooking.net/reference/versioning-and-rate-limits): PCI Booking API versioning policy and rate limits. The API is unversioned and backwards compatible; rate limits apply per account. - [Outbound IP Addresses](https://developers.pcibooking.net/reference/outbound-ips): PCI Booking's outbound IP addresses, for whitelisting with third parties (PSPs, channel managers, hotel PMSs). - [Error Handling](https://developers.pcibooking.net/reference/error-handling): Every PCI Booking error condition with its exact response text, why it happens, and how to resolve it. Grouped by the part of the API that raises it. - [Return Codes](https://developers.pcibooking.net/reference/return-codes): HTTP status codes and PCI Booking-specific error codes. Lookup table for API response troubleshooting. - [Changelog](https://developers.pcibooking.net/reference/changelog): Recent changes, new features, and bug fixes in the PCI Booking API and related services. - [Glossary](https://developers.pcibooking.net/reference/glossary): Definitions of key terms: tokenization, detokenization, PCI DSS, CVV retention, 3D Secure, card-on-file, and more. ## Guides - Support - [Troubleshooting](https://developers.pcibooking.net/reference/troubleshooting): Diagnose and resolve common integration issues with PCI Booking. - [System Status](https://developers.pcibooking.net/support/system-status): Real-time operational status of PCI Booking's tokenization and payment processing services. ## Use Cases - Start Here - [PCI Booking Use Cases & Integration Guides](https://developers.pcibooking.net/use-cases/how-do-i): Step-by-step guides for common PCI Booking workflows: capture and charge cards, share tokens between merchants, send card details to hotels, and more. ## Use Cases - Complete Examples - [Complete Example: Checkout Page with 3D Secure](https://developers.pcibooking.net/use-cases/example-checkout-page-3ds): A complete checkout page and server: capture the card in the hosted card entry form, authenticate it with 3D Secure, and charge it through the Universal Payment Gateway. ## Use Cases - Card Capture Workflows - [Collect a Card and Process a Payment](https://developers.pcibooking.net/use-cases/capture-and-charge): Securely collect card details from a cardholder and charge through any connected payment gateway, without card data ever touching your servers. - [Charge a Card and Save It for Future Payments](https://developers.pcibooking.net/use-cases/capture-charge-and-store): Collect a guest's card, process the payment, and store a token for repeat charges in one PCI-compliant flow, with any PSP. - [Validate and Authenticate a Card](https://developers.pcibooking.net/use-cases/validate-a-card): The different ways to validate or authenticate a card in PCI Booking, and what each one actually confirms. - [Send a Guest's Card to a Hotel](https://developers.pcibooking.net/use-cases/capture-and-send-to-hotel): Get a guest's card as a token, then deliver it to each hotel in the way that hotel can receive it, without card data on your servers. ## Use Cases - Third-Party Workflows - [Process OTA and Channel Manager Card Payments](https://developers.pcibooking.net/use-cases/third-party-to-gateway): Receive card data from Booking.com, Expedia, or any channel manager, tokenize it automatically, and charge it without card data touching your servers. - [Share a Card Token Between Two Merchants](https://developers.pcibooking.net/use-cases/share-token-between-merchants): Let two merchants use the same card token without duplicating card data. Saves on tokenization and storage fees while keeping both parties PCI compliant. - [Charge Multiple Hotels' Gateways From One Account](https://developers.pcibooking.net/use-cases/multi-hotel-gateway-routing): A booking platform holds the tokens while each hotel keeps its own PSP and gets paid directly, routing PreAuth and Capture per hotel from one account. ## Use Cases - Compliance & Maintenance - [PSD2 and 3D Secure Implementation Guide](https://developers.pcibooking.net/use-cases/comply-with-psd2): Add 3D Secure (3DS2) authentication to your payment flow via hosted forms, third-party 3DS data, or in-transit tokenization, plus test cards per challenge type. - [Update an Expired Card Token](https://developers.pcibooking.net/use-cases/update-expired-card): When a stored card expires and the guest gets a replacement, update the token's expiration date and CVV without re-collecting the full card number. ## API Reference - Start Here - [API Reference Overview](https://developers.pcibooking.net/api-reference/overview): PCI Booking REST API reference. Base URL, authentication, response format, and a map of all available endpoints. ## API Reference - Authentication & General - [Authenticate API Key](https://developers.pcibooking.net/api-reference/general/authenticate): Verify that the PCI Booking service is available and your API key is valid. - [Start a Temporary Session](https://developers.pcibooking.net/api-reference/general/start-temporary-session): Start a new session for capturing a customer's payment card. - [Get Supported Credit Cards](https://developers.pcibooking.net/api-reference/general/get-supported-cards): Retrieve the list of supported credit card type codes. - [Add or update CSS](https://developers.pcibooking.net/api-reference/general/add-update-css): Create a new CSS record or update an existing one by replacing its content. - [List All CSS Records](https://developers.pcibooking.net/api-reference/general/list-css-records): Retrieve a list of all CSS records in your account. - [Retrieve CSS Record](https://developers.pcibooking.net/api-reference/general/retrieve-css-record): Retrieve the content of a particular CSS record stored in PCI Booking. - [Delete CSS Record](https://developers.pcibooking.net/api-reference/general/delete-css-record): Delete a CSS record from your PCI Booking account. ## API Reference - Capture Cards - [Capture Cards API Reference](https://developers.pcibooking.net/api-reference/tokenize-cards/overview): API endpoints for card tokenization: hosted forms, Card By Link, card migration, response interception, and sFTP file tokenization - [Request a Card Entry Form](https://developers.pcibooking.net/api-reference/tokenize-cards/request-card-entry-form): Build a URL that renders a PCI Booking card capture form. Use it as an iframe src or redirect the cardholder to it. - [Create Card Entry Form Session](https://developers.pcibooking.net/api-reference/tokenize-cards/create-card-entry-form-session): Create a card entry form session with parameters in the request body instead of URL query strings. Returns a Location header with the form URL. - [Retrieve Card Entry Session Details](https://developers.pcibooking.net/api-reference/tokenize-cards/retrieve-card-entry-session): Retrieve the parameters configured for a card form session. - [Delete Card Entry Form](https://developers.pcibooking.net/api-reference/tokenize-cards/delete-card-entry-form): Delete a card entry form session created via the API. - [Card Entry Form Webhook](https://developers.pcibooking.net/api-reference/tokenize-cards/card-entry-form-callback): PCI Booking sends a POST request to your callback URL each time the status of a card entry form session changes. - [Send Card Capture Link](https://developers.pcibooking.net/api-reference/tokenize-cards/cotp-send-card-form): Send a Card By Link request via email or SMS with a link to a secure card capture form. - [Send CVV Capture Link](https://developers.pcibooking.net/api-reference/tokenize-cards/cotp-send-cvv-form): Send a Card By Link request via email or SMS with a link to a secure CVV capture form. - [Retrieve Card By Link Request](https://developers.pcibooking.net/api-reference/tokenize-cards/cotp-retrieve-request): Retrieve the status and details of a Card By Link request. - [Card By Link Webhook](https://developers.pcibooking.net/api-reference/tokenize-cards/cotp-callback): PCI Booking sends a POST request to your callback URL when a Card By Link request reaches one of the statuses listed on this page. - [Delete Card By Link Request](https://developers.pcibooking.net/api-reference/tokenize-cards/cotp-delete-request): Delete a Card By Link request. Clicking a deleted request's link shows an 'invalid link' message. - [Tokenization in Response](https://developers.pcibooking.net/api-reference/tokenize-cards/tokenization-in-response): Route a request to a third party through PCI Booking, which intercepts the response, tokenizes card data, masks the details, and returns the sanitized response. - [Tokenize on Response Using Preset Profiles](https://developers.pcibooking.net/api-reference/tokenize-cards/tokenize-on-response-using-preset-profiles): Send a request to a third party through a pre-configured profile that tokenizes card data in the response and returns the sanitized result. - [Get Tokenization Profiles](https://developers.pcibooking.net/api-reference/tokenize-cards/get-tokenization-profiles): Returns a list of pre-configured tokenization profiles. Use the profile name when calling the Tokenize on Response Using Preset Profiles endpoint. - [Tokenize from sFTP](https://developers.pcibooking.net/api-reference/tokenize-cards/tokenize-from-sftp): Download a file from an sFTP server through PCI Booking. Card data is extracted, tokenized, and the sanitized file content is returned. - [Store Paycard (Card Migration)](https://developers.pcibooking.net/api-reference/tokenize-cards/store-paycard): Store card details in PCI Booking when migrating from local storage. The card data is sent in XML format. - [Request a Card Security Code Entry Form](https://developers.pcibooking.net/api-reference/manage-tokens/request-cvv-entry-form): Create a PCI Booking CVV capture form for use in an iFrame. - [List Virtual Card Providers](https://developers.pcibooking.net/api-reference/tokenize-cards/list-virtual-card-providers): Retrieve the list of supported virtual card providers and their credential requirements. - [Get Virtual Card Provider](https://developers.pcibooking.net/api-reference/tokenize-cards/get-virtual-card-provider): Retrieve details and credential requirements for a specific virtual card provider. - [Retrieve VCP Credential Structure](https://developers.pcibooking.net/api-reference/tokenize-cards/retrieve-vcp-credential-structure): Get the list of required credential fields for a specific virtual card provider. - [Issue Virtual Card](https://developers.pcibooking.net/api-reference/tokenize-cards/issue-virtual-card): Request a virtual card from a connected issuing provider and automatically tokenize it. ## API Reference - Manage Tokens - [Manage Tokens API Reference](https://developers.pcibooking.net/api-reference/manage-tokens/overview): API endpoints for token management: query, update, duplicate, delete tokens, CVV retention policies, and customer/property associations - [Query Tokens](https://developers.pcibooking.net/api-reference/manage-tokens/query-tokens): Search for tokens by creator reference. Returns metadata for up to 100 matching tokens, with pagination support. - [Retrieve Token Metadata](https://developers.pcibooking.net/api-reference/manage-tokens/retrieve-token-metadata): Returns non-sensitive metadata for a single token, including card type, masked card number, expiration, CVV status, 3DS data, and associations. - [Update Card Expiration Date](https://developers.pcibooking.net/api-reference/manage-tokens/update-expiration): Update the expiration date on a stored token. Only the expiration date is changed; all other card data remains unchanged. - [Update Creator Reference](https://developers.pcibooking.net/api-reference/manage-tokens/update-creator-reference): Set or update the creator reference value on an existing token. - [Delete Creator Reference](https://developers.pcibooking.net/api-reference/manage-tokens/delete-creator-reference): Remove the creator reference value from an existing token. - [Transfer Ownership](https://developers.pcibooking.net/api-reference/manage-tokens/transfer-ownership): Transfer ownership of a token to another PCI Booking customer. - [Duplicate Token](https://developers.pcibooking.net/api-reference/manage-tokens/duplicate-token): Create a copy of an existing token, optionally adding a CVV and specifying property association and creator reference. - [Delete Token](https://developers.pcibooking.net/api-reference/manage-tokens/delete-token): Permanently delete a token and its associated card data from PCI Booking. - [Clear CVV](https://developers.pcibooking.net/api-reference/manage-tokens/clear-cvv): Immediately delete the CVV stored on a token. - [Set CVV Retention Policy](https://developers.pcibooking.net/api-reference/manage-tokens/set-cvv-retention-policy): Define when and how the CVV on a token expires, and which destinations may consume it. - [Get CVV Retention Policy](https://developers.pcibooking.net/api-reference/manage-tokens/get-cvv-retention-policy): Retrieve the full CVV retention policy for a token, including per-destination usage counts. - [Get CVV Retention Policy for Specific Destination](https://developers.pcibooking.net/api-reference/manage-tokens/get-cvv-retention-policy-specific): Retrieve the CVV retention policy for a single destination, including its usage count. - [Delete CVV Retention Policy](https://developers.pcibooking.net/api-reference/manage-tokens/delete-cvv-retention-policy): Delete the entire CVV retention policy for a token, reverting to the system-wide default. - [Delete CVV Retention Policy by Destination Type](https://developers.pcibooking.net/api-reference/manage-tokens/delete-cvv-retention-policy-type): Remove all destinations of a specific type from the CVV retention policy. - [Delete CVV Retention Policy by Destination](https://developers.pcibooking.net/api-reference/manage-tokens/delete-cvv-retention-policy-type-data): Remove a single destination from the CVV retention policy. - [Store 3D Secure Data](https://developers.pcibooking.net/api-reference/manage-tokens/store-3d-token): Store 3D Secure authentication data on a token. - [Retrieve 3D Secure Data](https://developers.pcibooking.net/api-reference/manage-tokens/retrieve-3d-token): Retrieve the 3D Secure authentication data stored on a token. - [Delete 3D Secure Data](https://developers.pcibooking.net/api-reference/manage-tokens/delete-3d-token): Delete the 3D Secure authentication data stored on a token. This does not affect the token itself. - [Associate with Customer](https://developers.pcibooking.net/api-reference/manage-tokens/associate-with-customer): Associate a token with another PCI Booking customer, allowing them to perform actions on this token. - [Disassociate from Customer](https://developers.pcibooking.net/api-reference/manage-tokens/disassociate-from-customer): Remove a customer association from a token. The customer will no longer have access to perform actions on this token. - [List Customer Associations](https://developers.pcibooking.net/api-reference/manage-tokens/list-customer-associations): Retrieve a list of all PCI Booking customers associated with this token. ## API Reference - Use Tokens - [Use Tokens API Reference](https://developers.pcibooking.net/api-reference/process-cards/overview): API endpoints for processing cards: Universal Payment Gateway transactions, token replacement, card display, and FTPS/sFTP file transfer - [Token Replacement in Request API](https://developers.pcibooking.net/api-reference/process-cards/token-replacement): Replace card tokens with real card data and relay the request to a third-party API. - [Token Replacement to sFTP](https://developers.pcibooking.net/api-reference/process-cards/token-replacement-sftp): Replace card tokens in a document and upload the result to an sFTP server. - [Token Replacement to FTPS](https://developers.pcibooking.net/api-reference/process-cards/token-replacement-ftps): Replace card tokens in a document and upload the result to an FTPS server. - [Delete File from sFTP or FTPS](https://developers.pcibooking.net/api-reference/process-cards/delete-file-sftp): Delete a file on an sFTP or FTPS server through PCI Booking, for example a source file that contained card data. - [Process Transaction](https://developers.pcibooking.net/api-reference/process-cards/process-transaction): Process a payment gateway transaction using a stored card token. - [Additional Guidance for Specific Payment Gateways](https://developers.pcibooking.net/api-reference/process-cards/gateway-guidance): PSP-specific parameter requirements, quirks, and configuration notes for each payment gateway supported by PCI Booking. - [Request a Card Display Form](https://developers.pcibooking.net/api-reference/process-cards/request-card-display-form): Create a Card Display form for displaying stored credit card data within an e-commerce site. - [Initiate Card Display with OTP](https://developers.pcibooking.net/api-reference/process-cards/card-display-otp): Send a secure card viewing link with OTP verification to a cardholder. - [Retrieve Card Details](https://developers.pcibooking.net/api-reference/manage-tokens/retrieve-card-details): Retrieve the full, unmasked card details for a token. This endpoint returns raw card data, putting your system in PCI DSS scope. - [Risk Assessment API](https://developers.pcibooking.net/api-reference/manage-tokens/risk-assessment): Assess the risk level of a tokenized card by cross-referencing billing address, card issuer country, and client IP address. ## API Reference - Additional Functions - [Get Payment Gateways](https://developers.pcibooking.net/api-reference/process-cards/get-payment-gateways): Retrieve a list of supported payment gateways and their credential descriptions. - [Retrieve Payment Gateway Credential Structure](https://developers.pcibooking.net/api-reference/process-cards/retrieve-credential-structure): Retrieve the credential structure for a specific payment gateway. - [Store Payment Gateway Credentials](https://developers.pcibooking.net/api-reference/process-cards/store-credentials): Store credentials for a payment gateway. - [List Payment Gateway Credentials](https://developers.pcibooking.net/api-reference/process-cards/list-credentials): Retrieve a list of all stored payment gateway credentials. - [Delete Payment Gateway Credentials](https://developers.pcibooking.net/api-reference/process-cards/delete-credentials): Delete a stored set of payment gateway credentials. - [Create Data Block](https://developers.pcibooking.net/api-reference/additional/create-data-block): Create a new data block and receive its token ID. - [Get Data Block Details](https://developers.pcibooking.net/api-reference/additional/get-data-block-details): Retrieve the details and metadata of an existing data block. - [Update Data Block Details](https://developers.pcibooking.net/api-reference/additional/update-data-block-details): Update the details and metadata of an existing data block. - [Delete Data Block](https://developers.pcibooking.net/api-reference/additional/delete-data-block): Permanently delete a stored data block and its contents by ID. This cannot be undone. - [Search Data Blocks](https://developers.pcibooking.net/api-reference/additional/search-data-blocks): Search for data blocks by reference, with pagination support. - [Upload Data Block Content](https://developers.pcibooking.net/api-reference/additional/upload-data-block-content): Upload content to an existing data block (up to 50MB). - [Download Data Block Content](https://developers.pcibooking.net/api-reference/additional/download-data-block-content): Download the raw stored content (text, JSON, image, PDF, or other file) of a data block by its token ID. - [Create a Verification](https://developers.pcibooking.net/api-reference/additional/create-verification): Initiate a new contact details verification via email and OTP. - [Get Verification Status](https://developers.pcibooking.net/api-reference/additional/get-verification-status): Check the current status of a contact verification request. - [Get Verification Results](https://developers.pcibooking.net/api-reference/additional/get-verification-results): Retrieve the final outcome of a completed contact verification. - [Receive Result Notification](https://developers.pcibooking.net/api-reference/additional/receive-result-notification): Callback payload sent by PCI Booking when a contact verification session completes. - [Network Tokenize a Card](https://developers.pcibooking.net/api-reference/additional/network-tokenize-card): Create a network token (Mastercard or American Express) from raw card data and store it as a PCI Booking token. - [Network Tokenize from Existing Token](https://developers.pcibooking.net/api-reference/additional/network-tokenize-from-token): Create a network token from an existing PCI Booking card token. - [Delete Network Token](https://developers.pcibooking.net/api-reference/additional/delete-network-token): Delete a network token from both the card network and PCI Booking storage. ## API Reference - Payments Library - [Create Payments Library Session](https://developers.pcibooking.net/api-reference/payments-library/create-session): Create a new Payments Library session for tokenization or charge operations using digital wallets. - [Validate Operation Result](https://developers.pcibooking.net/api-reference/payments-library/validate-operation): Validate the data returned to the client after a Payments Library operation to ensure it was not altered. - [Retrieve Digital Wallet Credential Structure](https://developers.pcibooking.net/api-reference/payments-library-accounts/retrieve-credential-structure): Retrieve the list of supported digital wallets and the required credential format for each. - [Store Digital Wallet Credentials](https://developers.pcibooking.net/api-reference/payments-library-accounts/store-credentials): Store credentials for a digital wallet payment method. - [List Digital Wallet Credentials](https://developers.pcibooking.net/api-reference/payments-library-accounts/list-credentials): Retrieve a list of all stored digital wallet credential IDs. - [Delete Digital Wallet Credentials](https://developers.pcibooking.net/api-reference/payments-library-accounts/delete-credentials): Delete stored digital wallet credentials by their ID. ## Support - [Contact Support](https://pcibooking.net/contact): Get help from the PCI Booking team