{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cards","card","iconYes","iconNo"]},"type":"markdown"},"seo":{"title":"Payment Links","description":"Shift4 Payment Platform REST API.","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":"payment-links","__idx":0},"children":["Payment Links"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment links let you collect payments quickly using a secure, shareable checkout page — without writing a single line of code. Create a fixed-amount link — accepted once or reused up to a set limit — or a customer-chosen amount link where the customer chooses how much to pay. Control availability with expiry and start dates, collect billing details or custom fields, and notify customers by email."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For simple, one-off needs, the Customer Hub gives you a no-code setup — a link you can share in seconds, with no engineering required. When you need to operate at scale, the API lets you automate link creation and management across high-volume, enterprise-grade workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use","__idx":1},"children":["When to use"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Quick payment collection for invoices or services","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One-time product purchase"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deposit, final balance, or payment adjustment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ticket, booking fee, or membership"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Take payment with assistance","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call center or manual payment processing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In-store assisted sale (customer completes payment on their phone)"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Collect variable amounts","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pay-what-you-want, fundraiser, or nonprofit checkout"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tips or gratuities collected after a service"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"capabilities-at-a-glance","__idx":2},"children":["Capabilities at a glance"]},{"$$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":"Capability"},"children":["Capability"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link types"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One-time payments, customer-chosen amounts, card verification — validate a card without charging"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Limits and expiry"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End date, start date, single- or multi-use links"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Data collection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Billing address, shipping address, custom fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notifications"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email notifications"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Branding configuration — applies globally to every payment link on the account"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"guides","__idx":3},"children":["Guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/get-started"},"children":["Get started"]}," quickstart gets you to a working link in minutes. The guides below cover each step in detail."]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Create a payment link","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/guides/create-link"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start here — get your first link ready to share in minutes."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Customise and configure","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/guides/customise-and-configure"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the return URL, choose payment methods, and brand the checkout page."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Share with customers","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/guides/share"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the link in front of your customers — by email or any channel you use."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Monitor and reconcile","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/guides/monitor-and-reconcile"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep an eye on which links are active and who has paid."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"choose-your-path-customer-hub-vs-api","__idx":4},"children":["Choose your path: Customer Hub vs API"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Customer Hub","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create and manage payment links through the Shift4 Customer Hub with no coding required. Ideal for manual workflows, one-off payments, and business users."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Best for:"]}," ","Merchants, operations teams, customer service"]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Programmatically create and manage payment links for automated workflows and integration with your systems. The right choice when links are generated on demand or at scale."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Best for:"]}," ","Developers, automated systems, high-volume scenarios"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"overview","__idx":5},"children":["Overview"]},{"$$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":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Customer Hub"},"children":["Customer Hub"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time to launch"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minutes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hours to days"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engineering effort"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Development required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Scale"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manual/low volume"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Automated/high volume"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"feature-availability","__idx":6},"children":["Feature availability"]},{"$$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":"Feature"},"children":["Feature"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Customer Hub"},"children":["Customer Hub"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One-time payments"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multi-use links"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer-chosen amounts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manual activation/deactivation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expiration date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Scheduled start date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Google Pay / Apple Pay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Saving cards for later"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Billing address collection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Shipping address collection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email notifications"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Redirect URL on success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Branding configuration ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(set up once in the Customer Hub; applies to all links)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Programmatic creation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconNo","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"IconYes","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":7},"children":["Next steps"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Get started","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/get-started"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Follow the quickstart to create your first payment link in minutes."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"How it works","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/how-it-works"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Understand link lifecycle, statuses, and key concepts."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Create & configure","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/guides/create-link"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set up amounts, expiry dates, and data collection."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API reference","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkcreate"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete endpoint and schema reference for programmatic management."]}]}]}]},"headings":[{"value":"Payment Links","id":"payment-links","depth":1},{"value":"When to use","id":"when-to-use","depth":2},{"value":"Capabilities at a glance","id":"capabilities-at-a-glance","depth":2},{"value":"Guides","id":"guides","depth":2},{"value":"Choose your path: Customer Hub vs API","id":"choose-your-path-customer-hub-vs-api","depth":2},{"value":"Overview","id":"overview","depth":3},{"value":"Feature availability","id":"feature-availability","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Payment Links","description":"Overview of Payment Links — create and manage shareable checkout pages without writing a single line of code.","navigation":{"nextButton":{"label":"Get started","link":"/guides/core-concepts/payment-links/get-started"}},"seo":{"title":"Payment Links"}},"lastModified":"2026-07-15T15:46:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/core-concepts/payment-links","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}