{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","admonition","br","details","img"]},"type":"markdown"},"seo":{"title":"Receive status packets","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":"receive-status-packets","__idx":0},"children":["Receive status packets"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Receive details about customer interactions on your POS device, in real-time."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This feature is available for S1F2, S1F4 Pro, and S1P2 devices."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By activating the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Return status packets"]}," feature, you can receive details about customer interactions that take place on the device. This means you can find out exactly where the customer is on the payment journey and can assist with any issues, without having to look at the POS device."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once configured, you'll receive status updates to your chosen webhook URL in the following format:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"statusUpdate\": {\n    \"deviceIsDisplaying\": \"PinOk\",\n    \"customerInteraction\": \"None\",\n    \"merchantTransactionId\": \"POS_001\",\n    \"eventId\": \"41b43c87-59c0-4b2e-9e10-09f939a5860c\"\n  }\n}\n","lang":"json"},"children":[]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$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":["statusUpdate"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the status update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusUpdate.deviceIsDisplaying"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (enum)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The screen displayed on the device.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AppSelection"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AuthorisingTransaction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardRemovedTimeout"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ChooseDcc"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnterCardInfo"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnterPin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GratuitySelection"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertOrTapCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertTapOrSwipeCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LastEnterPin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentCompleted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentDeclined"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PinEntryFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PinOk"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PosError"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProcessingTransaction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RemoveCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReSwipeCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RetryEnterPin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SwipeCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SwipeOrTapCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionCancelledByShopper"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusUpdate.customerInteraction"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (enum)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The interaction that the customer had with the device.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardInserted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardTapped"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardSwiped"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardRemoved"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardSwipedFail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardInsertedFail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AppSelected"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MultipleCardsTapped"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CancelPressed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardPresentedFail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardInsertedSwipedFail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnteringCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnteringExpiryDate"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnteringCvc"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnteringPin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GratuityEntered"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GratuityIgnored"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LanguageSelected"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusUpdate.merchantTransactionId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique identifier for this transaction, as assigned by you."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusUpdate.eventId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (UUID)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique identifier associated with this event."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"device-display-statuses","__idx":2},"children":["Device display statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes the possible device display statuses."]},{"$$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":{"width":"30%","data-label":"Display status"},"children":["Display status "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Displayed..."},"children":["Displayed..."]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Screenshot"},"children":["Screenshot"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AppSelection"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When using a card supporting multiple applications on one device."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/appselection.9cf3d80dadc83d4bacb85f54308870e546c288e4b07ba70947fcc34ff48672b2.552631fd.png","alt":"AppSelection.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AuthorisingTransaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the transaction is being authorised."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/pos-authorising.883ebdd1922dd16bd8d67c52b798f0da42da43e6282be0241c05e52ae97a4d22.552631fd.svg","alt":"","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardRemovedTimeout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the card hasn't been removed, but has already timed out."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A. This a result from the device with no specific display screen."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ChooseDcc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When allowing the customer to select a currency."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/choosedcc.0d4312bf3bf5f4d3686f5e39d8fc742b190852cf5ca47ccfd59286f3b5c86e3e.552631fd.png","alt":"ChooseDcc.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnterCardInfo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When manual card entry is required."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/entercardinfo.747249ce314d21898d5e869772733fd395e1ce0c157ff300849d95ceaf7c0361.552631fd.png","alt":"EnterCardInfo.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnterPin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the customer enters their PIN for the first time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/enterpin.2e00d7e3afe6bfa82e7fba656d3073f28cdaaaa3c54cf2dfd55f3838abc05951.552631fd.png","alt":"EnterPin.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GratuitySelection"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the customer is prompted to add a gratuity."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/gratuityselection.5a9d66938c05dc951152df56695fc01cabd1c768f315a9c6d1f5e83da68d1020.552631fd.png","alt":"GratuitySelection.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the customer inserts their card for the first time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/insertcard.f114fd851d3e46572f9fa25d8b7bd2470cf71dd5065a6c29fe54298d5428c3e0.552631fd.png","alt":"InsertCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertOrTapCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When transactions are initiated on a device configured only for insert and tap transactions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/insertortapcard.5617175b94f2f1c4ca4095d3a2a2888d32c1e73c4828e4eefa26252dbd29c92d.552631fd.png","alt":"InsertOrTapCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InsertTapOrSwipeCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When transactions are initiated on a device configured for insert, tap, or swipe transactions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/inserttaporswipecard.8cacbe2ccce7f04f4ea115a24171606f68351867a17851f38e56226c7f241d4c.552631fd.png","alt":"InsertTapOrSwipeCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LastEnterPin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After verifying the offline PIN failed for the second time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/retryenterpin.0fb5c3d3dd6a1c3d8afa0d63828b02a17bfce8c0a259974413d8447fe2c27738.552631fd.png","alt":"RetryEnterPin.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentCompleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the payment is completed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/pos-payment-successful.76e09f7f59638897e28b810f22470ca26b8e072c626bd6952d527637d556feee.552631fd.svg","alt":"","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentDeclined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After a payment was declined."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/payment-declined.67d77820edd37cfc049c887d2433dbefe3767803c6acc526c76a9a1dbd17f886.552631fd.svg","alt":"","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PinEntryFailed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After verifying the online PIN failed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A. This a result from the device with no specific display screen."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PinOk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After verifying the offline PIN successfully."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A. This a result from the device with no specific display screen."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PosError"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When an exceptions occurs while using the POS device."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A. This a result from the device with no specific display screen."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProcessingTransaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the transaction is being processed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/processingtransaction.6c3bad5bad02e0b6063b94b8f633e6f84e86541afa89c46bd8f98e10d3610052.552631fd.png","alt":"ProcessingTransaction.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RemoveCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When prompting the customer to remove their card."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/removecard.247b471f8b5bf3f3525cca186e739e99e6f8a934ce5f2b7eb3cbc309142d5fca.552631fd.png","alt":"RemoveCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReSwipeCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After swiping the card failed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/reswipecard.5b1ab6c61b371d7b8591a41c70a492b26cf4700fefe9b160078cf7089039578b.552631fd.png","alt":"ReSwipeCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RetryEnterPin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After verifying the offline PIN failed for the first time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/retryenterpin.0fb5c3d3dd6a1c3d8afa0d63828b02a17bfce8c0a259974413d8447fe2c27738.552631fd.png","alt":"RetryEnterPin.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SwipeCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the customer swipes their card for the first time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/swipecard.ed4800e4b1ece2123dabf8fd679947fe89fac179a3cf7469c9deda39cd471963.552631fd.png","alt":"SwipeCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SwipeOrTapCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When transactions are initiated on a device configured only for swipe and tap transactions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/swipeortapcard.63140e78014214516ea896365467377d3bc10564d6eb0fa3f4fef29a94596bdb.552631fd.png","alt":"SwipeOrTapCard.png","framed":false,"withLightbox":true,"width":"260","height":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionCancelledByShopper"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the transaction is cancelled using the Cancel button."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A. This a result from the device with no specific display screen."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-a-status-packet-url","__idx":3},"children":["Add a status packet URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To add a status packet URL that updates will be sent to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://portal.pxp.io","target":"_blank"},"children":["Unity Portal"]},", go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant setup > Sites"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the site associated with the device."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Services"]}," tab, find the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Pos service"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["General settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Host URLs"]},", enter a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status Packet URL"]},".",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/pos-plus-status-packet-url.130017bfdb712c83f39d9b9019f93d9bc6239666b8fa6c32d2e89db253b96ed9.552631fd.png","alt":"Screenshot showing where to enter the status packet URL in the Unity Portal.","framed":false,"withLightbox":true,"className":"screenshot","width":"","height":""},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," in the top right."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your status packet URL is now configured and you're ready to activate the feature."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can override the status packet URL configured in the Unity Portal by including the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusCallbackUrl"]}," parameter in your API request when initiating a transaction or modification. This allows you to use different webhook URLs for specific transactions. For more information, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/point-of-sale-transaction"},"children":["API reference"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"activate-the-feature","__idx":4},"children":["Activate the feature"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To activate the feature for a specific device:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://portal.pxp.io","target":"_blank"},"children":["Unity Portal"]},", go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant setup > Sites"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the site associated with the device."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Services"]}," tab, find the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Pos service"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on the device that you want to activate the feature for."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Feature settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["General"]},", switch the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Return status packets"]}," toggle on.",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/pos-plus-activate-status-packets.9b274f718d9e4889a2822b81679a5f977acd938200cacb906c131ef6f64b8bd6.552631fd.png","alt":"Screenshot showing where to activate the status packet feature in the Unity Portal.","framed":false,"withLightbox":true,"className":"screenshot","width":"","height":""},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," in the top right."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The feature is now active for this device. You'll start receiving status updates to your configured status packet URL."]}]},"headings":[{"value":"Receive status packets","id":"receive-status-packets","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Device display statuses","id":"device-display-statuses","depth":3},{"value":"Add a status packet URL","id":"add-a-status-packet-url","depth":2},{"value":"Activate the feature","id":"activate-the-feature","depth":2}],"frontmatter":{"seo":{"title":"Receive status packets"}},"lastModified":"2026-09-09T16:14:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/point-of-sale/pos-plus/sdk/status-packets","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}