{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["pageIntro","img","cards","card"]},"type":"markdown"},"seo":{"title":"Customer Hub quickstart","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":"PageIntro","attributes":{"title":"Get started","active":"dashboard"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This quickstart walks through the happy path from both sides of the product: creating a link in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer Hub"]},", and creating one programmatically via the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API"]},". Pick the scenario that matches how you work."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"customer-hub-quickstart","__idx":0},"children":["Customer Hub quickstart"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No code needed. You'll create a link, copy its URL, and confirm a successful payment — all from the Customer Hub."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment Links"]}," in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://lh.shift4.com/internet-payments/payment-links/manage"},"children":["Customer Hub"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Add Link\" or select a preset"]}," and the \"Add Payment Link\" page will appear."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/get-started-add.158c33bdb47609a02ef8c0e51dadd63eb59a60dd7983d307eedf10763c3a7062.b6d48b54.png","alt":"Add Link button highlighted on Payment Links page","withLightbox":true,"width":720},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enter the name and amount."]}," These fields are required."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enter a description"]}," or omit the field by toggling the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Include Description"]}," switch. The description is visible to the customer during checkout."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/get-started-description.844c3fb307d95c7c60f0eaf38befed54b23bc94c996769f62a18952bf021d1c6.b6d48b54.png","alt":"Create Payment Link form with filled name, amount","withLightbox":true,"width":720},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save the link."]}," You will see it on the Payment Links list. The link becomes active immediately."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy the URL"]}," from the newly created row's Payment Link column."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/get-started-copy.0b0e27576f966c86ce0a0c35cbc1213c9b3b49fff215ecba6eaa61449ce46dc6.b6d48b54.png","alt":"Payment Links list with a new Payment Link entry","withLightbox":true,"width":720},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Share it"]}," with your customer via any channel — email, chat, anywhere you can paste a URL."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Confirm the payment"]}," once the customer pays. The link's detail view lists all charges."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/get-started-confirm-payment.f2250f22939b22647114cdd68721a463f7fab58f56a1499bc5aaea902cee4944.b6d48b54.png","alt":"Payment link detail view listing the charges for a completed payment","withLightbox":true,"width":720},"children":[]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If you need…"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need shipping/billing/custom fields → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/guides/create-link"},"children":["Create link"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need the link to expire, be scheduled, or be single-use/multi-use → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/guides/create-link"},"children":["Create link"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need to reconcile to an invoice/order → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/guides/monitor-and-reconcile"},"children":["Monitor and reconcile"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need email notifications → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/guides/share"},"children":["Share"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need to set the return URL, payment methods, or page appearance → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts/payment-links/guides/customise-and-configure"},"children":["Customise and configure"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":1},"children":["Next steps"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Lifecycle and statuses","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/how-it-works#lifecycle-and-statuses"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Understand the states a payment link moves through."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Link types","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/core-concepts/payment-links/how-it-works#link-types"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Compare fixed-amount and customer-chosen amount links."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Create 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":["Add expiry dates, address collection, and more configuration options."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Share","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":["Distribute your link and send email notifications to customers."]}]}]}]},"headings":[{"value":"Customer Hub quickstart","id":"customer-hub-quickstart","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Get started","description":"Create a payment link, share it, and confirm a payment — the happy path for Customer Hub.","navigation":{"nextButton":{"label":"Create link","link":"/guides/core-concepts/payment-links/guides/create-link"}},"seo":{"title":"Customer Hub quickstart"}},"lastModified":"2026-07-15T15:46:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/core-concepts/payment-links/get-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}