{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","img","coming-soon","admonition"]},"type":"markdown"},"seo":{"title":"How it works","description":"Transform your commerce with PXP's unified platform—seamless payments, real-time insights, and global growth in one powerful integration.","lang":"en-UK","siteUrl":"https://developer.pxp.io","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"how-it-works","__idx":0},"children":["How it works"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Learn about PXP's Links solution."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["PXP's Links service is a secure payment link generation mechanism designed to streamline payment collection for merchants across diverse business scenarios. By leveraging comprehensive configuration options, flexible link behaviours, and integrated fraud protection, it enables you to create customised payment experiences that match your specific business requirements and customer needs."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/links-payment-page.ac14e31ca4d0dffa89911de67e0319921dc6aed4eaaf83b80063cc6c9503840e.03403e65.svg","alt":"Example of a Links payment page","withLightbox":true,"className":"screenshot","width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether deployed for one-time transactions like invoices and orders, or for recurring scenarios like subscriptions and donations, Links empowers you to generate secure, branded payment experiences with real-time control over payment methods, customer data collection, and post-payment behaviours — helping increase conversion rates, reduce payment friction, and maintain consistent brand experiences across all customer touchpoints."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each payment link renders a branded, responsive payment page, with support for single-use or open-use configurations, and customisable expiration periods."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can create links either manually via the Unity Portal or automatically via our API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"link-types","__idx":2},"children":["Link types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can choose between two link types:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Single-use:"]}," The payment link automatically deactivates after the first successful payment. Ideal for one-time purchases, invoices, and specific orders."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open-use:"]}," The payment link accepts multiple payments and remains active until expiration or manual cancellation. Ideal for subscription sign-ups, recurring payments, and donations."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For both types, you can set the validity period to 24 hours, 48 hours, or a custom duration. Once that period is up, the payment link is automatically deactivated and can no longer be used."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"branding-and-appearance","__idx":3},"children":["Branding and appearance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment links are customisable at the site level in the Unity Portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For every site, you can choose:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A display name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A logo."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A background image."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A font."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Button styling (colour and shape)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These settings apply to all payment links created under each site, ensuring consistent branding across all customer interactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-payment-methods","__idx":4},"children":["Supported payment methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment links support the following payment methods:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Card (Visa, Mastercard, American Express, and Diners Club)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PayPal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Apple Pay ",{"$$mdtype":"Tag","name":"ComingSoon","attributes":{"noSpace":false},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Google Pay"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can control which payment methods are available to customers, allowing you to optimise for your target market, reduce processing costs, or meet specific business requirements."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"customer-data-collection","__idx":5},"children":["Customer data collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure which customer information fields are required during payment, to balance conversion optimisation with business data requirements."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All fields are optional by default. Only the fields you specify will be marked as required."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"available-fields","__idx":6},"children":["Available fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use case"},"children":["Use case"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order confirmations, marketing, customer support."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS notifications, delivery coordination."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Personalisation, shipping labels, identity verification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Shipping, billing verification, tax calculations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date of birth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Age verification, compliance requirements."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal tracking, loyalty programs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product specifications"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customisation options, configuration details."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"best-practices","__idx":7},"children":["Best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Minimise required fields"]}," to optimise conversion rates."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collect essential data"]}," needed for order fulfillment and customer service."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consider regional requirements"]}," (GDPR, age verification laws)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Balance fraud prevention"]}," with user experience."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"address-verification-system-avs","__idx":8},"children":["Address verification system (AVS)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure the Address Verification System for enhanced fraud protection. AVS verifies billing addresses against card issuer records, providing additional security for card-not-present transactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configuration-options","__idx":9},"children":["Configuration options"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer-provided address:"]}," The customer enters their address during payment (recommended for most cases)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant-provided address:"]}," Pre-fill known customer addresses for repeat purchases. This is available for single-use links only."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Skip AVS:"]}," No address verification for low-risk transactions or digital goods."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AVS helps reduce chargebacks and fraud by comparing billing addresses. Consider your risk tolerance when choosing AVS configuration, as stricter verification may reduce conversion but increases security."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"post-payment-configuration","__idx":10},"children":["Post-payment configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Define what happens after customers complete their payment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"confirmation-page","__idx":11},"children":["Confirmation page"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Display PXP's branded confirmation page with payment details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include custom messages for customer communication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Suitable when you want customers to see payment confirmation before leaving."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"redirect","__idx":12},"children":["Redirect"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Immediately redirect customers to your specified URL (must use HTTPS)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handle the post-payment flow on your website."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include custom messages during the redirect process."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ideal for seamless integration with your existing customer journey."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"intents","__idx":13},"children":["Intents"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you create a payment link, you have to provide an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["intent"]}," that describes the purpose of a transaction. Each intent dictates a specific transaction flow and affects how the transaction is handled by the system."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes the possible intents that you can set when you create a payment link"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Intent"},"children":["Intent"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Use cases"},"children":["Use cases"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Capture funds immediately after authorisation."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Standard e-commerce transactions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Digital goods"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorisation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reserve funds on the customer's payment method."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order processing workflows"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pre-orders"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EstimatedAuthorisation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reserve funds on the customer's payment method without charging it, based on an estimated amount."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Account verification"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment method validation"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states","__idx":14},"children":["States"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payment link is successfully created, its status is automatically set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Active"]},". As time goes on and actions are taken, the status is updated."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes the possible states that a payment link can go through."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"State"},"children":["State"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The link is available for payment. This is an initial state after link creation or successful link cloning."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The link has been deactivated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For single-use links: The customer has completed their payment and the payment has been processed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For open-use links: The link was used successfully for payment at least once and has now expired."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For single-use links: The link has passed its configured expiry length."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For open-use links: The link has passed its configured expiry length without being used."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The link is in an error state due to an invalid configuration or a system error."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"security-and-compliance","__idx":15},"children":["Security and compliance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Links includes multiple security layers to protect transactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fraud-protection","__idx":16},"children":["Fraud protection"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Address Verification System"]}," (AVS) for billing address validation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment method restrictions"]}," to limit fraud vectors."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTPS requirements"]}," for all redirect URLs and webhooks."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication-and-access","__idx":17},"children":["Authentication and access"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PXP-UST1"]}," protocol with HMAC-SHA256 signatures for API access."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Token-based credentials"]}," with configurable expiration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request correlation IDs"]}," for tracking and troubleshooting."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"compliance","__idx":18},"children":["Compliance"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PCI DSS compliance"]}," for card data handling"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GDPR considerations"]}," for customer data collection."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Regional compliance"]}," support for various markets."]}]}]},"headings":[{"value":"How it works","id":"how-it-works","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Link types","id":"link-types","depth":2},{"value":"Branding and appearance","id":"branding-and-appearance","depth":2},{"value":"Supported payment methods","id":"supported-payment-methods","depth":2},{"value":"Customer data collection","id":"customer-data-collection","depth":2},{"value":"Available fields","id":"available-fields","depth":3},{"value":"Best practices","id":"best-practices","depth":3},{"value":"Address verification system (AVS)","id":"address-verification-system-avs","depth":2},{"value":"Configuration options","id":"configuration-options","depth":3},{"value":"Post-payment configuration","id":"post-payment-configuration","depth":2},{"value":"Confirmation page","id":"confirmation-page","depth":3},{"value":"Redirect","id":"redirect","depth":3},{"value":"Intents","id":"intents","depth":2},{"value":"States","id":"states","depth":2},{"value":"Security and compliance","id":"security-and-compliance","depth":2},{"value":"Fraud protection","id":"fraud-protection","depth":3},{"value":"Authentication and access","id":"authentication-and-access","depth":3},{"value":"Compliance","id":"compliance","depth":3}],"frontmatter":{"seo":{"title":"How it works"}},"lastModified":"2026-03-12T13:21:09.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/checkout/links/how-it-works","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}