Store and Forward
Store transactions offline in case of connectivity issues.
About Store and Forward
Store and Forward is a mechanism used for handling transactions when your connection to the PXP Unity Gateway is disrupted. It securely stores transactions offline until communications are re-established with the Gateway.
There are two types:
- (Regular) Store and Forward: where it's used as a fallback method in case of temporary connectivity loss. For example, if the Wi-Fi stops working in a shop.
- Forced Store and Forward: where it's used for all transactions. For example, aboard a cruise liner that has poor satellite communications.
Enable Store and Forward
To enable Store and Forward:
- In the Unity Portal, go to Merchant setup > Sites.
- Select the site associated with the POS device you want to enable Store and Forward on.
- Click the Services tab.
- In the Pos service row, click Edit.
- Click Store & forward settings.
- Toggle the switch to ON
- Click Save to confirm.
Store and Forward is now enabled as an automatic fallback method for that device. You don't need to pass any additional parameters in your transaction request.
Enable Forced Store and Forward Coming soon
Before you can use this feature, you need to enable it at the device level in the Unity Portal.
To enable forced Store and Forward, add the following snippet to your transaction request.
{
"pointOfInteraction": {
"storeAndForwardType": "ForcedStoreAndForward"
}
}
Parameter | Description |
---|---|
pointOfInteraction object required | Details about the device and environment where a card present transaction takes place. It includes various attributes that help identify and describe the capabilities and configurations of the point-of-sale (POS) device. |
pointOfInteraction.storeAndForward object | Details about the Store and Forward settings for the transaction. |
pointOfInteraction.storeAndForwardType string (enum) | The mechanism used for handling transactions when your connection to the Unity Payment Gateway is disrupted. It securely stores transactions offline until communications are re-established with the Gateway. Possible values:
|
If your request is successful, you'll receive a 200
response that includes the transaction's updated state
. You'll also receive a Transaction (Card Authorised) webhook notification.
Updated 2 months ago