REST - Built-In User Messages

Whenever useful and possible, Connect will include messages in its responses intended and tailored for user feedback.

It's suggested that your EPoS shows these messages as received from Connect. This offloads to us the responsibility of accurately informing the user about the outcome of integration-related operations.

There are two ways in which user messages may be returned:

Endpoint Error Messages

These are returned by endpoints when the request cannot be processed (e.g. an invalid parameter or an unavailable terminal).

Format

Every message respects the following format:

{
    "userMessage":
        "This is a message to display to the user."
}

The outmost key is "userMessage" which contains a single string message.

Example - Requesting an unavailable terminal

{
    "userMessage":
        "{tid} is unavailable. Please try again in 10 seconds or check the PDQ screen and cabling or restart the PDQ. Contact support if the problem persists."
}

Transaction/Report Response User Messages

These are returned as part of the transaction/report objects when something has occurred during the processing of request that the user should be notified about. (e.g. signature has not been verified before the timeout or cashback is not allowed for a terminal).

Format

These follow the same format as endpoint error messages, except they are part of a transaction/report object.

{
    ...
    "amountBase": 100,
    "authCode": "ABC123",
    "userMessage":
        "This is a message to display to the user."
    ...
}

Example - Signature Verification Timeout

{
    "userMessage":
        "Signature check not actioned before timeout. When required, signatures must be verified within 80 seconds."
}